Documentation: convert "glossary" and "core-tutorial" to man pages
This patch renames the following documents and at the same time converts them to the man format: core-tutorial.txt -> gitcore-tutorial.txt glossary.txt -> gitglossary.txt But as the glossary is included in the user manual and as the new gitglossary man page cannot be included as a whole in the user manual, the actual glossary content is now in its own "glossary-content.txt" new file. And this file is included by both the user manual and the gitglossary man page. Other documents that reference the above ones are changed accordingly and sometimes improved a little too. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Christian Couder committed
May 29, 2008 at 19:21 UTC
497c83314c1a595ef26dd4ea452022b0848d3219
9 files changed
+75
-20
Documentation/Makefile
+2
-4
@@ -4,7 +4,7 @@ MAN1_TXT= \
4
gitk.txt
5
MAN5_TXT=gitattributes.txt gitignore.txt gitmodules.txt githooks.txt
6
MAN7_TXT=git.txt gitcli.txt gittutorial.txt gittutorial-2.txt \
7
- gitcvs-migration.txt
7
+ gitcvs-migration.txt gitcore-tutorial.txt gitglossary.txt
8
9
MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)
10
MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
@@ -12,13 +12,11 @@ MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
12
13
DOC_HTML=$(MAN_HTML)
14
15
-ARTICLES = core-tutorial
16
-ARTICLES += diffcore
15
+ARTICLES = diffcore
16
ARTICLES += howto-index
17
ARTICLES += repository-layout
18
ARTICLES += everyday
19
ARTICLES += git-tools
21
-ARTICLES += glossary
20
# with their own formatting rules.
21
SP_ARTICLES = howto/revert-branch-rebase howto/using-merge-subtree user-manual
22
API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
Documentation/git.txt
+10
-3
@@ -174,7 +174,7 @@ See the references above to get started using git. The following is
174
probably more detail than necessary for a first-time user.
175
176
The link:user-manual.html#git-concepts[git concepts chapter of the
177
-user-manual] and the link:core-tutorial.html[Core tutorial] both provide
177
+user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial] both provide
178
introductions to the underlying git architecture.
179
180
See also the link:howto-index.html[howto] documents for some useful
@@ -374,7 +374,7 @@ Higher level SCMs may provide and manage additional information in the
374
375
Terminology
376
-----------
377
-Please see the link:glossary.html[glossary] document.
377
+Please see the linkgit:gitglossary[7][glossary] document.
378
379
380
Environment Variables
@@ -518,7 +518,7 @@ Discussion[[Discussion]]
518
519
More detail on the following is available from the
520
link:user-manual.html#git-concepts[git concepts chapter of the
521
-user-manual] and the link:core-tutorial.html[Core tutorial].
521
+user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial].
522
523
A git project normally consists of a working directory with a ".git"
524
subdirectory at the top level. The .git directory contains, among other
@@ -579,6 +579,13 @@ The documentation for git suite was started by David Greaves
579
<david@dgreaves.com>, and later enhanced greatly by the
580
contributors on the git-list <git@vger.kernel.org>.
581
582
+SEE ALSO
583
+--------
584
+linkgit:gittutorial[7], linkgit:gittutorial-2[7],
585
+linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
586
+linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
587
+link:user-manual.html[The Git User's Manual]
588
+
589
GIT
590
---
591
Part of the linkgit:git[7] suite
Documentation/gitcore-tutorial.txt
renamed
+22
-4
@@ -1,8 +1,16 @@
1
-A git core tutorial for developers
2
-==================================
1
+gitcore-tutorial(7)
2
+===================
3
4
-Introduction
5
-------------
4
+NAME
5
+----
6
+gitcore-tutorial - A git core tutorial for developers
7
+
8
+SYNOPSIS
9
+--------
10
+git *
11
+
12
+DESCRIPTION
13
+-----------
14
15
This tutorial explains how to use the "core" git programs to set up and
16
work with a git repository.
@@ -1679,3 +1687,13 @@ merge two at a time, documenting how you resolved the conflicts,
1687
and the reason why you preferred changes made in one side over
1688
the other. Otherwise it would make the project history harder
1689
to follow, not easier.
1690
+
1691
+SEE ALSO
1692
+--------
1693
+linkgit:gittutorial[7], linkgit:gittutorial-2[7],
1694
+linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
1695
+link:user-manual.html[The Git User's Manual]
1696
+
1697
+GIT
1698
+---
1699
+Part of the linkgit:git[7] suite.
Documentation/gitcvs-migration.txt
+5
-2
@@ -20,7 +20,7 @@ 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
-link:glossary.html[git glossary] should be sufficient.
23
+linkgit:gitglossary[7][git glossary] should be sufficient.
24
25
Developing against a shared repository
26
--------------------------------------
@@ -184,7 +184,10 @@ repositories without the need for a central maintainer.
184
185
SEE ALSO
186
--------
187
-linkgit:gittutorial[7], linkgit:gittutorial-2[7],
187
+linkgit:gittutorial[7],
188
+linkgit:gittutorial-2[7],
189
+linkgit:gitcore-tutorial[7],
190
+linkgit:gitglossary[7],
191
link:everyday.html[Everyday Git],
192
link:user-manual.html[The Git User's Manual]
193
Documentation/gitglossary.txt
new
+25
@@ -0,0 +1,25 @@
1
+gitglossary(7)
2
+==============
3
+
4
+NAME
5
+----
6
+gitglossary - A GIT Glossary
7
+
8
+SYNOPSIS
9
+--------
10
+*
11
+
12
+DESCRIPTION
13
+-----------
14
+
15
+include::glossary-content.txt[]
16
+
17
+SEE ALSO
18
+--------
19
+linkgit:gittutorial[7], linkgit:gittutorial-2[7],
20
+linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
21
+link:user-manual.html[The Git User's Manual]
22
+
23
+GIT
24
+---
25
+Part of the linkgit:git[7] suite.
Documentation/gittutorial-2.txt
+5
-3
@@ -390,7 +390,7 @@ in the index file is identical to the one in the working directory.
390
In addition to being the staging area for new commits, the index file
391
is also populated from the object database when checking out a
392
branch, and is used to hold the trees involved in a merge operation.
393
-See the link:core-tutorial.html[core tutorial] and the relevant man
393
+See the linkgit:gitcore-tutorial[7][core tutorial] and the relevant man
394
pages for details.
395
396
What next?
@@ -400,7 +400,7 @@ At this point you should know everything necessary to read the man
400
pages for any of the git commands; one good place to start would be
401
with the commands mentioned in link:everyday.html[Everyday git]. You
402
should be able to find any unknown jargon in the
403
-link:glossary.html[Glossary].
403
+linkgit:gitglossary[7][Glossary].
404
405
The link:user-manual.html[Git User's Manual] provides a more
406
comprehensive introduction to git.
@@ -412,7 +412,7 @@ CVS-like way.
412
For some interesting examples of git use, see the
413
link:howto-index.html[howtos].
414
415
-For git developers, the link:core-tutorial.html[Core tutorial] goes
415
+For git developers, the linkgit:gitcore-tutorial[7][Core tutorial] goes
416
into detail on the lower-level git mechanisms involved in, for
417
example, creating a new commit.
418
@@ -420,6 +420,8 @@ SEE ALSO
420
--------
421
linkgit:gittutorial[7],
422
linkgit:gitcvs-migration[7],
423
+linkgit:gitcore-tutorial[7],
424
+linkgit:gitglossary[7],
425
link:everyday.html[Everyday git],
426
link:user-manual.html[The Git User's Manual]
427
Documentation/gittutorial.txt
+2
@@ -598,6 +598,8 @@ SEE ALSO
598
--------
599
linkgit:gittutorial-2[7],
600
linkgit:gitcvs-migration[7],
601
+linkgit:gitcore-tutorial[7],
602
+linkgit:gitglossary[7],
603
link:everyday.html[Everyday git],
604
link:user-manual.html[The Git User's Manual]
605
Documentation/glossary-content.txt
renamed
-3
@@ -1,6 +1,3 @@
1
-GIT Glossary
2
-============
3
-
1
[[def_alternate_object_database]]alternate object database::
2
Via the alternates mechanism, a <<def_repository,repository>>
3
can inherit part of its <<def_object_database,object database>>
Documentation/user-manual.txt
+4
-1
@@ -4252,7 +4252,10 @@ You see, Git is actually the best tool to find out about the source of Git
4252
itself!
4253
4254
[[glossary]]
4255
-include::glossary.txt[]
4255
+GIT Glossary
4256
+============
4257
+
4258
+include::glossary-content.txt[]
4259
4260
[[git-quick-start]]
4261
Appendix A: Git Quick Reference