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

Re: Man pages lack of exit status information

From
FMFrancis Moreau <francis.moro@gmail.com>
Date
Apr 17, 2008, 08:38 UTC
Message-ID
<38b2ab8a0804170138u717fb753me45ead12720c9e3d@mail.gmail.com>
In-Reply-To
<BE732D9B-D2C2-4578-BC9D-52473C37EA74@wincent.com>
On Thu, Apr 17, 2008 at 10:17 AM, Wincent Colaiuta <win@wincent.com> wrote:
Show 16 quoted lines
> El 17/4/2008, a las 9:45, Francis Moreau escribió:
> > I checked on a couple of git commands' man pages and I couldn't find
> > the exit status of these commands.
> >
> > For example: git-status, git-diff man pages don't tell anything.
> >
> > Am I missing something ?
> >
>
>  The "git-diff" man page documents this under the --exit-code option. It
> probably would be nice to have an "EXIT STATUS" section added to the man
> pages of those commands for which it would be interesting (like "git-diff")
> and perhaps to the main "git" man page as well (with general info).
>
>  If there is interest in this I'll whip up a doc patch.
>

I think it makes sense to have such section specially since git plumbings are also designed to be used in higher level scripts.

I really use to searching for RETURN VALUE section in man pages when I need what a command returns. And it's a pain to have to read the whole man page for finding such important information.

Thanks
-- 
Francis
Previous: Wincent ColaiutaNext: David Mansfield
Message 3 of 4 in “Man pages lack of exit status information”
  1. Francis MoreauApr 17, 2008
  2. Wincent ColaiutaApr 17, 2008
  3. Francis MoreauApr 17, 2008
  4. David MansfieldApr 17, 2008

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.