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>
Philip Oakley committed
Oct 10, 2014 at 22:25 UTC
673151a9bb56ec97fab66746e3aecef78fddb9b8
12 files changed
+32
-21
Documentation/Makefile
+2
-1
@@ -27,6 +27,7 @@ MAN7_TXT += gitcore-tutorial.txt
27
MAN7_TXT += gitcredentials.txt
28
MAN7_TXT += gitcvs-migration.txt
29
MAN7_TXT += gitdiffcore.txt
30
+MAN7_TXT += giteveryday.txt
31
MAN7_TXT += gitglossary.txt
32
MAN7_TXT += gitnamespaces.txt
33
MAN7_TXT += gitrevisions.txt
@@ -38,11 +39,11 @@ MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
39
MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT))
40
MAN_HTML = $(patsubst %.txt,%.html,$(MAN_TXT))
41
42
+OBSOLETE_HTML += everyday.html
43
OBSOLETE_HTML += git-remote-helpers.html
44
DOC_HTML = $(MAN_HTML) $(OBSOLETE_HTML)
45
46
ARTICLES += howto-index
45
-ARTICLES += everyday
47
ARTICLES += git-tools
48
ARTICLES += git-bisect-lk2009
49
# with their own formatting rules.
Documentation/everyday.txto
new
+9
@@ -0,0 +1,9 @@
1
+Everyday Git With 20 Commands Or So
2
+===================================
3
+
4
+This document has been moved to linkgit:giteveryday[1].
5
+
6
+Please let the owners of the referring site know so that they can update the
7
+link you clicked to get here.
8
+
9
+Thanks.
Documentation/git-push.txt
+1
-1
@@ -33,7 +33,7 @@ When the command line does not specify what to push with `<refspec>...`
33
arguments or `--all`, `--mirror`, `--tags` options, the command finds
34
the default `<refspec>` by consulting `remote.*.push` configuration,
35
and if it is not found, honors `push.default` configuration to decide
36
-what to push (See linkgit:git-config[1] for the meaning of `push.default`).
36
+what to push (See gitlink:git-config[1] for the meaning of `push.default`).
37
38
39
OPTIONS[[OPTIONS]]
Documentation/git.txt
+2
-2
@@ -22,7 +22,7 @@ unusually rich command set that provides both high-level operations
22
and full access to internals.
23
24
See linkgit:gittutorial[7] to get started, then see
25
-link:everyday.html[Everyday Git] for a useful minimum set of
25
+linkgit:giteveryday[7] for a useful minimum set of
26
commands. The link:user-manual.html[Git User's Manual] has a more
27
in-depth introduction.
28
@@ -1097,7 +1097,7 @@ subscribed to the list to send a message there.
1097
SEE ALSO
1098
--------
1099
linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1100
-link:everyday.html[Everyday Git], linkgit:gitcvs-migration[7],
1100
+linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1101
linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
1102
linkgit:gitcli[7], link:user-manual.html[The Git User's Manual],
1103
linkgit:gitworkflows[7]
Documentation/gitcore-tutorial.txt
+1
-1
@@ -1667,7 +1667,7 @@ linkgit:gittutorial[7],
1667
linkgit:gittutorial-2[7],
1668
linkgit:gitcvs-migration[7],
1669
linkgit:git-help[1],
1670
-link:everyday.html[Everyday git],
1670
+linkgit:giteveryday[7],
1671
link:user-manual.html[The Git User's Manual]
1672
1673
GIT
Documentation/gitcvs-migration.txt
+1
-1
@@ -194,7 +194,7 @@ linkgit:gittutorial[7],
194
linkgit:gittutorial-2[7],
195
linkgit:gitcore-tutorial[7],
196
linkgit:gitglossary[7],
197
-link:everyday.html[Everyday Git],
197
+linkgit:giteveryday[7],
198
link:user-manual.html[The Git User's Manual]
199
200
GIT
Documentation/giteveryday.txt
renamed
+9
-9
@@ -381,15 +381,15 @@ $ cat /etc/xinetd.d/git-daemon
381
# description: The Git server offers access to Git repositories
382
service git
383
{
384
- disable = no
385
- type = UNLISTED
386
- port = 9418
387
- socket_type = stream
388
- wait = no
389
- user = nobody
390
- server = /usr/bin/git-daemon
391
- server_args = --inetd --export-all --base-path=/pub/scm
392
- log_on_failure += USERID
384
+ disable = no
385
+ type = UNLISTED
386
+ port = 9418
387
+ socket_type = stream
388
+ wait = no
389
+ user = nobody
390
+ server = /usr/bin/git-daemon
391
+ server_args = --inetd --export-all --base-path=/pub/scm
392
+ log_on_failure += USERID
393
}
394
------------
395
+
Documentation/gitglossary.txt
+1
-1
@@ -19,7 +19,7 @@ SEE ALSO
19
linkgit:gittutorial[7],
20
linkgit:gittutorial-2[7],
21
linkgit:gitcvs-migration[7],
22
-link:everyday.html[Everyday Git],
22
+linkgit:giteveryday[7],
23
link:user-manual.html[The Git User's Manual]
24
25
GIT
Documentation/gittutorial-2.txt
+2
-2
@@ -403,7 +403,7 @@ What next?
403
404
At this point you should know everything necessary to read the man
405
pages for any of the git commands; one good place to start would be
406
-with the commands mentioned in link:everyday.html[Everyday Git]. You
406
+with the commands mentioned in linkgit:giteveryday[7]. You
407
should be able to find any unknown jargon in linkgit:gitglossary[7].
408
409
The link:user-manual.html[Git User's Manual] provides a more
@@ -427,7 +427,7 @@ linkgit:gitcvs-migration[7],
427
linkgit:gitcore-tutorial[7],
428
linkgit:gitglossary[7],
429
linkgit:git-help[1],
430
-link:everyday.html[Everyday Git],
430
+linkgit:giteveryday[7],
431
link:user-manual.html[The Git User's Manual]
432
433
GIT
Documentation/gittutorial.txt
+2
-2
@@ -656,7 +656,7 @@ digressions that may be interesting at this point are:
656
* linkgit:gitworkflows[7]: Gives an overview of recommended
657
workflows.
658
659
- * link:everyday.html[Everyday Git with 20 Commands Or So]
659
+ * linkgit:giteveryday[7]: Everyday Git with 20 Commands Or So.
660
661
* linkgit:gitcvs-migration[7]: Git for CVS users.
662
@@ -668,7 +668,7 @@ linkgit:gitcore-tutorial[7],
668
linkgit:gitglossary[7],
669
linkgit:git-help[1],
670
linkgit:gitworkflows[7],
671
-link:everyday.html[Everyday Git],
671
+linkgit:giteveryday[7],
672
link:user-manual.html[The Git User's Manual]
673
674
GIT
README
+1
-1
@@ -27,7 +27,7 @@ Torvalds with help of a group of hackers around the net.
27
Please read the file INSTALL for installation instructions.
28
29
See Documentation/gittutorial.txt to get started, then see
30
-Documentation/everyday.txt for a useful minimum set of commands, and
30
+Documentation/giteveryday.txt for a useful minimum set of commands, and
31
Documentation/git-commandname.txt for documentation of each command.
32
If git has been correctly installed, then the tutorial can also be
33
read with "man gittutorial" or "git help tutorial", and the
builtin/help.c
+1
@@ -421,6 +421,7 @@ static struct {
421
const char *help;
422
} common_guides[] = {
423
{ "attributes", N_("Defining attributes per path") },
424
+ { "everyday", N_("Everyday Git With 20 Commands Or So") },
425
{ "glossary", N_("A Git glossary") },
426
{ "ignore", N_("Specifies intentionally untracked files to ignore") },
427
{ "modules", N_("Defining submodule properties") },