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>
This commit is contained in:
Christian Couder 2008-05-24 20:56:44 +02:00 committed by Junio C Hamano
parent 0b0b8cd7c2
commit b27a23e35d
7 changed files with 87 additions and 24 deletions

View File

@ -3,7 +3,8 @@ MAN1_TXT= \
$(wildcard git-*.txt)) \ $(wildcard git-*.txt)) \
gitk.txt gitk.txt
MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt
MAN7_TXT=git.txt gitcli.txt MAN7_TXT=git.txt gitcli.txt gittutorial.txt gittutorial-2.txt \
gitcvs-migration.txt
MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT) MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT)) MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
@ -11,10 +12,7 @@ MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
DOC_HTML=$(MAN_HTML) DOC_HTML=$(MAN_HTML)
ARTICLES = tutorial ARTICLES = core-tutorial
ARTICLES += tutorial-2
ARTICLES += core-tutorial
ARTICLES += cvs-migration
ARTICLES += diffcore ARTICLES += diffcore
ARTICLES += howto-index ARTICLES += howto-index
ARTICLES += repository-layout ARTICLES += repository-layout

View File

@ -8,7 +8,7 @@ This tutorial explains how to use the "core" git programs to set up and
work with a git repository. work with a git repository.
If you just need to use git as a revision control system you may prefer If you just need to use git as a revision control system you may prefer
to start with link:tutorial.html[a tutorial introduction to git] or to start with linkgit:gittutorial[7][a tutorial introduction to git] or
link:user-manual.html[the git user manual]. link:user-manual.html[the git user manual].
However, an understanding of these low-level tools can be helpful if 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
have to worry. git supports "shared public repository" style of have to worry. git supports "shared public repository" style of
cooperation you are probably more familiar with as well. cooperation you are probably more familiar with as well.
See link:cvs-migration.html[git for CVS users] for the details. See linkgit:gitcvs-migration[7][git for CVS users] for the details.
Bundling your work together Bundling your work together
--------------------------- ---------------------------

View File

@ -20,10 +20,10 @@ Git is a fast, scalable, distributed revision control system with an
unusually rich command set that provides both high-level operations unusually rich command set that provides both high-level operations
and full access to internals. and full access to internals.
See this link:tutorial.html[tutorial] to get started, then see See this linkgit:gittutorial[7][tutorial] to get started, then see
link:everyday.html[Everyday Git] for a useful minimum set of commands, and link:everyday.html[Everyday Git] for a useful minimum set of commands, and
"man git-commandname" for documentation of each command. CVS users may "man git-commandname" for documentation of each command. CVS users may
also want to read link:cvs-migration.html[CVS migration]. See also want to read linkgit:gitcvs-migration[7][CVS migration]. See
link:user-manual.html[Git User's Manual] for a more in-depth link:user-manual.html[Git User's Manual] for a more in-depth
introduction. introduction.

View File

@ -1,5 +1,16 @@
git for CVS users gitcvs-migration(7)
================= ===================
NAME
----
gitcvs-migration - git for CVS users
SYNOPSIS
--------
git cvsimport *
DESCRIPTION
-----------
Git differs from CVS in that every working tree contains a repository with Git differs from CVS in that every working tree contains a repository with
a full copy of the project history, and no repository is inherently more 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;
this document explains how to do that. this document explains how to do that.
Some basic familiarity with git is required. This Some basic familiarity with git is required. This
link:tutorial.html[tutorial introduction to git] and the linkgit:gittutorial[7][tutorial introduction to git] and the
link:glossary.html[git glossary] should be sufficient. link:glossary.html[git glossary] should be sufficient.
Developing against a shared repository Developing against a shared repository
@ -71,7 +82,7 @@ Setting Up a Shared Repository
We assume you have already created a git repository for your project, We assume you have already created a git repository for your project,
possibly created from scratch or from a tarball (see the possibly created from scratch or from a tarball (see the
link:tutorial.html[tutorial]), or imported from an already existing CVS linkgit:gittutorial[7][tutorial]), or imported from an already existing CVS
repository (see the next section). repository (see the next section).
Assume your existing repo is at /home/alice/myproject. Create a new "bare" Assume your existing repo is at /home/alice/myproject. Create a new "bare"
@ -170,3 +181,13 @@ variants of this model.
With a small group, developers may just pull changes from each other's With a small group, developers may just pull changes from each other's
repositories without the need for a central maintainer. repositories without the need for a central maintainer.
SEE ALSO
--------
linkgit:gittutorial[7], linkgit:gittutorial-2[7],
link:everyday.html[Everyday Git],
link:user-manual.html[The Git User's Manual]
GIT
---
Part of the linkgit:git[7] suite.

View File

@ -1,7 +1,18 @@
A tutorial introduction to git: part two gittutorial-2(7)
======================================== ================
You should work through link:tutorial.html[A tutorial introduction to NAME
----
gittutorial-2 - A tutorial introduction to git: part two
SYNOPSIS
--------
git *
DESCRIPTION
-----------
You should work through linkgit:gittutorial[7][A tutorial introduction to
git] before reading this tutorial. git] before reading this tutorial.
The goal of this tutorial is to introduce two fundamental pieces of The goal of this tutorial is to introduce two fundamental pieces of
@ -394,7 +405,7 @@ link:glossary.html[Glossary].
The link:user-manual.html[Git User's Manual] provides a more The link:user-manual.html[Git User's Manual] provides a more
comprehensive introduction to git. comprehensive introduction to git.
The link:cvs-migration.html[CVS migration] document explains how to The linkgit:gitcvs-migration[7][CVS migration] document explains how to
import a CVS repository into git, and shows how to use git in a import a CVS repository into git, and shows how to use git in a
CVS-like way. CVS-like way.
@ -404,3 +415,14 @@ link:howto-index.html[howtos].
For git developers, the link:core-tutorial.html[Core tutorial] goes For git developers, the link:core-tutorial.html[Core tutorial] goes
into detail on the lower-level git mechanisms involved in, for into detail on the lower-level git mechanisms involved in, for
example, creating a new commit. example, creating a new commit.
SEE ALSO
--------
linkgit:gittutorial[7],
linkgit:gitcvs-migration[7],
link:everyday.html[Everyday git],
link:user-manual.html[The Git User's Manual]
GIT
---
Part of the linkgit:git[7] suite.

View File

@ -1,5 +1,16 @@
A tutorial introduction to git (for version 1.5.1 or newer) gittutorial(7)
=========================================================== ==============
NAME
----
gittutorial - A tutorial introduction to git (for version 1.5.1 or newer)
SYNOPSIS
--------
git *
DESCRIPTION
-----------
This tutorial explains how to import a new project into git, make This tutorial explains how to import a new project into git, make
changes to it, and share changes with other developers. changes to it, and share changes with other developers.
@ -381,7 +392,7 @@ see linkgit:git-pull[1] for details.
Git can also be used in a CVS-like mode, with a central repository Git can also be used in a CVS-like mode, with a central repository
that various users push changes to; see linkgit:git-push[1] and that various users push changes to; see linkgit:git-push[1] and
link:cvs-migration.html[git for CVS users]. linkgit:gitcvs-migration[7][git for CVS users].
Exploring history Exploring history
----------------- -----------------
@ -560,7 +571,7 @@ is based:
used to create commits, check out working directories, and used to create commits, check out working directories, and
hold the various trees involved in a merge. hold the various trees involved in a merge.
link:tutorial-2.html[Part two of this tutorial] explains the object linkgit:gittutorial-2[7][Part two of this tutorial] explains the object
database, the index file, and a few other odds and ends that you'll database, the index file, and a few other odds and ends that you'll
need to make the most of git. need to make the most of git.
@ -581,4 +592,15 @@ digressions that may be interesting at this point are:
* link:everyday.html[Everyday GIT with 20 Commands Or So] * link:everyday.html[Everyday GIT with 20 Commands Or So]
* link:cvs-migration.html[git for CVS users]. * linkgit:gitcvs-migration[7][git for CVS users].
SEE ALSO
--------
linkgit:gittutorial-2[7],
linkgit:gitcvs-migration[7],
link:everyday.html[Everyday git],
link:user-manual.html[The Git User's Manual]
GIT
---
Part of the linkgit:git[7] suite.

View File

@ -1993,7 +1993,7 @@ the right to push to the same repository. In that case, the correct
solution is to retry the push after first updating your work by either a solution is to retry the push after first updating your work by either a
pull or a fetch followed by a rebase; see the pull or a fetch followed by a rebase; see the
<<setting-up-a-shared-repository,next section>> and <<setting-up-a-shared-repository,next section>> and
link:cvs-migration.html[git for CVS users] for more. linkgit:gitcvs-migration[7][git for CVS users] for more.
[[setting-up-a-shared-repository]] [[setting-up-a-shared-repository]]
Setting up a shared repository Setting up a shared repository
@ -2002,7 +2002,7 @@ Setting up a shared repository
Another way to collaborate is by using a model similar to that Another way to collaborate is by using a model similar to that
commonly used in CVS, where several developers with special rights commonly used in CVS, where several developers with special rights
all push to and pull from a single shared repository. See all push to and pull from a single shared repository. See
link:cvs-migration.html[git for CVS users] for instructions on how to linkgit:gitcvs-migration[7][git for CVS users] for instructions on how to
set this up. set this up.
However, while there is nothing wrong with git's support for shared However, while there is nothing wrong with git's support for shared