git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Documentation Directions

From
Jon Loeliger <jdl@freescale.com>
Date
Nov 6, 2005, 17:35 UTC
Message-ID
<E1EYoQE-0002QX-VM@jdl.com>
Couple of questions regarding documentation direction:
- Is the plan to update all docs to use $GIT_DIR instead of .git?
- Do we intend on adding explicit support for '--help' on most,
  if not all, of the git commands?  In some cases (git-branch)
  a -*) case tacitly catches --help and usage()'s it.  In other
  cases (git-pull) this can't be done as -*) passes options
  on to git-fetch.  I think that we should catch --help directly
  so that it doesn't emit git-fetch's *) catch-all usage:
    % git pull --help
    usage: git-fetch-pack [-q] [-v] [--exec=upload-pack] [host:]directory <refs>...
    Fetch failure: --help
- Do you want to head in the per-man-page-"Now What?" direction
  as suggested by Junio?

Thanks, jdl

Next: Junio C Hamano
Message 1 of 3 in “Documentation Directions”
  1. Jon LoeligerNov 6, 2005
  2. Junio C HamanoNov 6, 2005
  3. Nikolai WeibullNov 6, 2005

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.