Skip to content

pr-2242/jvns/update-git-v3

tagged this 16 Oct 19:15
From: Julia Evans <julia@jvns.ca>

Rewrite `man git` to give a more realistic view of what the
documentation actually provides.

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 direct references to all the guides, for the following
reasons:

* gittutorial and giteveryday are 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.

  The goal is to mention the tutorial again when when we have a tutorial
  we're happy with.
* gitcli is not very useful for users. A lot of it is about scripting
  and internal details about the option parser.
* the user manual is outdated. The chapter on "Sharing development with
  others" explains how to use `git format-patch` which is not how most
  Git users collaborate with git.
* mentioning the data model feels out of place once everything else is
  removed

Mention `git help` instead of `giteveryday` for now, which does a better
job of giving an overview of everyday commands.

Mention `git help --guides` and `git help --user-interfaces`,
since there are some important guides in there (like `submodules`) that
are hard to discover.

Do not mention `git help --developer-interfaces` since it's not relevant
to users.

Remove https://git.github.io/htmldocs/git.html since it points to the
`master` version of the documentation. https://git-scm.com/ has the
version from the latest release which is more likely to be useful.

Signed-off-by: Julia Evans <julia@jvns.ca>

Submitted-As: https://lore.kernel.org/git/pull.2242.v3.git.1792178103727.gitgitgadget@gmail.com
In-Reply-To: https://lore.kernel.org/git/pull.2242.git.1790627574093.gitgitgadget@gmail.com
In-Reply-To: https://lore.kernel.org/git/pull.2242.v2.git.1791317163584.gitgitgadget@gmail.com
Assets 2
Loading