From: Jonathan Nieder <jrnieder@gmail•com>
To: Thomas Rast <trast@student•ethz.ch>
Cc: git@vger•kernel.org, Junio C Hamano <gitster@pobox•com>
Subject: Re: [PATCH v2 3/4] Documentation: format full commands in typewriter font
Date: Sat, 9 Jan 2010 21:31:33 -0600 [thread overview]
Message-ID: <20100110033133.GE1083@progeny.tock> (raw)
In-Reply-To: <9d10ee6a8526dc9f9c220cc6bb4b509c8cc73b0a.1263081032.git.trast@student.ethz.ch>
Thomas Rast wrote:
> * If the intent is that the user type the command exactly as given, it
> is `code`.
> If the user is only loosely referred to a command and/or option, it
> remains 'emphasised'.
Okay. I think I was guilty of pushing this convention (in commits
like 2fd02c92). If the distinction is too hazy to be useful, I think
it would be fine to always use `code`, though that would be a bigger
patch.
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index 23a965e..6bfd9e1 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -741,15 +741,15 @@ diff.mnemonicprefix::
> standard "a/" and "b/" depending on what is being compared. When
> this configuration is in effect, reverse diff output also swaps
> the order of the prefixes:
> -'git-diff';;
> +`git diff`;;
> compares the (i)ndex and the (w)ork tree;
> -'git-diff HEAD';;
> +`git diff HEAD`;;
> compares a (c)ommit and the (w)ork tree;
> -'git diff --cached';;
> +`git diff --cached`;;
> compares a (c)ommit and the (i)ndex;
> -'git-diff HEAD:file1 file2';;
> +`git-diff HEAD:file1 file2`;;
Shouldn't this use ‘git diff’ (no hyphen)? Alternatively, if you are
leaving this for the next commit, should the other 'git-diff' lines
keep their dash until then, too?
> diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
> index c39d957..f91c7ac 100644
> --- a/Documentation/git-bisect.txt
> +++ b/Documentation/git-bisect.txt
> @@ -26,7 +26,7 @@ on the subcommand:
> git bisect log
> git bisect run <cmd>...
>
> -This command uses 'git rev-list --bisect' to help drive the
> +This command uses `git rev-list --bisect` to help drive the
Does rev-list --bisect take more arguments (i.e., isn’t the command
being only loosely referred to here)?
> diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
> index 394a77a..544836a 100644
> --- a/Documentation/git-filter-branch.txt
> +++ b/Documentation/git-filter-branch.txt
> @@ -129,8 +129,8 @@ convenience functions, too. For example, calling 'skip_commit "$@"'
> will leave out the current commit (but not its changes! If you want
> that, use 'git-rebase' instead).
> +
> -You can also use the 'git_commit_non_empty_tree "$@"' instead of
> -'git commit-tree "$@"' if you don't wish to keep commits with a single parent
> +You can also use the `git_commit_non_empty_tree "$@"` instead of
> +`git commit-tree "$@"` if you don't wish to keep commits with a single parent
> and that makes no change to the tree.
Not this commit’s topic, but perhaps ‘use the ...’ should be ‘use ...’
or ‘use the ... idiom’...
> --tag-name-filter <command>::
> @@ -179,7 +179,7 @@ the nearest ancestor that was not excluded.
> and only one parent, it will hence keep merges points. Also, this
> option is not compatible with the use of '--commit-filter'. Though you
> just need to use the function 'git_commit_non_empty_tree "$@"' instead
> - of the 'git commit-tree "$@"' idiom in your commit filter to make that
> + of the `git commit-tree "$@"` idiom in your commit filter to make that
> happen.
... to match this.
> diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
> index 3277f4e..04c21d3 100644
> --- a/Documentation/git-merge.txt
> +++ b/Documentation/git-merge.txt
> @@ -193,7 +193,7 @@ After seeing a conflict, you can do two things:
>
> * Decide not to merge. The only clean-ups you need are to reset
> the index file to the `HEAD` commit to reverse 2. and to clean
> - up working tree changes made by 2. and 3.; 'git-reset --hard' can
> + up working tree changes made by 2. and 3.; `git-reset --hard` can
Probably `git reset --hard` (I won’t mention any more of these).
Except for the bisect-change above,
Reviewed-by: Jonathan Nieder <jrnieder@gmail•com>
The rest looks good, and really does seem clearer in some places.
Thanks,
Jonathan
next prev parent reply other threads:[~2010-01-10 3:33 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-01-07 17:03 [PATCH 1/2] Documentation/git-merge: reword references to "remote" and "pull" Thomas Rast
2010-01-07 17:03 ` [PATCH 2/2] Documentation: warn prominently against merging with dirty trees Thomas Rast
2010-01-07 17:03 ` [NON-PATCH 3/2] Documentation/git-merge: format full commands in typewriter font Thomas Rast
2010-01-07 20:25 ` Jonathan Nieder
2010-01-07 21:08 ` Junio C Hamano
2010-01-07 18:01 ` [PATCH 1/2] Documentation/git-merge: reword references to "remote" and "pull" Junio C Hamano
2010-01-10 0:02 ` [PATCH v2 0/4] Documentation style fixes Thomas Rast
2010-01-10 0:02 ` [PATCH v2 1/4] Documentation/git-merge: reword references to "remote" and "pull" Thomas Rast
2010-01-10 4:13 ` Jonathan Nieder
2010-01-10 12:24 ` Thomas Rast
2010-01-23 22:48 ` [PATCH] Documentation: merge: use MERGE_HEAD to refer to the remote branch Jonathan Nieder
2010-01-10 0:02 ` [PATCH v2 2/4] Documentation: warn prominently against merging with dirty trees Thomas Rast
2010-01-10 4:49 ` Jonathan Nieder
2010-01-10 6:31 ` Junio C Hamano
2010-01-10 12:16 ` Thomas Rast
2010-01-11 2:13 ` Jonathan Nieder
2010-01-11 2:30 ` Junio C Hamano
2010-01-11 4:13 ` Jonathan Nieder
2010-01-11 8:21 ` [PATCH 0/6] " Jonathan Nieder
2010-01-11 8:27 ` [PATCH/RFC 1/6] Documentation: clarify one-line description for merge Jonathan Nieder
2010-01-11 8:30 ` [PATCH 2/6] Documentation: merge: add an overview Jonathan Nieder
2010-01-11 10:09 ` Junio C Hamano
2010-01-11 8:37 ` [PATCH 4/6] Documentation: emphasize when git merge terminates early Jonathan Nieder
2010-01-11 23:11 ` Thomas Rast
2010-01-11 8:39 ` [PATCH 5/6] Documentation: merge: add a section about fast-forward Jonathan Nieder
2010-01-11 8:43 ` [PATCH 6/6] Documentation: tweak How Merge Works Jonathan Nieder
2010-01-11 23:11 ` Thomas Rast
2010-01-13 10:44 ` [PATCH 0/6] Re: Documentation: warn prominently against merging with dirty trees Petr Baudis
2010-01-13 6:55 ` [PATCH v2 2/4] " Junio C Hamano
2010-01-10 0:02 ` [PATCH v2 3/4] Documentation: format full commands in typewriter font Thomas Rast
2010-01-10 3:31 ` Jonathan Nieder [this message]
2010-01-10 0:07 ` [PATCH v2 0/4] Documentation style fixes Thomas Rast
2010-01-10 0:19 ` Thomas Rast
2010-01-10 6:34 ` Junio C Hamano
2010-01-10 12:10 ` Thomas Rast
2010-01-10 12:10 ` [PATCH 1/2] More missed dashed 'git-cmd' forms Thomas Rast
2010-01-10 12:10 ` [PATCH 2/2] More missed `code snippets` Thomas Rast
2010-01-10 12:11 ` [PATCH] Documentation: show-files is now called git-ls-files Thomas Rast
2010-01-18 1:18 ` [PATCH v2 0/4] Documentation style fixes Junio C Hamano
2010-01-19 17:29 ` Thomas Rast
2010-01-19 17:39 ` Jonathan Nieder
2010-01-10 7:12 ` Junio C Hamano
[not found] ` <9516c897017ec420403bb7f687fb8962de42cb7c.1263081032.git.trast@student.ethz.ch>
2010-01-10 2:56 ` [PATCH v2 4/4] Documentation: spell 'git cmd' without dash throughout Jonathan Nieder
2010-01-10 2:59 ` [PATCH 1/2] Documentation: git gc packs refs by default now Jonathan Nieder
2010-01-10 3:01 ` [PATCH 2/2] Documentation: tiny git config manual tweaks Jonathan Nieder
2010-01-10 12:21 ` [PATCH v2 4/4] Documentation: spell 'git cmd' without dash throughout Thomas Rast
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=20100110033133.GE1083@progeny.tock \
--to=jrnieder@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
--cc=trast@student$(echo .)ethz.ch \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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