diff options
| author | Vincent Ambo <Vincent Ambo> | 2020-01-11T23·36+0000 |
|---|---|---|
| committer | Vincent Ambo <Vincent Ambo> | 2020-01-11T23·36+0000 |
| commit | 1b593e1ea4d2af0f6444d9a7788d5d99abd6fde5 (patch) | |
| tree | e3accb9beed5c4c1b5a05c99db71ab2841f0ed04 /Documentation/git-stripspace.txt | |
Squashed 'third_party/git/' content from commit cb71568594
git-subtree-dir: third_party/git git-subtree-split: cb715685942260375e1eb8153b0768a376e4ece7
Diffstat (limited to 'Documentation/git-stripspace.txt')
| -rw-r--r-- | Documentation/git-stripspace.txt | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt new file mode 100644 index 000000000000..2438f76da05e --- /dev/null +++ b/Documentation/git-stripspace.txt @@ -0,0 +1,94 @@ +git-stripspace(1) +================= + +NAME +---- +git-stripspace - Remove unnecessary whitespace + + +SYNOPSIS +-------- +[verse] +'git stripspace' [-s | --strip-comments] +'git stripspace' [-c | --comment-lines] + +DESCRIPTION +----------- + +Read text, such as commit messages, notes, tags and branch +descriptions, from the standard input and clean it in the manner +used by Git. + +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:: + Skip and remove all lines starting with comment character (default '#'). + +-c:: +--comment-lines:: + Prepend comment character and blank to each line. Lines will automatically + be terminated with a newline. On empty lines, only the comment character + will be prepended. + +EXAMPLES +-------- + +Given the following noisy input with '$' indicating the end of a line: + +--------- +|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 +--- +Part of the linkgit:git[1] suite |