git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH] Man page section reference should be in uppercase

From
DTDévai Tamás <devait@vnet.hu>
Date
May 25, 2010, 18:45 UTC
Message-ID
<1274813122.1178.8.camel@localhost.localdomain>
In-Reply-To
<1274756484-27867-1-git-send-email-ayiehere@gmail.com>
2010. 05. 25, kedd keltezéssel 11.01-kor Nazri Ramliy ezt írta:
Show 8 quoted lines
> From: nazri <ayiehere@gmail.com>
> 
> The advice given by git push when doing a non-fast-forward push refers
> to the section 'Note about fast-forwards' in the git-push(1) man page.
> 
> The section name should really be all in uppercase, as in 'NOTE ABOUT
> FAST-FORWARDS' because that is how it is shown by git push --help.
> 

I don't really agree with this, but it might be only my personal preference. Reasons:

The section title in the man page is "typeset" in a "different font" to be easily distinguishable from the surrounding text -- therefore it's all capital. On the other hand, changing the reference in the advice given by git-push to be all uppercase will give a needless emphasis on the referred section title. This is wrong IMHO, because the main point of the advice is not this reference, but the earlier sentences (i.e. the push was rejected).

Show 20 quoted lines
> Signed-off-by: Nazri Ramliy <ayiehere@gmail.com>
> ---
>  builtin/push.c |    4 ++--
>  1 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/builtin/push.c b/builtin/push.c
> index f4358b9..0694200 100644
> --- a/builtin/push.c
> +++ b/builtin/push.c
> @@ -130,8 +130,8 @@ static int push_with_options(struct transport *transport, int flags)
>  
>  	if (nonfastforward && advice_push_nonfastforward) {
>  		fprintf(stderr, "To prevent you from losing history, non-fast-forward updates were rejected\n"
> -				"Merge the remote changes before pushing again.  See the 'Note about\n"
> -				"fast-forwards' section of 'git push --help' for details.\n");
> +				"Merge the remote changes before pushing again.  See the 'NOTE ABOUT\n"
> +				"FAST-FORWARDS' section of 'git push --help' for details.\n");
>  	}
>  
>  	return 1;
Previous: Nazri RamliyNext: Nazri Ramliy
Message 2 of 4 in “Man page section reference should be in uppercase”
  1. Man page section reference should be in uppercaseNazri Ramliy, May 25, 2010
  2. Dévai TamásMay 25, 2010
  3. Fwd: [PATCH] Man page section reference should be in uppercaseNazri Ramliy, May 26, 2010
  4. Junio C HamanoMay 27, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.