[PATCH] Update documentation for stripspace
- From
Conrad Irwin <conrad.irwin@gmail.com>
- Date
- Dec 12, 2011, 01:59 UTC
- Message-ID
- <1323655158-5075-1-git-send-email-conrad.irwin@gmail.com>
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