Documentation: convert tutorials to man pages
This patch renames the following documents and at the same time converts them to the man page format: cvs-migration.txt -> gitcvs-migration.txt tutorial.txt -> gittutorial.txt tutorial-2.txt -> gittutorial-2.txt These new man pages are put in section 7, and other documents that reference the above ones are change accordingly. [jc: with help from Nanako to clean things up] Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Christian Couder committed
May 24, 2008 at 20:56 UTC
b27a23e35d8e532e47661595bda642ef3a7375f1
7 files changed
+87
-24
Documentation/Makefile
+3
-5
@@ -3,7 +3,8 @@ MAN1_TXT= \
3
$(wildcard git-*.txt)) \
4
gitk.txt
5
MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt
6
-MAN7_TXT=git.txt gitcli.txt
6
+MAN7_TXT=git.txt gitcli.txt gittutorial.txt gittutorial-2.txt \
7
+ gitcvs-migration.txt
8
9
MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
10
MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
@@ -11,10 +12,7 @@ MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
12
13
DOC_HTML=$(MAN_HTML)
14
14
-ARTICLES = tutorial
15
-ARTICLES += tutorial-2
16
-ARTICLES += core-tutorial
17
-ARTICLES += cvs-migration
15
+ARTICLES = core-tutorial
16
ARTICLES += diffcore
17
ARTICLES += howto-index
18
ARTICLES += repository-layout
Documentation/core-tutorial.txt
+2
-2
@@ -8,7 +8,7 @@ This tutorial explains how to use the "core" git programs to set up and
8
work with a git repository.
9
10
If you just need to use git as a revision control system you may prefer
11
-to start with link:tutorial.html[a tutorial introduction to git] or
11
+to start with linkgit:gittutorial[7][a tutorial introduction to git] or
12
link:user-manual.html[the git user manual].
13
14
However, an understanding of these low-level tools can be helpful if
@@ -1581,7 +1581,7 @@ suggested in the previous section may be new to you. You do not
1581
have to worry. git supports "shared public repository" style of
1582
cooperation you are probably more familiar with as well.
1583
1584
-See link:cvs-migration.html[git for CVS users] for the details.
1584
+See linkgit:gitcvs-migration[7][git for CVS users] for the details.
1585
1586
Bundling your work together
1587
---------------------------
Documentation/git.txt
+2
-2
@@ -20,10 +20,10 @@ Git is a fast, scalable, distributed revision control system with an
20
unusually rich command set that provides both high-level operations
21
and full access to internals.
22
23
-See this link:tutorial.html[tutorial] to get started, then see
23
+See this linkgit:gittutorial[7][tutorial] to get started, then see
24
link:everyday.html[Everyday Git] for a useful minimum set of commands, and
25
"man git-commandname" for documentation of each command. CVS users may
26
-also want to read link:cvs-migration.html[CVS migration]. See
26
+also want to read linkgit:gitcvs-migration[7][CVS migration]. See
27
link:user-manual.html[Git User's Manual] for a more in-depth
28
introduction.
29
Documentation/gitcvs-migration.txt
renamed
+25
-4
@@ -1,5 +1,16 @@
1
-git for CVS users
2
-=================
1
+gitcvs-migration(7)
2
+===================
3
+
4
+NAME
5
+----
6
+gitcvs-migration - git for CVS users
7
+
8
+SYNOPSIS
9
+--------
10
+git cvsimport *
11
+
12
+DESCRIPTION
13
+-----------
14
15
Git differs from CVS in that every working tree contains a repository with
16
a full copy of the project history, and no repository is inherently more
@@ -8,7 +19,7 @@ designating a single shared repository which people can synchronize with;
19
this document explains how to do that.
20
21
Some basic familiarity with git is required. This
11
-link:tutorial.html[tutorial introduction to git] and the
22
+linkgit:gittutorial[7][tutorial introduction to git] and the
23
link:glossary.html[git glossary] should be sufficient.
24
25
Developing against a shared repository
@@ -71,7 +82,7 @@ Setting Up a Shared Repository
82
83
We assume you have already created a git repository for your project,
84
possibly created from scratch or from a tarball (see the
74
-link:tutorial.html[tutorial]), or imported from an already existing CVS
85
+linkgit:gittutorial[7][tutorial]), or imported from an already existing CVS
86
repository (see the next section).
87
88
Assume your existing repo is at /home/alice/myproject. Create a new "bare"
@@ -170,3 +181,13 @@ variants of this model.
181
182
With a small group, developers may just pull changes from each other's
183
repositories without the need for a central maintainer.
184
+
185
+SEE ALSO
186
+--------
187
+linkgit:gittutorial[7], linkgit:gittutorial-2[7],
188
+link:everyday.html[Everyday Git],
189
+link:user-manual.html[The Git User's Manual]
190
+
191
+GIT
192
+---
193
+Part of the linkgit:git[7] suite.
Documentation/gittutorial-2.txt
renamed
+26
-4
@@ -1,7 +1,18 @@
1
-A tutorial introduction to git: part two
2
-========================================
1
+gittutorial-2(7)
2
+================
3
4
-You should work through link:tutorial.html[A tutorial introduction to
4
+NAME
5
+----
6
+gittutorial-2 - A tutorial introduction to git: part two
7
+
8
+SYNOPSIS
9
+--------
10
+git *
11
+
12
+DESCRIPTION
13
+-----------
14
+
15
+You should work through linkgit:gittutorial[7][A tutorial introduction to
16
git] before reading this tutorial.
17
18
The goal of this tutorial is to introduce two fundamental pieces of
@@ -394,7 +405,7 @@ link:glossary.html[Glossary].
405
The link:user-manual.html[Git User's Manual] provides a more
406
comprehensive introduction to git.
407
397
-The link:cvs-migration.html[CVS migration] document explains how to
408
+The linkgit:gitcvs-migration[7][CVS migration] document explains how to
409
import a CVS repository into git, and shows how to use git in a
410
CVS-like way.
411
@@ -404,3 +415,14 @@ link:howto-index.html[howtos].
415
For git developers, the link:core-tutorial.html[Core tutorial] goes
416
into detail on the lower-level git mechanisms involved in, for
417
example, creating a new commit.
418
+
419
+SEE ALSO
420
+--------
421
+linkgit:gittutorial[7],
422
+linkgit:gitcvs-migration[7],
423
+link:everyday.html[Everyday git],
424
+link:user-manual.html[The Git User's Manual]
425
+
426
+GIT
427
+---
428
+Part of the linkgit:git[7] suite.
Documentation/gittutorial.txt
renamed
+27
-5
@@ -1,5 +1,16 @@
1
-A tutorial introduction to git (for version 1.5.1 or newer)
2
-===========================================================
1
+gittutorial(7)
2
+==============
3
+
4
+NAME
5
+----
6
+gittutorial - A tutorial introduction to git (for version 1.5.1 or newer)
7
+
8
+SYNOPSIS
9
+--------
10
+git *
11
+
12
+DESCRIPTION
13
+-----------
14
15
This tutorial explains how to import a new project into git, make
16
changes to it, and share changes with other developers.
@@ -381,7 +392,7 @@ see linkgit:git-pull[1] for details.
392
393
Git can also be used in a CVS-like mode, with a central repository
394
that various users push changes to; see linkgit:git-push[1] and
384
-link:cvs-migration.html[git for CVS users].
395
+linkgit:gitcvs-migration[7][git for CVS users].
396
397
Exploring history
398
-----------------
@@ -560,7 +571,7 @@ is based:
571
used to create commits, check out working directories, and
572
hold the various trees involved in a merge.
573
563
-link:tutorial-2.html[Part two of this tutorial] explains the object
574
+linkgit:gittutorial-2[7][Part two of this tutorial] explains the object
575
database, the index file, and a few other odds and ends that you'll
576
need to make the most of git.
577
@@ -581,4 +592,15 @@ digressions that may be interesting at this point are:
592
593
* link:everyday.html[Everyday GIT with 20 Commands Or So]
594
584
- * link:cvs-migration.html[git for CVS users].
595
+ * linkgit:gitcvs-migration[7][git for CVS users].
596
+
597
+SEE ALSO
598
+--------
599
+linkgit:gittutorial-2[7],
600
+linkgit:gitcvs-migration[7],
601
+link:everyday.html[Everyday git],
602
+link:user-manual.html[The Git User's Manual]
603
+
604
+GIT
605
+---
606
+Part of the linkgit:git[7] suite.
Documentation/user-manual.txt
+2
-2
@@ -1993,7 +1993,7 @@ the right to push to the same repository. In that case, the correct
1993
solution is to retry the push after first updating your work by either a
1994
pull or a fetch followed by a rebase; see the
1995
<<setting-up-a-shared-repository,next section>> and
1996
-link:cvs-migration.html[git for CVS users] for more.
1996
+linkgit:gitcvs-migration[7][git for CVS users] for more.
1997
1998
[[setting-up-a-shared-repository]]
1999
Setting up a shared repository
@@ -2002,7 +2002,7 @@ Setting up a shared repository
2002
Another way to collaborate is by using a model similar to that
2003
commonly used in CVS, where several developers with special rights
2004
all push to and pull from a single shared repository. See
2005
-link:cvs-migration.html[git for CVS users] for instructions on how to
2005
+linkgit:gitcvs-migration[7][git for CVS users] for instructions on how to
2006
set this up.
2007
2008
However, while there is nothing wrong with git's support for shared