From: Michael J Gruber <git@drmicha.warpmail.net>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [RFC/WIP 0/2] Documentation clean-up: git commands
Date: Mon, 23 Mar 2009 15:28:51 +0100 [thread overview]
Message-ID: <1237818533-31577-1-git-send-email-git@drmicha.warpmail.net> (raw)
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 reply other threads:[~2009-03-23 14:30 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-03-23 14:28 Michael J Gruber [this message]
2009-03-23 14:28 ` [RFC/WIP 1/2] Documentation: fix minor inconsistency Michael J Gruber
2009-03-23 14:28 ` [RFC/WIP 2/2] Documentation: format git commands consistently Michael J Gruber
2009-03-23 14:44 ` [RFC/WIP 1/2] Documentation: fix minor inconsistency Matthieu Moy
2009-03-23 14:56 ` Michael J Gruber
2009-03-23 14:31 ` [RFC/WIP 0/2] Documentation clean-up: git commands Michael J Gruber
2009-03-23 16:22 ` Junio C Hamano
2009-03-23 16:35 ` Michael J Gruber
2009-03-23 23:13 ` Chris Johnsen
2009-03-24 3:34 ` Jeff King
2009-03-24 8:24 ` Michael J Gruber
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1237818533-31577-1-git-send-email-git@drmicha.warpmail.net \
--to=git@drmicha.warpmail.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).