Re: [PATCH 1/2] Documentation spelling fixes.

From: Jonathan Nieder <jrnieder@gmail.com>
Date: Jul 19, 2010, 23:11 UTC
Message-ID: <20100719231123.GA1708@burratino>
In-Reply-To: <1279574238-16649-1-git-send-email-ville.skytta@iki.fi>

Hi Ville,

Ville Skyttä wrote:

> ---

If this does not end up needing a re-roll, would it be okay for Junio (or whoever else picks up the patch) to forge your sign-off? (See "Sign your work" in Documentation/SubmittingPatches for what I mean.)

Show 7 quoted lines

> +++ b/Documentation/config.txt
> @@ -418,7 +418,7 @@ Common unit suffixes of 'k', 'm', or 'g' are supported.
>  
>  core.deltaBaseCacheLimit::
>  	Maximum number of bytes to reserve for caching base objects
> -	that multiple deltafied objects reference.  By storing the
> +	that multiple deltified objects reference.  By storing the

Huh?  Maybe

	Maximum number of bytes to reserve for caching based objects
	that might be referenced by multiple deltified objects.

Or:

	Amount of memory (in bytes) to reserve for speeding up
	unpacking of deltified objects.  By storing entire
	decompressed base objects in a cache, Git can avoid
	unpacking and decompressing frequently-used base objects
	multiple times.

Show 6 quoted lines

> @@ -1275,7 +1275,7 @@ instaweb.local::
>  	be bound to the local IP (127.0.0.1).
>  
>  instaweb.modulepath::
> -	The module path for an apache httpd used by linkgit:git-instaweb[1].
> +	The module path for an Apache httpd used by linkgit:git-instaweb[1].

Maybe:

	Default module path for linkgit:git-instaweb[1] to use
	instead of /usr/lib/apache2/modules.  Only used if httpd
	is Apache.

Show 7 quoted lines

> +++ b/Documentation/git-cvsserver.txt
> @@ -366,8 +366,8 @@ CRLF Line Ending Conversions
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
>  By default the server leaves the '-k' mode blank for all files,
> -which causes the cvs client to treat them as a text files, subject
> +which causes the CVS client to treat them as a text files, subject

Should we call the cvs(1) command "the CVS client"? Maybe "the cvs(1) client" or something would be clearer, but I don't see anything wrong with your choice.

> -to crlf conversion on some platforms.
> +to CRLF conversion on some platforms.

This term can be confusing, as we've seen in other contexts. Maybe:

	subject to line-ending conversion on some platforms.

Show 8 quoted lines

> +++ b/Documentation/git-hash-object.txt
> @@ -49,7 +49,7 @@ OPTIONS
>  
>  --no-filters::
>  	Hash the contents as is, ignoring any input filter that would
> -	have been chosen by the attributes mechanism, including crlf
> +	have been chosen by the attributes mechanism, including CRLF
>  	conversion. If the file is read from standard input then this

It's called "end-of-line conversion" in gitattributes(5) now, apparently.

The rest of this one looks good.  Thanks.