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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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(-)

--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html

[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux