CodingGuidelines: document which output goes to stdout vs. stderr
commite258eb4800e30da2adbdb2df8d8d8c19d9b443e4
authorEric Sunshine <sunshine@sunshineco.com>
Thu, 2 Dec 2021 22:31:10 +0000 (2 17:31 -0500)
committerJunio C Hamano <gitster@pobox.com>
Sun, 5 Dec 2021 01:26:41 +0000 (4 17:26 -0800)
tree5757837476defabaf9653b88ffcf807c5d5ad125
parente9d7761bb94f20acc98824275e317fa82436c25d
CodingGuidelines: document which output goes to stdout vs. stderr

It has long been practice on this project for a command to emit its
primary output to stdout so that it can be captured to a file or sent
down a pipe, and to emit "chatty" messages (such as those reporting
progress) to stderr so that they don't interfere with the primary
output. However, this practice is not necessarily universal; another
common practice is to send only error messages to stderr, and all other
messages to stdout. Therefore, help newcomers out by documenting how
stdout and stderr are used on this project.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Acked-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/CodingGuidelines