doc: add 'everyday' to 'git help'

The "Everyday GIT With 20 Commands Or So" is not accessible via the
Git help system.  Move everyday.txt to giteveryday.txt so that "git
help everyday" works, and create a new placeholder file everyday.html
to refer people who follow existing URLs to the updated location.

giteveryday.txt now formats well with AsciiDoc as a man page and
refreshed content to a more command modern style.

Add 'everyday' to the help --guides list and update git(1) and 5
other links to giteveryday.

Signed-off-by: Philip Oakley <philipoakley@iee.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Philip Oakley 2014-10-10 22:25:37 +01:00 committed by Junio C Hamano
parent 5a568ea050
commit 673151a9bb
12 changed files with 32 additions and 21 deletions

View File

@ -27,6 +27,7 @@ MAN7_TXT += gitcore-tutorial.txt
MAN7_TXT += gitcredentials.txt MAN7_TXT += gitcredentials.txt
MAN7_TXT += gitcvs-migration.txt MAN7_TXT += gitcvs-migration.txt
MAN7_TXT += gitdiffcore.txt MAN7_TXT += gitdiffcore.txt
MAN7_TXT += giteveryday.txt
MAN7_TXT += gitglossary.txt MAN7_TXT += gitglossary.txt
MAN7_TXT += gitnamespaces.txt MAN7_TXT += gitnamespaces.txt
MAN7_TXT += gitrevisions.txt MAN7_TXT += gitrevisions.txt
@ -38,11 +39,11 @@ MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT)) MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT)) MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT))
OBSOLETE_HTML += everyday.html
OBSOLETE_HTML += git-remote-helpers.html OBSOLETE_HTML += git-remote-helpers.html
DOC_HTML = $(MAN_HTML) $(OBSOLETE_HTML) DOC_HTML = $(MAN_HTML) $(OBSOLETE_HTML)
ARTICLES += howto-index ARTICLES += howto-index
ARTICLES += everyday
ARTICLES += git-tools ARTICLES += git-tools
ARTICLES += git-bisect-lk2009 ARTICLES += git-bisect-lk2009
# with their own formatting rules. # with their own formatting rules.

View File

@ -0,0 +1,9 @@
Everyday Git With 20 Commands Or So
===================================
This document has been moved to linkgit:giteveryday[1].
Please let the owners of the referring site know so that they can update the
link you clicked to get here.
Thanks.

View File

@ -33,7 +33,7 @@ When the command line does not specify what to push with `<refspec>...`
arguments or `--all`, `--mirror`, `--tags` options, the command finds arguments or `--all`, `--mirror`, `--tags` options, the command finds
the default `<refspec>` by consulting `remote.*.push` configuration, the default `<refspec>` by consulting `remote.*.push` configuration,
and if it is not found, honors `push.default` configuration to decide and if it is not found, honors `push.default` configuration to decide
what to push (See linkgit:git-config[1] for the meaning of `push.default`). what to push (See gitlink:git-config[1] for the meaning of `push.default`).
OPTIONS[[OPTIONS]] OPTIONS[[OPTIONS]]

View File

@ -22,7 +22,7 @@ unusually rich command set that provides both high-level operations
and full access to internals. and full access to internals.
See linkgit:gittutorial[7] to get started, then see See linkgit:gittutorial[7] to get started, then see
link:everyday.html[Everyday Git] for a useful minimum set of linkgit:giteveryday[7] for a useful minimum set of
commands. The link:user-manual.html[Git User's Manual] has a more commands. The link:user-manual.html[Git User's Manual] has a more
in-depth introduction. in-depth introduction.
@ -1097,7 +1097,7 @@ subscribed to the list to send a message there.
SEE ALSO SEE ALSO
-------- --------
linkgit:gittutorial[7], linkgit:gittutorial-2[7], linkgit:gittutorial[7], linkgit:gittutorial-2[7],
link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7], linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
linkgit:gitglossary[7], linkgit:gitcore-tutorial[7], linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
linkgit:gitcli[7], link:user-manual.html[The Git User's Manual], linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
linkgit:gitworkflows[7] linkgit:gitworkflows[7]

View File

@ -1667,7 +1667,7 @@ linkgit:gittutorial[7],
linkgit:gittutorial-2[7], linkgit:gittutorial-2[7],
linkgit:gitcvs-migration[7], linkgit:gitcvs-migration[7],
linkgit:git-help[1], linkgit:git-help[1],
link:everyday.html[Everyday git], linkgit:giteveryday[7],
link:user-manual.html[The Git User's Manual] link:user-manual.html[The Git User's Manual]
GIT GIT

View File

@ -194,7 +194,7 @@ linkgit:gittutorial[7],
linkgit:gittutorial-2[7], linkgit:gittutorial-2[7],
linkgit:gitcore-tutorial[7], linkgit:gitcore-tutorial[7],
linkgit:gitglossary[7], linkgit:gitglossary[7],
link:everyday.html[Everyday Git], linkgit:giteveryday[7],
link:user-manual.html[The Git User's Manual] link:user-manual.html[The Git User's Manual]
GIT GIT

View File

@ -381,15 +381,15 @@ $ cat /etc/xinetd.d/git-daemon
# description: The Git server offers access to Git repositories # description: The Git server offers access to Git repositories
service git service git
{ {
disable = no disable = no
type = UNLISTED type = UNLISTED
port = 9418 port = 9418
socket_type = stream socket_type = stream
wait = no wait = no
user = nobody user = nobody
server = /usr/bin/git-daemon server = /usr/bin/git-daemon
server_args = --inetd --export-all --base-path=/pub/scm server_args = --inetd --export-all --base-path=/pub/scm
log_on_failure += USERID log_on_failure += USERID
} }
------------ ------------
+ +

View File

@ -19,7 +19,7 @@ SEE ALSO
linkgit:gittutorial[7], linkgit:gittutorial[7],
linkgit:gittutorial-2[7], linkgit:gittutorial-2[7],
linkgit:gitcvs-migration[7], linkgit:gitcvs-migration[7],
link:everyday.html[Everyday Git], linkgit:giteveryday[7],
link:user-manual.html[The Git User's Manual] link:user-manual.html[The Git User's Manual]
GIT GIT

View File

@ -403,7 +403,7 @@ What next?
At this point you should know everything necessary to read the man At this point you should know everything necessary to read the man
pages for any of the git commands; one good place to start would be pages for any of the git commands; one good place to start would be
with the commands mentioned in link:everyday.html[Everyday Git]. You with the commands mentioned in linkgit:giteveryday[7]. You
should be able to find any unknown jargon in linkgit:gitglossary[7]. should be able to find any unknown jargon in linkgit:gitglossary[7].
The link:user-manual.html[Git User's Manual] provides a more The link:user-manual.html[Git User's Manual] provides a more
@ -427,7 +427,7 @@ linkgit:gitcvs-migration[7],
linkgit:gitcore-tutorial[7], linkgit:gitcore-tutorial[7],
linkgit:gitglossary[7], linkgit:gitglossary[7],
linkgit:git-help[1], linkgit:git-help[1],
link:everyday.html[Everyday Git], linkgit:giteveryday[7],
link:user-manual.html[The Git User's Manual] link:user-manual.html[The Git User's Manual]
GIT GIT

View File

@ -656,7 +656,7 @@ digressions that may be interesting at this point are:
* linkgit:gitworkflows[7]: Gives an overview of recommended * linkgit:gitworkflows[7]: Gives an overview of recommended
workflows. workflows.
* link:everyday.html[Everyday Git with 20 Commands Or So] * linkgit:giteveryday[7]: Everyday Git with 20 Commands Or So.
* linkgit:gitcvs-migration[7]: Git for CVS users. * linkgit:gitcvs-migration[7]: Git for CVS users.
@ -668,7 +668,7 @@ linkgit:gitcore-tutorial[7],
linkgit:gitglossary[7], linkgit:gitglossary[7],
linkgit:git-help[1], linkgit:git-help[1],
linkgit:gitworkflows[7], linkgit:gitworkflows[7],
link:everyday.html[Everyday Git], linkgit:giteveryday[7],
link:user-manual.html[The Git User's Manual] link:user-manual.html[The Git User's Manual]
GIT GIT

2
README
View File

@ -27,7 +27,7 @@ Torvalds with help of a group of hackers around the net.
Please read the file INSTALL for installation instructions. Please read the file INSTALL for installation instructions.
See Documentation/gittutorial.txt to get started, then see See Documentation/gittutorial.txt to get started, then see
Documentation/everyday.txt for a useful minimum set of commands, and Documentation/giteveryday.txt for a useful minimum set of commands, and
Documentation/git-commandname.txt for documentation of each command. Documentation/git-commandname.txt for documentation of each command.
If git has been correctly installed, then the tutorial can also be If git has been correctly installed, then the tutorial can also be
read with "man gittutorial" or "git help tutorial", and the read with "man gittutorial" or "git help tutorial", and the

View File

@ -421,6 +421,7 @@ static struct {
const char *help; const char *help;
} common_guides[] = { } common_guides[] = {
{ "attributes", N_("Defining attributes per path") }, { "attributes", N_("Defining attributes per path") },
{ "everyday", N_("Everyday Git With 20 Commands Or So") },
{ "glossary", N_("A Git glossary") }, { "glossary", N_("A Git glossary") },
{ "ignore", N_("Specifies intentionally untracked files to ignore") }, { "ignore", N_("Specifies intentionally untracked files to ignore") },
{ "modules", N_("Defining submodule properties") }, { "modules", N_("Defining submodule properties") },