diff options
author | Junio C Hamano <gitster@pobox.com> | 2011-12-21 14:30:44 -0800 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2011-12-21 14:30:44 -0800 |
commit | 0df9271a3b43155a867f5785c830fb58860b2a6e (patch) | |
tree | 57a8246f0d869e5863de89545c036ed26a19006d /git-stripspace.txt | |
parent | e107628da85da6ea514b023fcef4ccb7327e99d0 (diff) | |
download | git-htmldocs-0df9271a3b43155a867f5785c830fb58860b2a6e.tar.gz |
Autogenerated HTML docs for v1.7.8.1-281-ge443b
Diffstat (limited to 'git-stripspace.txt')
-rw-r--r-- | git-stripspace.txt | 69 |
1 files changed, 63 insertions, 6 deletions
diff --git a/git-stripspace.txt b/git-stripspace.txt index b78f031cd..a80d94650 100644 --- a/git-stripspace.txt +++ b/git-stripspace.txt @@ -3,26 +3,83 @@ 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. + +Clean the input in the manner used by 'git' for text such as commit +messages, notes, tags and branch descriptions. + +With no arguments, this will: + +- remove trailing whitespace from all lines +- collapse multiple consecutive empty lines into one empty line +- remove empty lines from the beginning and end of the input +- add a missing '\n' to the last line if necessary. + +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 '#'. + Skip and remove all lines starting with '#'. + +EXAMPLES +-------- + +Given the following noisy input with '$' indicating the end of a line: -<stream>:: - Byte stream to act on. +-------- +|A brief introduction $ +| $ +|$ +|A new paragraph$ +|# with a commented-out line $ +|explaining lots of stuff.$ +|$ +|# An old paragraph, also commented-out. $ +| $ +|The end.$ +| $ +--------- + +Use 'git stripspace' with no arguments to obtain: + +-------- +|A brief introduction$ +|$ +|A new paragraph$ +|# with a commented-out line$ +|explaining lots of stuff.$ +|$ +|# An old paragraph, also commented-out.$ +|$ +|The end.$ +--------- + +Use 'git stripspace --strip-comments' to obtain: + +-------- +|A brief introduction$ +|$ +|A new paragraph$ +|explaining lots of stuff.$ +|$ +|The end.$ +--------- GIT --- |