* Man pages lack of exit status information
@ 2008-04-17 7:45 Francis Moreau
2008-04-17 8:17 ` Wincent Colaiuta
0 siblings, 1 reply; 4+ messages in thread
From: Francis Moreau @ 2008-04-17 7:45 UTC (permalink / raw)
To: git
Hello,
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 ?
Thanks
--
Francis
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: Man pages lack of exit status information
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
0 siblings, 1 reply; 4+ messages in thread
From: Wincent Colaiuta @ 2008-04-17 8:17 UTC (permalink / raw)
To: Francis Moreau; +Cc: git
El 17/4/2008, a las 9:45, Francis Moreau escribió:
> Hello,
>
> 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.
Cheers,
Wincent
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: Man pages lack of exit status information
2008-04-17 8:17 ` Wincent Colaiuta
@ 2008-04-17 8:38 ` Francis Moreau
2008-04-17 17:38 ` David Mansfield
0 siblings, 1 reply; 4+ messages in thread
From: Francis Moreau @ 2008-04-17 8:38 UTC (permalink / raw)
To: Wincent Colaiuta; +Cc: git
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: Man pages lack of exit status information
2008-04-17 8:38 ` Francis Moreau
@ 2008-04-17 17:38 ` David Mansfield
0 siblings, 0 replies; 4+ messages in thread
From: David Mansfield @ 2008-04-17 17:38 UTC (permalink / raw)
To: Francis Moreau; +Cc: Wincent Colaiuta, git
On Thu, 2008-04-17 at 10:38 +0200, Francis Moreau wrote:
> 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.
>
+1 for adding a RETURN VALUE section to the docs.
Yes, please! We need this. I got burned because git-status does
something which is non-intuitive, and just yesterday I was asking about
git-merge, which I can only assume returns (exits) with 1 if there was a
conflict.
David
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2008-04-17 17:39 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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
2008-04-17 17:38 ` David Mansfield
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).