Documentation: fix links to tutorials and other new manual pages
With the conversion of HTML documentation to man pages tutorial.html -> gittutorial (7) tutorial-2.html -> gittutorial-2 (7) cvs-migration.html -> gitcvs-migration (7) diffcore.html -> gitdiffcore (7) repository-layout.html -> gitrepository-layout (5) hooks.html -> githooks (5) glossary.html -> gitglossary (7) core-tutorial.html -> gitcore-tutorial (7) and the automatic update of references to these pages, a little debris was left behind. We clear it away. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jonathan Nieder committed
Jun 30, 2008 at 17:01 UTC
6998e4db52c6d98670a2cd1e59a7708dc18e2c52
11 files changed
+38
-42
Documentation/diff-options.txt
+1
-1
@@ -241,4 +241,4 @@ endif::git-format-patch[]
241
Do not show any source or destination prefix.
242
243
For more detailed explanation on these common options, see also
244
-linkgit:gitdiffcore[7][diffcore documentation].
244
+linkgit:gitdiffcore[7].
Documentation/git-add.txt
+1
-1
@@ -107,7 +107,7 @@ Configuration
107
The optional configuration variable 'core.excludesfile' indicates a path to a
108
file containing patterns of file names to exclude from git-add, similar to
109
$GIT_DIR/info/exclude. Patterns in the exclude file are used in addition to
110
-those in info/exclude. See linkgit:gitrepository-layout[5][repository layout].
110
+those in info/exclude. See linkgit:gitrepository-layout[5].
111
112
113
EXAMPLES
Documentation/git-commit.txt
+2
-2
@@ -97,7 +97,7 @@ OPTIONS
97
-n::
98
--no-verify::
99
This option bypasses the pre-commit and commit-msg hooks.
100
- See also linkgit:githooks[5][hooks].
100
+ See also linkgit:githooks[5].
101
102
--allow-empty::
103
Usually recording a commit that has the exact same tree as its
@@ -316,7 +316,7 @@ order).
316
HOOKS
317
-----
318
This command can run `commit-msg`, `prepare-commit-msg`, `pre-commit`,
319
-and `post-commit` hooks. See linkgit:githooks[5][hooks] for more
319
+and `post-commit` hooks. See linkgit:githooks[5] for more
320
information.
321
322
Documentation/git-update-server-info.txt
+1
-1
@@ -31,7 +31,7 @@ OUTPUT
31
------
32
33
Currently the command updates the following files. Please see
34
-linkgit:gitrepository-layout[5][repository-layout] for description of
34
+linkgit:gitrepository-layout[5] for description of
35
what they are for:
36
37
* objects/info/packs
Documentation/git.txt
+10
-10
@@ -20,11 +20,11 @@ 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 linkgit:gittutorial[7][tutorial] to get started, then see
23
+See linkgit:gittutorial[7] 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 linkgit:gitcvs-migration[7][CVS migration]. See
27
-link:user-manual.html[Git User's Manual] for a more in-depth
26
+also want to read linkgit:gitcvs-migration[7]. See
27
+the link:user-manual.html[Git User's Manual] for a more in-depth
28
introduction.
29
30
The COMMAND is either a name of a Git command (see below) or an alias
@@ -182,13 +182,14 @@ See the references above to get started using git. The following is
182
probably more detail than necessary for a first-time user.
183
184
The link:user-manual.html#git-concepts[git concepts chapter of the
185
-user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial] both provide
185
+user-manual] and linkgit:gitcore-tutorial[7] both provide
186
introductions to the underlying git architecture.
187
188
See also the link:howto-index.html[howto] documents for some useful
189
examples.
190
191
-The internals are documented link:technical/api-index.html[here].
191
+The internals are documented in the
192
+link:technical/api-index.html[GIT API documentation].
193
194
GIT COMMANDS
195
------------
@@ -372,10 +373,9 @@ For a more complete list of ways to spell object names, see
373
File/Directory Structure
374
------------------------
375
375
-Please see the linkgit:gitrepository-layout[5][repository layout]
376
-document.
376
+Please see the linkgit:gitrepository-layout[5] document.
377
378
-Read linkgit:githooks[5][hooks] for more details about each hook.
378
+Read linkgit:githooks[5] for more details about each hook.
379
380
Higher level SCMs may provide and manage additional information in the
381
`$GIT_DIR`.
@@ -383,7 +383,7 @@ Higher level SCMs may provide and manage additional information in the
383
384
Terminology
385
-----------
386
-Please see the linkgit:gitglossary[7][glossary] document.
386
+Please see linkgit:gitglossary[7].
387
388
389
Environment Variables
@@ -527,7 +527,7 @@ Discussion[[Discussion]]
527
528
More detail on the following is available from the
529
link:user-manual.html#git-concepts[git concepts chapter of the
530
-user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial].
530
+user-manual] and linkgit:gitcore-tutorial[7].
531
532
A git project normally consists of a working directory with a ".git"
533
subdirectory at the top level. The .git directory contains, among other
Documentation/gitcore-tutorial.txt
+4
-5
@@ -16,8 +16,8 @@ This tutorial explains how to use the "core" git programs to set up and
16
work with a git repository.
17
18
If you just need to use git as a revision control system you may prefer
19
-to start with linkgit:gittutorial[7][a tutorial introduction to git] or
20
-link:user-manual.html[the git user manual].
19
+to start with "A Tutorial Introduction to GIT" (linkgit:gittutorial[7]) or
20
+link:user-manual.html[the GIT User Manual].
21
22
However, an understanding of these low-level tools can be helpful if
23
you want to understand git's internals.
@@ -108,8 +108,7 @@ references in these `refs` subdirectories when you actually start
108
populating your tree.
109
110
[NOTE]
111
-An advanced user may want to take a look at the
112
-linkgit:gitrepository-layout[5][repository layout] document
111
+An advanced user may want to take a look at linkgit:gitrepository-layout[5]
112
after finishing this tutorial.
113
114
You have now created your first git repository. Of course, since it's
@@ -1589,7 +1588,7 @@ suggested in the previous section may be new to you. You do not
1588
have to worry. git supports "shared public repository" style of
1589
cooperation you are probably more familiar with as well.
1590
1592
-See linkgit:gitcvs-migration[7][git for CVS users] for the details.
1591
+See linkgit:gitcvs-migration[7] for the details.
1592
1593
Bundling your work together
1594
---------------------------
Documentation/gitcvs-migration.txt
+6
-6
@@ -18,9 +18,9 @@ important than any other. However, you can emulate the CVS model by
18
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
22
-linkgit:gittutorial[7][tutorial introduction to git] and the
23
-linkgit:gitglossary[7][git glossary] should be sufficient.
21
+Some basic familiarity with git is required. Having gone through
22
+linkgit:gittutorial[7] and
23
+linkgit:gitglossary[7] should be sufficient.
24
25
Developing against a shared repository
26
--------------------------------------
@@ -81,8 +81,8 @@ Setting Up a Shared Repository
81
------------------------------
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
85
-linkgit:gittutorial[7][tutorial]), or imported from an already existing CVS
84
+possibly created from scratch or from a tarball (see
85
+linkgit:gittutorial[7]), 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"
@@ -148,7 +148,7 @@ Advanced Shared Repository Management
148
149
Git allows you to specify scripts called "hooks" to be run at certain
150
points. You can use these, for example, to send all commits to the shared
151
-repository to a mailing list. See linkgit:githooks[5][Hooks used by git].
151
+repository to a mailing list. See linkgit:githooks[5].
152
153
You can enforce finer grained permissions using update hooks. See
154
link:howto/update-hook-example.txt[Controlling access to branches using
Documentation/gitrepository-layout.txt
+1
-1
@@ -135,7 +135,7 @@ hooks::
135
commands. A handful of sample hooks are installed when
136
`git init` is run, but all of them are disabled by
137
default. To enable, they need to be made executable.
138
- Read linkgit:githooks[5][hooks] for more details about
138
+ Read linkgit:githooks[5] for more details about
139
each hook.
140
141
index::
Documentation/gittutorial-2.txt
+5
-7
@@ -12,8 +12,7 @@ git *
12
DESCRIPTION
13
-----------
14
15
-You should work through linkgit:gittutorial[7][A tutorial introduction to
16
-git] before reading this tutorial.
15
+You should work through linkgit:gittutorial[7] before reading this tutorial.
16
17
The goal of this tutorial is to introduce two fundamental pieces of
18
git's architecture--the object database and the index file--and to
@@ -390,7 +389,7 @@ in the index file is identical to the one in the working directory.
389
In addition to being the staging area for new commits, the index file
390
is also populated from the object database when checking out a
391
branch, and is used to hold the trees involved in a merge operation.
393
-See the linkgit:gitcore-tutorial[7][core tutorial] and the relevant man
392
+See linkgit:gitcore-tutorial[7] and the relevant man
393
pages for details.
394
395
What next?
@@ -399,20 +398,19 @@ What next?
398
At this point you should know everything necessary to read the man
399
pages for any of the git commands; one good place to start would be
400
with the commands mentioned in link:everyday.html[Everyday git]. You
402
-should be able to find any unknown jargon in the
403
-linkgit:gitglossary[7][Glossary].
401
+should be able to find any unknown jargon in linkgit:gitglossary[7].
402
403
The link:user-manual.html[Git User's Manual] provides a more
404
comprehensive introduction to git.
405
408
-The linkgit:gitcvs-migration[7][CVS migration] document explains how to
406
+linkgit:gitcvs-migration[7] explains how to
407
import a CVS repository into git, and shows how to use git in a
408
CVS-like way.
409
410
For some interesting examples of git use, see the
411
link:howto-index.html[howtos].
412
415
-For git developers, the linkgit:gitcore-tutorial[7][Core tutorial] goes
413
+For git developers, linkgit:gitcore-tutorial[7] goes
414
into detail on the lower-level git mechanisms involved in, for
415
example, creating a new commit.
416
Documentation/gittutorial.txt
+4
-4
@@ -392,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
395
-linkgit:gitcvs-migration[7][git for CVS users].
395
+linkgit:gitcvs-migration[7].
396
397
Exploring history
398
-----------------
@@ -571,9 +571,9 @@ is based:
571
used to create commits, check out working directories, and
572
hold the various trees involved in a merge.
573
574
-linkgit:gittutorial-2[7][Part two of this tutorial] explains the object
574
+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.
576
+need to make the most of git. You can find it at linkgit:gittutorial-2[7].
577
578
If you don't want to continue with that right away, a few other
579
digressions that may be interesting at this point are:
@@ -592,7 +592,7 @@ digressions that may be interesting at this point are:
592
593
* link:everyday.html[Everyday GIT with 20 Commands Or So]
594
595
- * linkgit:gitcvs-migration[7][git for CVS users].
595
+ * linkgit:gitcvs-migration[7]: Git for CVS users.
596
597
SEE ALSO
598
--------
Documentation/user-manual.txt
+3
-4
@@ -1879,8 +1879,7 @@ $ chmod a+x hooks/post-update
1879
-------------------------------------------------
1880
1881
(For an explanation of the last two lines, see
1882
-linkgit:git-update-server-info[1], and the documentation
1883
-linkgit:githooks[5][Hooks used by git].)
1882
+linkgit:git-update-server-info[1] and linkgit:githooks[5].)
1883
1884
Advertise the URL of proj.git. Anybody else should then be able to
1885
clone or pull from that URL, for example with a command line like:
@@ -1992,7 +1991,7 @@ the right to push to the same repository. In that case, the correct
1991
solution is to retry the push after first updating your work by either a
1992
pull or a fetch followed by a rebase; see the
1993
<<setting-up-a-shared-repository,next section>> and
1995
-linkgit:gitcvs-migration[7][git for CVS users] for more.
1994
+linkgit:gitcvs-migration[7] for more.
1995
1996
[[setting-up-a-shared-repository]]
1997
Setting up a shared repository
@@ -2001,7 +2000,7 @@ Setting up a shared repository
2000
Another way to collaborate is by using a model similar to that
2001
commonly used in CVS, where several developers with special rights
2002
all push to and pull from a single shared repository. See
2004
-linkgit:gitcvs-migration[7][git for CVS users] for instructions on how to
2003
+linkgit:gitcvs-migration[7] for instructions on how to
2004
set this up.
2005
2006
However, while there is nothing wrong with git's support for shared