Re: [PATCH v2 4/4] Documentation: spell 'git cmd' without dash throughout

From: Jonathan Nieder <jrnieder@gmail.com>
Date: Jan 10, 2010, 02:56 UTC
Message-ID: <20100110025641.GB1083@progeny.tock>
In-Reply-To: <9516c897017ec420403bb7f687fb8962de42cb7c.1263081032.git.trast@student.ethz.ch>

Thomas Rast wrote:

> Replace 'git-cmd' with 'git cmd' throughout, except where git-shell,
> git-cvsserver, git-upload-pack, git-receive-pack, and
> git-upload-archive are concerned, because those really live in the
> $PATH.

Agreed. Some forms of 'man' even support 'man git am', so the "it's what you pass to 'man'" excuse does not even apply any more.

>  110 files changed, 584 insertions(+), 584 deletions(-)

But yikes!  Did you do this by hand or by some automated process?

Show 20 quoted lines

> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index 6bfd9e1..db28408 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -64,7 +64,7 @@ The values following the equals sign in variable assign are all either
>  a string, an integer, or a boolean.  Boolean values may be given as yes/no,
>  0/1, true/false or on/off.  Case is not significant in boolean values, when
>  converting value to the canonical form using '--bool' type specifier;
> -'git-config' will ensure that the output is "true" or "false".
> +'git config' will ensure that the output is "true" or "false".
>  
>  String values may be entirely or partially enclosed in double quotes.
>  You need to enclose variable values in double quotes if you want to
> @@ -442,7 +442,7 @@ core.pager::
>  
>  core.whitespace::
>  	A comma separated list of common whitespace problems to
> -	notice.  'git-diff' will use `color.diff.whitespace` to
> +	notice.  'git diff' will use `color.diff.whitespace` to
>  	highlight them, and 'git-apply --whitespace=error' will

A 'git-apply' snuck in. ;-)

> @@ -563,24 +563,24 @@ branch.autosetuprebase::

[...]

>  	Specify multiple values to get an octopus merge.
> -	If you wish to setup 'git-pull' so that it merges into <name> from
> +	If you wish to setup 'git pull' so that it merges into <name> from

Not relevant to this patch, but shouldn't ‘setup’ be ‘set up’?

Show 15 quoted lines

> @@ -718,14 +718,14 @@ commit.template::
>  	specified user's home directory.
>  
>  diff.autorefreshindex::
> -	When using 'git-diff' to compare with work tree
> +	When using 'git diff' to compare with work tree
>  	files, do not consider stat-only change as changed.
>  	Instead, silently run `git update-index --refresh` to
>  	update the cached stat information for paths whose
>  	contents in the work tree match the contents in the
>  	index.  This option defaults to true.  Note that this
> -	affects only 'git-diff' Porcelain, and not lower level
> -	'diff' commands, such as 'git-diff-files'.
> +	affects only 'git diff' Porcelain, and not lower level
> +	'diff' commands, such as 'git diff-files'.

This sounds better to me without the comma before ‘such as’.

Show 9 quoted lines

> @@ -840,7 +840,7 @@ format.pretty::
>  	linkgit:git-whatchanged[1].
>  
>  format.thread::
> -	The default threading style for 'git-format-patch'.  Can be
> +	The default threading style for 'git format-patch'.  Can be
>  	either a boolean value, `shallow` or `deep`.  `shallow`
>  	threading makes every mail a reply to the head of the series,
>  	where the head is chosen from the cover letter, the

The ‘either’ here sounds awkward, because there are three options. Also it is not completely clear that ‘shallow’ and ‘deep’ are not boolean values here. So maybe ‘Can be a boolean value, or shallow or deep’, despite the awkward nested ‘or’ expression.

Show 10 quoted lines

> @@ -875,18 +875,18 @@ gc.autopacklimit::
>  	default	value is 50.  Setting this to 0 disables it.
>  
>  gc.packrefs::
> -	'git-gc' does not run `git pack-refs` in a bare repository by
> +	'git gc' does not run `git pack-refs` in a bare repository by
>  	default so that older dumb-transport clients can still fetch
> -	from the repository.  Setting this to `true` lets 'git-gc'
> +	from the repository.  Setting this to `true` lets 'git gc'
>  	to run `git pack-refs`.  Setting this to `false` tells

Should be ‘lets git gc run’ or ‘tells git gc to run’. Not to mention this is not true any more: 'git gc' has run pack-refs by default ever since commit 56752391 (Make "git gc" pack all refs by default, 2007-05-24). As that commit message mentions, git versions before v1.5.1.2 cannot clone repos with packed refs over http, and git versions before v1.4.4 cannot handled packed refs period, but more recent git should have no problems.

So to summarize, the changes to config.txt look good, except a ‘git-apply’ snuck past.

The other changes mentioned above follow.

  Documentation: config: git gc packs refs by default now
  Documentation: tiny git config manual tweaks

 Documentation/config.txt |   23 ++++++++++-------------
 1 files changed, 10 insertions(+), 13 deletions(-)