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

Re: [PATCH] Clean weird documentation for 'git var' and 'git

From
PVPhilippe Vaucher <philippe.vaucher@gmail.com>
Date
May 10, 2012, 18:26 UTC
Message-ID
<CAGK7Mr7rzuPVmGsnx+uhmVgBepAav734uh6hHeqn25BC0_+0Lw@mail.gmail.com>
In-Reply-To
<CAGK7Mr6AjSY-D9p1vzs=xCg-TMCPiBJDOSxMVYtykeCZCPW2FA@mail.gmail.com>
>> What's weird about them?  They are real messages issued exactly when they are described to be issued.
>
> The problem is surely that an explanatory line is needed to say that these are the diagnostic messages that occur in various cases. Its in 'ident.c'.

I guess I'm just unfamiliar with the "Diagnostics" section of a man page. When I fall on this there's nothing I learn... all the other sections are helpful and providing self explanatory informations.

In this case (diagnostic section), the first thing I see is "You don't exist, Go away!", and I'm like "okay..." then I see something about the passwd file (what on earth has git-commit-tree in common with passwd?) then I see "Your parents must have hated you!" and there I'm like "okay, there's definitly something wrong with this man page".

I'm probably not the only one confused by this. I think a simple line "This tool might report the following error messages" would already be a great step forward. The next step would be to improve those error messages :)

Philippe
Previous: René ScharfeNext: Junio C Hamano
Message 6 of 9 in “Clean weird documentation for 'git var' and 'git”
  1. Clean weird documentation for 'git var' and 'gitPhilippe Vaucher, May 10, 2012
  2. Philippe VaucherMay 10, 2012
  3. Junio C HamanoMay 10, 2012
  4. Philip OakleyMay 10, 2012
  5. René ScharfeMay 10, 2012
  6. Philippe VaucherMay 10, 2012
  7. Junio C HamanoMay 10, 2012
  8. Philippe VaucherMay 10, 2012
  9. Philippe VaucherMay 10, 2012

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.