git/list[1] front-page[2] threads[3] people[4] search[5] about
 

RFC: Modernizing the contept of plumbing v.s. porcelain

From
Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date
Dec 9, 2020, 08:17 UTC
Message-ID
<878sa7xujm.fsf@evledraar.gmail.com>

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" etc.

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.

1. https://gitlab.com/gitlab-org/gitaly/-/blob/afc90e3c2/doc/serverside_git_usage.md#L11-17
Next: Junio C Hamano
Message 1 of 5 in “RFC: Modernizing the contept of plumbing v.s. porcelain”
  1. Ævar Arnfjörð BjarmasonDec 9, 2020
  2. Junio C HamanoDec 9, 2020
  3. Ævar Arnfjörð BjarmasonDec 10, 2020
  4. Junio C HamanoDec 14, 2020
  5. Felipe ContrerasDec 10, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.