Skip to content

Commit 5da3881

Browse files
committed
[doc] Use man git to teach users how to navigate the docs
Many existing users of Git don't know how Git's documentation is structured, and a lot of folks have expressed frustration that `man git` doesn't make it easy to find out how to get help with using Git. Explain how Git's help system works in `man git` (`git push -h` gives a short help, `git push --help` is the full docs), since it's a slightly unusual approach. Remove the references to gittutorial and giteveryday since they're unlikely to help new users learn Git. Currently they feel very aspirational (it would be nice to have a tutorial and a guide to everyday Git commands!), but we should give users a realistic view of what the documentation actually provides. Mention `git help` instead of `giteveryday` for now, which does a better job of giving an overview of everyday commands. Also mention `git help --guides` and `git help --user-interfaces`, since those parts of the documentation are useful and hard to discover. Do not mention `git help --developer-interfaces` since it's not relevant to users. Signed-off-by: Julia Evans <julia@jvns.ca>
1 parent 0f8e75a commit 5da3881

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

‎Documentation/git.adoc‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,18 @@ Git is a fast, scalable, distributed revision control system with an
2222
unusually rich command set that provides both high-level operations
2323
and full access to internals.
2424

25-
See linkgit:gittutorial[7] to get started, then see
26-
linkgit:giteveryday[7] for a useful minimum set of
27-
commands. The link:user-manual.html[Git User's Manual] has a more
28-
in-depth introduction. See linkgit:gitdatamodel[7] if you want to
29-
learn about the data model and important terminology.
30-
31-
After you mastered the basic concepts, you can come back to this
32-
page to learn what commands Git offers. You can learn more about
33-
individual Git commands with "git help command". linkgit:gitcli[7]
34-
manual page gives you an overview of the command-line command syntax.
25+
There are two ways to get help on any Git subcommand (replace "push"
26+
with the command you want help with):
27+
28+
- `git push -h` for a short help
29+
- `git push --help` for the full documentation
30+
31+
There are also guides explaining Git's concepts and more:
32+
33+
- `git help` shows the most frequently used Git subcommands
34+
- `git help --guides` lists Git's concept guides
35+
- `git help --user-interfaces` lists guides for various
36+
special files you can use to change Git's behaviour
3537
3638
A formatted and hyperlinked copy of the latest Git documentation
3739
can be viewed at https://git.github.io/htmldocs/git.html

0 commit comments

Comments
 (0)