Skip to content

Commit 7687ae9

Browse files
committed
Documentation: update the introductory section
The second paragraph in the git(1) description section were meant to guide people who are not ready to dive into this page away from here. Referring migrating CVS users to another page before they get acquainted with Git was somewhat out of place. Move the reference to the "FURTHER DOCUMENTATION" section and push that section down. Signed-off-by: Junio C Hamano <[email protected]>
1 parent c70c09b commit 7687ae9

File tree

1 file changed

+32
-28
lines changed

1 file changed

+32
-28
lines changed

Documentation/git.txt

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,17 @@ unusually rich command set that provides both high-level operations
2222
and full access to internals.
2323

2424
See linkgit:gittutorial[7] to get started, then see
25-
link:everyday.html[Everyday Git] for a useful minimum set of commands, and
26-
"man git-commandname" for documentation of each command. CVS users may
27-
also want to read linkgit:gitcvs-migration[7]. See
28-
the link:user-manual.html[Git User's Manual] for a more in-depth
29-
introduction.
25+
link:everyday.html[Everyday Git] for a useful minimum set of
26+
commands. The link:user-manual.html[Git User's Manual] has a more
27+
in-depth introduction.
3028

31-
The '<command>' is either a name of a Git command (see below) or an alias
32-
as defined in the configuration file (see linkgit:git-config[1]).
29+
After you mastered the basic concepts, you can come back to this
30+
page to learn what commands git offers. You can learn more about
31+
individual git commands with "git help command". linkgit:gitcli[7]
32+
manual page gives you an overview of the command line command syntax.
3333

34-
Formatted and hyperlinked version of the latest git
35-
documentation can be viewed at
36-
`http://git-htmldocs.googlecode.com/git/git.html`.
34+
Formatted and hyperlinked version of the latest git documentation
35+
can be viewed at `http://git-htmldocs.googlecode.com/git/git.html`.
3736

3837
ifdef::stalenotes[]
3938
[NOTE]
@@ -396,24 +395,6 @@ help ...`.
396395
linkgit:git-replace[1] for more information.
397396

398397

399-
FURTHER DOCUMENTATION
400-
---------------------
401-
402-
See the references above to get started using git. The following is
403-
probably more detail than necessary for a first-time user.
404-
405-
The link:user-manual.html#git-concepts[git concepts chapter of the
406-
user-manual] and linkgit:gitcore-tutorial[7] both provide
407-
introductions to the underlying git architecture.
408-
409-
See linkgit:gitworkflows[7] for an overview of recommended workflows.
410-
411-
See also the link:howto-index.html[howto] documents for some useful
412-
examples.
413-
414-
The internals are documented in the
415-
link:technical/api-index.html[GIT API documentation].
416-
417398
GIT COMMANDS
418399
------------
419400

@@ -833,6 +814,29 @@ The index is also capable of storing multiple entries (called "stages")
833814
for a given pathname. These stages are used to hold the various
834815
unmerged version of a file when a merge is in progress.
835816

817+
FURTHER DOCUMENTATION
818+
---------------------
819+
820+
See the references in the "description" section to get started
821+
using git. The following is probably more detail than necessary
822+
for a first-time user.
823+
824+
The link:user-manual.html#git-concepts[git concepts chapter of the
825+
user-manual] and linkgit:gitcore-tutorial[7] both provide
826+
introductions to the underlying git architecture.
827+
828+
See linkgit:gitworkflows[7] for an overview of recommended workflows.
829+
830+
See also the link:howto-index.html[howto] documents for some useful
831+
examples.
832+
833+
The internals are documented in the
834+
link:technical/api-index.html[GIT API documentation].
835+
836+
Users migrating from CVS may also want to
837+
read linkgit:gitcvs-migration[7].
838+
839+
836840
Authors
837841
-------
838842
Git was started by Linus Torvalds, and is currently maintained by Junio

0 commit comments

Comments
 (0)