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

[PATCH] git(1): Define "porcelain commands"

From
Bagas Sanjaya <bagasdotme@gmail.com>
Date
Sep 25, 2021, 12:22 UTC
Message-ID
<20210925122228.1090901-1-bagasdotme@gmail.com>

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
Next: Junio C Hamano
Message 1 of 2 in “git(1): Define "porcelain commands"”
  1. git(1): Define "porcelain commands"Bagas Sanjaya, Sep 25, 2021
  2. Junio C HamanoSep 25, 2021

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.