All of lore.kernel.org
 help / color / mirror / Atom feed
From: Eric Sunshine <sunshine@sunshineco.com>
To: Philip Oakley <philipoakley@iee.email>
Cc: "Git List" <git@vger.kernel.org>, "Jeff King" <peff@peff.net>,
	"Junio C Hamano" <gitster@pobox.com>,
	"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
	"Randall Becker" <rsbecker@nexbridge.com>,
	"Baruch Burstein" <bmburstein@gmail.com>
Subject: Re: [PATCH] CodingGuidelines: document which output goes to stdout vs. stderr
Date: Wed, 1 Dec 2021 18:56:15 -0500	[thread overview]
Message-ID: <CAPig+cTAzmaHJa3tGniO5AsL+tQO9+bZuO-AUqU+WisDEgp4UQ@mail.gmail.com> (raw)
In-Reply-To: <1f0cc771-b661-42ae-e928-75c27f1dab07@iee.email>

On Wed, Dec 1, 2021 at 6:27 PM Philip Oakley <philipoakley@iee.email> wrote:
> On 01/12/2021 05:32, Eric Sunshine wrote:
> > +Program Output
> > +
> > + We make a distinction between a command's primary output and output
> > + which is merely chatty feedback (for instance, status messages,
> > + running transcript, or progress display), as well as error messages.
> > + Roughly speaking, a command's primary output is that which one might
> > + want to capture to a file or send down a pipe; its chatty output
> > + should not interfere with those use-cases.
>
> Is there a case for commenting on whether chatty output may be
> suppressed if not feeding a terminal, or is that mentioned elsewhere? I
> often see comments about the isatty() detection.

I don't think I saw any such mention when reading through
CodingGuidelines before composing the new text. That's certainly a
topic which could be addressed, but I don't plan on adding it to this
patch since I don't have any specific idea in mind for how it would be
discussed. However, the new "Program Output" section added by this
patch seems a good place to add that discussion if someone wants to
have a go at it as a separate patch atop this one.

  reply	other threads:[~2021-12-01 23:56 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-01  5:32 [PATCH] CodingGuidelines: document which output goes to stdout vs. stderr Eric Sunshine
2021-12-01  8:33 ` Fabian Stelzer
2021-12-01 13:50   ` Eric Sunshine
2021-12-01 15:14     ` Fabian Stelzer
2021-12-01 21:35     ` Junio C Hamano
2021-12-01 21:57       ` Eric Sunshine
2021-12-01 19:42 ` Jeff King
2021-12-01 20:30   ` Eric Sunshine
2021-12-01 23:27 ` Philip Oakley
2021-12-01 23:56   ` Eric Sunshine [this message]
2021-12-02 22:31 ` [PATCH v2] " Eric Sunshine
2021-12-02 23:58   ` Jeff King

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

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

  git send-email \
    --in-reply-to=CAPig+cTAzmaHJa3tGniO5AsL+tQO9+bZuO-AUqU+WisDEgp4UQ@mail.gmail.com \
    --to=sunshine@sunshineco.com \
    --cc=avarab@gmail.com \
    --cc=bmburstein@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=peff@peff.net \
    --cc=philipoakley@iee.email \
    --cc=rsbecker@nexbridge.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. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.