git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "Francis Moreau" <francis.moro@gmail.com>
To: "Wincent Colaiuta" <win@wincent.com>
Cc: git@vger.kernel.org
Subject: Re: Man pages lack of exit status information
Date: Thu, 17 Apr 2008 10:38:44 +0200	[thread overview]
Message-ID: <38b2ab8a0804170138u717fb753me45ead12720c9e3d@mail.gmail.com> (raw)
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:
> 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

  reply	other threads:[~2008-04-17  8:39 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-04-17  7:45 Man pages lack of exit status information Francis Moreau
2008-04-17  8:17 ` Wincent Colaiuta
2008-04-17  8:38   ` Francis Moreau [this message]
2008-04-17 17:38     ` David Mansfield

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=38b2ab8a0804170138u717fb753me45ead12720c9e3d@mail.gmail.com \
    --to=francis.moro@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=win@wincent.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).