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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxx>
---
 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




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux