archive mirror
 help / color / mirror / Atom feed
From: "Ævar Arnfjörð Bjarmason" <>
Subject: RFC: Modernizing the contept of plumbing v.s. porcelain
Date: Wed, 09 Dec 2020 09:17:33 +0100	[thread overview]
Message-ID: <> (raw)

A lot of external guides and people's mental models of /usr/bin/git as a
scriptable client reference the concept of plumbing & porcelain. Just
one such example [1] prompted me to write this E-Mail.

I've wondered if we shouldn't be updating this concept to reflect the
reality on the ground in the git command ecosystem.

I.e. if you look at "git help git"'s list of plumbing v.s. porcelain it
makes no mention or distinction between those commands & functionalities
that are truly transitory "porcelain". E.g. the specific error message a
command might return, and those that are effectively plumbing. E.g. some
"git config" functionality, "git init", the pretty formats in "git log"

I'm not quite sure what I'm proposing if anything, just putting out
feelers to see if others think this documentary status quo has drifted
from reality.

One potential change would be to mostly/entirely remove the
"porcelain/ancillary/plumbing" distinction in "git help git" (except
maybe e.g. "hash-object") and instead make a mention of the status of
the command at the top of its own manpage, which could then also
(e.g. in the case of "git log") document the API reliability of its
various sub-features.


             reply	other threads:[~2020-12-09  8:18 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-09  8:17 Ævar Arnfjörð Bjarmason [this message]
2020-12-09 19:38 ` RFC: Modernizing the contept of plumbing v.s. porcelain Junio C Hamano
2020-12-10 14:14   ` Ævar Arnfjörð Bjarmason
2020-12-14 22:49     ` Junio C Hamano
2020-12-10  3:07 ` Felipe Contreras

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:

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

  git send-email \ \ \ \

* 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 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 NNTP newsgroup(s).