git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Conrad Irwin <conrad.irwin@gmail.com>
To: git@vger.kernel.org
Cc: Conrad Irwin <conrad.irwin@gmail.com>
Subject: [PATCH] Update documentation for stripspace
Date: Sun, 11 Dec 2011 17:59:18 -0800	[thread overview]
Message-ID: <1323655158-5075-1-git-send-email-conrad.irwin@gmail.com> (raw)

Tell the user what this command is intended for, and expand the
description of what it does.

Stop referring to the input as <stream>, as this command reads the
entire input into memory before processing it.

Signed-off-by: Conrad Irwin <conrad.irwin@gmail.com>
---
 Documentation/git-stripspace.txt |   26 ++++++++++++++++++++------
 builtin/stripspace.c             |    2 +-
 2 files changed, 21 insertions(+), 7 deletions(-)

diff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt
index b78f031..6667d25 100644
--- a/Documentation/git-stripspace.txt
+++ b/Documentation/git-stripspace.txt
@@ -3,26 +3,40 @@ git-stripspace(1)
 
 NAME
 ----
-git-stripspace - Filter out empty lines
+git-stripspace - Remove unnecessary whitespace
 
 
 SYNOPSIS
 --------
 [verse]
-'git stripspace' [-s | --strip-comments] < <stream>
+'git stripspace' [-s | --strip-comments] < input
 
 DESCRIPTION
 -----------
-Remove multiple empty lines, and empty lines at beginning and end.
+
+Normalizes input in the manner used by 'git' for user-provided metadata such
+as commit messages, notes, tags and branch descriptions.
+
+When run with no arguments this:
+
+- removes trailing whitespace from all lines
+- collapses multiple consecutive empty lines into one empty line
+- removes blank lines from the beginning and end of the input
+- ensures the last line ends with exactly one '\n'.
+
+In the case where the input consists entirely of whitespace characters, no
+output will be produced.
+
+*NOTE*: This is intended for cleaning metadata, prefer the `--whitespace=fix`
+mode of linkgit:git-apply[1] for correcting whitespace of patches or files in
+the repository.
 
 OPTIONS
 -------
 -s::
 --strip-comments::
-	In addition to empty lines, also strip lines starting with '#'.
+	Also remove all lines starting with '#'.
 
-<stream>::
-	Byte stream to act on.
 
 GIT
 ---
diff --git a/builtin/stripspace.c b/builtin/stripspace.c
index 1288ffc..f16986c 100644
--- a/builtin/stripspace.c
+++ b/builtin/stripspace.c
@@ -75,7 +75,7 @@ int cmd_stripspace(int argc, const char **argv, const char *prefix)
 				!strcmp(argv[1], "--strip-comments")))
 		strip_comments = 1;
 	else if (argc > 1)
-		usage("git stripspace [-s | --strip-comments] < <stream>");
+		usage("git stripspace [-s | --strip-comments] < input");
 
 	if (strbuf_read(&buf, 0, 1024) < 0)
 		die_errno("could not read the input");
-- 
1.7.8.164.g00d7e

             reply	other threads:[~2011-12-12  1:59 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-12-12  1:59 Conrad Irwin [this message]
2011-12-12  6:41 ` [PATCH] Update documentation for stripspace Junio C Hamano
2011-12-12 22:28   ` [PATCH v2] " Conrad Irwin
2011-12-12 23:41     ` Junio C Hamano
2011-12-12 23:52       ` [PATCH] " Conrad Irwin
2011-12-13  6:28     ` [PATCH v2] " Frans Klaver

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=1323655158-5075-1-git-send-email-conrad.irwin@gmail.com \
    --to=conrad.irwin@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).