From: Felipe Contreras <felipe.contreras@gmail.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: Git <git@vger.kernel.org>
Subject: Re: RFC: Modernizing the contept of plumbing v.s. porcelain
Date: Wed, 9 Dec 2020 21:07:06 -0600 [thread overview]
Message-ID: <CAMP44s1bemXUC2wR-2X2-Pp+=OU-=UrMsSroCwqu5jZ0krAy0A@mail.gmail.com> (raw)
In-Reply-To: <878sa7xujm.fsf@evledraar.gmail.com>
On Wed, Dec 9, 2020 at 5:02 PM Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:
>
> 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 option would be to split git into two binaries: "git" and
"git-tool". Obviously the latter would be plumbing.
We could slowly move the documentation to git-tool and by doing so we
could see that if a porcelain man page has too many links to git-tool
documentation, that's some area of opportunity.
Every time you access a git-tool command inside git, it still would
work, but you will get a warning: "you are using a plumbing command,
use git-tool instead". Scripts could enable GIT_TOOL_MODE=1 if they
are going to access many of these commands and don't want to
s/git/git-tool/.
I would be a ton of work, but it's something I see value in doing.
Cheers.
--
Felipe Contreras
prev parent reply other threads:[~2020-12-10 3:08 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-09 8:17 RFC: Modernizing the contept of plumbing v.s. porcelain Ævar Arnfjörð Bjarmason
2020-12-09 19:38 ` 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 [this message]
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='CAMP44s1bemXUC2wR-2X2-Pp+=OU-=UrMsSroCwqu5jZ0krAy0A@mail.gmail.com' \
--to=felipe.contreras@gmail.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
/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 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).