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

[RFC/WIP 0/2] Documentation clean-up: git commands

From
Michael J Gruber <git@drmicha.warpmail.net>
Date
Mar 23, 2009, 14:28 UTC
Message-ID
<1237818533-31577-1-git-send-email-git@drmicha.warpmail.net>

In current git documentation, git commands are still written in various styles: with and without dash, unformatted and formatted with `, ' or ".

I propose to use `git command` consistently. In asciidoc, backticks are for commands, ticks for paths. [Quotes should be like ``this''.]

A first step is reaching a consistent use of backticks. A second step would be sed magic to get rid of the dashes in the text, not in the links (linkgit:...).

Patch 1 is a preparation patch where I spotted the use of a command with "git" in an instance where it looks very inconsistent. (It feels OK when talking about commands more colloquially.)

Patch 2 is an example for the first step.
Questions:
- Do we want this at all?
- Do we want it this way (`git command`)?
- How to prepare: 1 patch per file/per 5 files/per 50 changes?
- How to submit: single patch once ready or whole series at end (5 years
  from now)?
- How to send: Bother the list or send pull requests only?

I don't know what I'm getting myself into... Michael

Michael J Gruber (2):
  Documentation: fix minor inconsistency
  Documentation: format git commands consistently
 Documentation/config.txt              |  114 ++++++++++++++++----------------
 Documentation/diff-format.txt         |    6 +-
 Documentation/diff-generate-patch.txt |   12 ++--
 Documentation/diff-options.txt        |    4 +-
 Documentation/everyday.txt            |    6 +-
 Documentation/fetch-options.txt       |   12 ++--
 Documentation/git-add.txt             |   28 ++++----
 Documentation/git-am.txt              |   16 ++--
 8 files changed, 99 insertions(+), 99 deletions(-)
Next: Michael J Gruber
Message 1 of 11 in “[RFC/WIP 0/2] Documentation clean-up: git commands”
  1. Michael J GruberMar 23, 2009
  2. 1/2 Documentation: fix minor inconsistencyMichael J Gruber, Mar 23, 2009
  3. 2/2 Documentation: format git commands consistentlyMichael J Gruber, Mar 23, 2009
  4. Matthieu MoyMar 23, 2009
  5. Michael J GruberMar 23, 2009
  6. Michael J GruberMar 23, 2009
  7. Junio C HamanoMar 23, 2009
  8. Michael J GruberMar 23, 2009
  9. Chris JohnsenMar 23, 2009
  10. Jeff KingMar 24, 2009
  11. Michael J GruberMar 24, 2009

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.