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>
This commit is contained in:

committed by
Junio C Hamano

parent
58c8dd2173
commit
497c83314c
@ -4,7 +4,7 @@ MAN1_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 gittutorial.txt gittutorial-2.txt \
|
MAN7_TXT=git.txt gitcli.txt gittutorial.txt gittutorial-2.txt \
|
||||||
gitcvs-migration.txt
|
gitcvs-migration.txt gitcore-tutorial.txt gitglossary.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))
|
||||||
@ -12,13 +12,11 @@ MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
|
|||||||
|
|
||||||
DOC_HTML=$(MAN_HTML)
|
DOC_HTML=$(MAN_HTML)
|
||||||
|
|
||||||
ARTICLES = core-tutorial
|
ARTICLES = diffcore
|
||||||
ARTICLES += diffcore
|
|
||||||
ARTICLES += howto-index
|
ARTICLES += howto-index
|
||||||
ARTICLES += repository-layout
|
ARTICLES += repository-layout
|
||||||
ARTICLES += everyday
|
ARTICLES += everyday
|
||||||
ARTICLES += git-tools
|
ARTICLES += git-tools
|
||||||
ARTICLES += glossary
|
|
||||||
# with their own formatting rules.
|
# with their own formatting rules.
|
||||||
SP_ARTICLES = howto/revert-branch-rebase howto/using-merge-subtree user-manual
|
SP_ARTICLES = howto/revert-branch-rebase howto/using-merge-subtree user-manual
|
||||||
API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
|
API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt)))
|
||||||
|
@ -174,7 +174,7 @@ See the references above to get started using git. The following is
|
|||||||
probably more detail than necessary for a first-time user.
|
probably more detail than necessary for a first-time user.
|
||||||
|
|
||||||
The link:user-manual.html#git-concepts[git concepts chapter of the
|
The link:user-manual.html#git-concepts[git concepts chapter of the
|
||||||
user-manual] and the link:core-tutorial.html[Core tutorial] both provide
|
user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial] both provide
|
||||||
introductions to the underlying git architecture.
|
introductions to the underlying git architecture.
|
||||||
|
|
||||||
See also the link:howto-index.html[howto] documents for some useful
|
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
|
|||||||
|
|
||||||
Terminology
|
Terminology
|
||||||
-----------
|
-----------
|
||||||
Please see the link:glossary.html[glossary] document.
|
Please see the linkgit:gitglossary[7][glossary] document.
|
||||||
|
|
||||||
|
|
||||||
Environment Variables
|
Environment Variables
|
||||||
@ -518,7 +518,7 @@ Discussion[[Discussion]]
|
|||||||
|
|
||||||
More detail on the following is available from the
|
More detail on the following is available from the
|
||||||
link:user-manual.html#git-concepts[git concepts chapter of the
|
link:user-manual.html#git-concepts[git concepts chapter of the
|
||||||
user-manual] and the link:core-tutorial.html[Core tutorial].
|
user-manual] and the linkgit:gitcore-tutorial[7][Core tutorial].
|
||||||
|
|
||||||
A git project normally consists of a working directory with a ".git"
|
A git project normally consists of a working directory with a ".git"
|
||||||
subdirectory at the top level. The .git directory contains, among other
|
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
|
|||||||
<david@dgreaves.com>, and later enhanced greatly by the
|
<david@dgreaves.com>, and later enhanced greatly by the
|
||||||
contributors on the git-list <git@vger.kernel.org>.
|
contributors on the git-list <git@vger.kernel.org>.
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
linkgit:gittutorial[7], linkgit:gittutorial-2[7],
|
||||||
|
linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
|
||||||
|
linkgit:gitglossary[7], linkgit:gitcore-tutorial[7],
|
||||||
|
link:user-manual.html[The Git User's Manual]
|
||||||
|
|
||||||
GIT
|
GIT
|
||||||
---
|
---
|
||||||
Part of the linkgit:git[7] suite
|
Part of the linkgit:git[7] suite
|
||||||
|
@ -1,8 +1,16 @@
|
|||||||
A git core tutorial for developers
|
gitcore-tutorial(7)
|
||||||
==================================
|
===================
|
||||||
|
|
||||||
Introduction
|
NAME
|
||||||
------------
|
----
|
||||||
|
gitcore-tutorial - A git core tutorial for developers
|
||||||
|
|
||||||
|
SYNOPSIS
|
||||||
|
--------
|
||||||
|
git *
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
|
||||||
This tutorial explains how to use the "core" git programs to set up and
|
This tutorial explains how to use the "core" git programs to set up and
|
||||||
work with a git repository.
|
work with a git repository.
|
||||||
@ -1679,3 +1687,13 @@ merge two at a time, documenting how you resolved the conflicts,
|
|||||||
and the reason why you preferred changes made in one side over
|
and the reason why you preferred changes made in one side over
|
||||||
the other. Otherwise it would make the project history harder
|
the other. Otherwise it would make the project history harder
|
||||||
to follow, not easier.
|
to follow, not easier.
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
linkgit:gittutorial[7], linkgit:gittutorial-2[7],
|
||||||
|
linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
|
||||||
|
link:user-manual.html[The Git User's Manual]
|
||||||
|
|
||||||
|
GIT
|
||||||
|
---
|
||||||
|
Part of the linkgit:git[7] suite.
|
@ -20,7 +20,7 @@ this document explains how to do that.
|
|||||||
|
|
||||||
Some basic familiarity with git is required. This
|
Some basic familiarity with git is required. This
|
||||||
linkgit:gittutorial[7][tutorial introduction to git] and the
|
linkgit:gittutorial[7][tutorial introduction to git] and the
|
||||||
link:glossary.html[git glossary] should be sufficient.
|
linkgit:gitglossary[7][git glossary] should be sufficient.
|
||||||
|
|
||||||
Developing against a shared repository
|
Developing against a shared repository
|
||||||
--------------------------------------
|
--------------------------------------
|
||||||
@ -184,7 +184,10 @@ repositories without the need for a central maintainer.
|
|||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
linkgit:gittutorial[7], linkgit:gittutorial-2[7],
|
linkgit:gittutorial[7],
|
||||||
|
linkgit:gittutorial-2[7],
|
||||||
|
linkgit:gitcore-tutorial[7],
|
||||||
|
linkgit:gitglossary[7],
|
||||||
link:everyday.html[Everyday Git],
|
link:everyday.html[Everyday Git],
|
||||||
link:user-manual.html[The Git User's Manual]
|
link:user-manual.html[The Git User's Manual]
|
||||||
|
|
||||||
|
25
Documentation/gitglossary.txt
Normal file
25
Documentation/gitglossary.txt
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
gitglossary(7)
|
||||||
|
==============
|
||||||
|
|
||||||
|
NAME
|
||||||
|
----
|
||||||
|
gitglossary - A GIT Glossary
|
||||||
|
|
||||||
|
SYNOPSIS
|
||||||
|
--------
|
||||||
|
*
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
|
||||||
|
include::glossary-content.txt[]
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
linkgit:gittutorial[7], linkgit:gittutorial-2[7],
|
||||||
|
linkgit:giteveryday[7], linkgit:gitcvs-migration[7],
|
||||||
|
link:user-manual.html[The Git User's Manual]
|
||||||
|
|
||||||
|
GIT
|
||||||
|
---
|
||||||
|
Part of the linkgit:git[7] suite.
|
@ -390,7 +390,7 @@ in the index file is identical to the one in the working directory.
|
|||||||
In addition to being the staging area for new commits, the index file
|
In addition to being the staging area for new commits, the index file
|
||||||
is also populated from the object database when checking out a
|
is also populated from the object database when checking out a
|
||||||
branch, and is used to hold the trees involved in a merge operation.
|
branch, and is used to hold the trees involved in a merge operation.
|
||||||
See the link:core-tutorial.html[core tutorial] and the relevant man
|
See the linkgit:gitcore-tutorial[7][core tutorial] and the relevant man
|
||||||
pages for details.
|
pages for details.
|
||||||
|
|
||||||
What next?
|
What next?
|
||||||
@ -400,7 +400,7 @@ At this point you should know everything necessary to read the man
|
|||||||
pages for any of the git commands; one good place to start would be
|
pages for any of the git commands; one good place to start would be
|
||||||
with the commands mentioned in link:everyday.html[Everyday git]. You
|
with the commands mentioned in link:everyday.html[Everyday git]. You
|
||||||
should be able to find any unknown jargon in the
|
should be able to find any unknown jargon in the
|
||||||
link:glossary.html[Glossary].
|
linkgit:gitglossary[7][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.
|
||||||
@ -412,7 +412,7 @@ CVS-like way.
|
|||||||
For some interesting examples of git use, see the
|
For some interesting examples of git use, see the
|
||||||
link:howto-index.html[howtos].
|
link:howto-index.html[howtos].
|
||||||
|
|
||||||
For git developers, the link:core-tutorial.html[Core tutorial] goes
|
For git developers, the linkgit:gitcore-tutorial[7][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.
|
||||||
|
|
||||||
@ -420,6 +420,8 @@ SEE ALSO
|
|||||||
--------
|
--------
|
||||||
linkgit:gittutorial[7],
|
linkgit:gittutorial[7],
|
||||||
linkgit:gitcvs-migration[7],
|
linkgit:gitcvs-migration[7],
|
||||||
|
linkgit:gitcore-tutorial[7],
|
||||||
|
linkgit:gitglossary[7],
|
||||||
link:everyday.html[Everyday git],
|
link:everyday.html[Everyday git],
|
||||||
link:user-manual.html[The Git User's Manual]
|
link:user-manual.html[The Git User's Manual]
|
||||||
|
|
||||||
|
@ -598,6 +598,8 @@ SEE ALSO
|
|||||||
--------
|
--------
|
||||||
linkgit:gittutorial-2[7],
|
linkgit:gittutorial-2[7],
|
||||||
linkgit:gitcvs-migration[7],
|
linkgit:gitcvs-migration[7],
|
||||||
|
linkgit:gitcore-tutorial[7],
|
||||||
|
linkgit:gitglossary[7],
|
||||||
link:everyday.html[Everyday git],
|
link:everyday.html[Everyday git],
|
||||||
link:user-manual.html[The Git User's Manual]
|
link:user-manual.html[The Git User's Manual]
|
||||||
|
|
||||||
|
@ -1,6 +1,3 @@
|
|||||||
GIT Glossary
|
|
||||||
============
|
|
||||||
|
|
||||||
[[def_alternate_object_database]]alternate object database::
|
[[def_alternate_object_database]]alternate object database::
|
||||||
Via the alternates mechanism, a <<def_repository,repository>>
|
Via the alternates mechanism, a <<def_repository,repository>>
|
||||||
can inherit part of its <<def_object_database,object database>>
|
can inherit part of its <<def_object_database,object database>>
|
@ -4252,7 +4252,10 @@ You see, Git is actually the best tool to find out about the source of Git
|
|||||||
itself!
|
itself!
|
||||||
|
|
||||||
[[glossary]]
|
[[glossary]]
|
||||||
include::glossary.txt[]
|
GIT Glossary
|
||||||
|
============
|
||||||
|
|
||||||
|
include::glossary-content.txt[]
|
||||||
|
|
||||||
[[git-quick-start]]
|
[[git-quick-start]]
|
||||||
Appendix A: Git Quick Reference
|
Appendix A: Git Quick Reference
|
||||||
|
Reference in New Issue
Block a user