Re: [PATCH] Fix documentation for core.gitproxy to reflect code

From: Junio C Hamano <gitster@pobox.com>
Date: Aug 2, 2007, 20:12 UTC
Message-ID: <7vtzrhvgpc.fsf@assigned-by-dhcp.cox.net>
In-Reply-To: <ee77f5c20708020523m1a243bf2g9778994441cd21d5@mail.gmail.com>

"David Symonds" <dsymonds@gmail.com> writes:

Show 5 quoted lines

> This is with respect to my earlier email about core.gitproxy. I
> figured since 1.5.3 is looming it would be best to get the
> documentation correct, then nag about the feature later!
>
> Dave.

That's not a commit log message.

If the existing example does not work, then please say that you fixed it (i.e. "The values in the example does not work. The accepted forms are such and such and such, so use them in the example") in the log message. "Your earlier email" does not count. People who are reading the "git log" output would not have easy access to it.

If core.gitproxy is not documented (I suspect the parts you touched are not about "how to use core.gitproxy" but "what's the syntax of a configuration file" example), it needs its own proper entry in config.txt. If it has one, but if you feel it needs more explanation or exmples, that section needs to be updated.

Please retry.