git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: git@vger.kernel.org
Cc: th.acker@arcor.de, bfields@citi.umich.edu,
	Junio C Hamano <gitster@pobox.com>,
	Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH] git(1): Define "porcelain commands"
Date: Sat, 25 Sep 2021 19:22:29 +0700	[thread overview]
Message-ID: <20210925122228.1090901-1-bagasdotme@gmail.com> (raw)

The description before list of porcelain commands doesn't tell what
"porcelain" term is, nor the accurate categorization (because it only
says that such commands are divided into main and ancillary commands,
although there are also tools for interacting with others and trio
reset-restore-revert).

Define the term and say the proper categorization in the description
paragraph.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/git.txt | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/Documentation/git.txt b/Documentation/git.txt
index 6dd241ef83..fb6d7d860d 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -221,8 +221,14 @@ We divide Git into high level ("porcelain") commands and low level
 High-level commands (porcelain)
 -------------------------------
 
-We separate the porcelain commands into the main commands and some
-ancillary user utilities.
+Porcelain commands are user-facing, high level command interface of
+Git. These are built from plumbing commands and expose SCM interface
+and human-friendly output. Most users run only porcelains unless they
+have absolute necessity for plumbing commands (e.g. scripting).
+
+The following description divides porcelain commands into main
+commands, ancillary utilities, tools for interacting with foreign SCM
+and email, and similarly-named commands for reverting changes.
 
 Main porcelain commands
 ~~~~~~~~~~~~~~~~~~~~~~~

base-commit: 99c99ed8259bf070cd8ae7b51a94904b7cf5c161
-- 
2.25.1


             reply	other threads:[~2021-09-25 12:22 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-25 12:22 Bagas Sanjaya [this message]
2021-09-25 16:36 ` [PATCH] git(1): Define "porcelain commands" Junio C Hamano

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

  List information: http://vger.kernel.org/majordomo-info.html

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

  git send-email \
    --in-reply-to=20210925122228.1090901-1-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=bfields@citi.umich.edu \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=th.acker@arcor.de \
    /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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).