2005-08-23 08:49:47 +00:00
|
|
|
git-stripspace(1)
|
|
|
|
|
=================
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
2011-12-12 23:52:51 +00:00
|
|
|
git-stripspace - Remove unnecessary whitespace
|
2005-08-23 08:49:47 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2011-07-02 02:38:26 +00:00
|
|
|
[verse]
|
usage: do not insist that standard input must come from a file
The synopsys text and the usage string of subcommands that read list
of things from the standard input are often shown like this:
git gostak [--distim] < <list-of-doshes>
This is problematic in a number of ways:
* The way to use these commands is more often to feed them the
output from another command, not feed them from a file.
* Manual pages outside Git, commands that operate on the data read
from the standard input, e.g "sort", "grep", "sed", etc., are not
described with such a "< redirection-from-file" in their synopsys
text. Our doing so introduces inconsistency.
* We do not insist on where the output should go, by saying
git gostak [--distim] < <list-of-doshes> > <output>
* As it is our convention to enclose placeholders inside <braket>,
the redirection operator followed by a placeholder filename
becomes very hard to read, both in the documentation and in the
help text.
Let's clean them all up, after making sure that the documentation
clearly describes the modes that take information from the standard
input and what kind of things are expected on the input.
[jc: stole example for fmt-merge-msg from Jonathan]
Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2015-10-16 18:27:42 +00:00
|
|
|
'git stripspace' [-s | --strip-comments]
|
|
|
|
|
'git stripspace' [-c | --comment-lines]
|
2005-08-23 08:49:47 +00:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
2011-12-12 23:52:51 +00:00
|
|
|
|
usage: do not insist that standard input must come from a file
The synopsys text and the usage string of subcommands that read list
of things from the standard input are often shown like this:
git gostak [--distim] < <list-of-doshes>
This is problematic in a number of ways:
* The way to use these commands is more often to feed them the
output from another command, not feed them from a file.
* Manual pages outside Git, commands that operate on the data read
from the standard input, e.g "sort", "grep", "sed", etc., are not
described with such a "< redirection-from-file" in their synopsys
text. Our doing so introduces inconsistency.
* We do not insist on where the output should go, by saying
git gostak [--distim] < <list-of-doshes> > <output>
* As it is our convention to enclose placeholders inside <braket>,
the redirection operator followed by a placeholder filename
becomes very hard to read, both in the documentation and in the
help text.
Let's clean them all up, after making sure that the documentation
clearly describes the modes that take information from the standard
input and what kind of things are expected on the input.
[jc: stole example for fmt-merge-msg from Jonathan]
Helped-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2015-10-16 18:27:42 +00:00
|
|
|
Read text, such as commit messages, notes, tags and branch
|
|
|
|
|
descriptions, from the standard input and clean it in the manner
|
|
|
|
|
used by Git.
|
2011-12-12 23:52:51 +00:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2023-10-08 06:45:22 +00:00
|
|
|
*NOTE*: This is intended for cleaning metadata. Prefer the `--whitespace=fix`
|
2011-12-12 23:52:51 +00:00
|
|
|
mode of linkgit:git-apply[1] for correcting whitespace of patches or files in
|
|
|
|
|
the repository.
|
2005-08-23 08:49:47 +00:00
|
|
|
|
|
|
|
|
OPTIONS
|
|
|
|
|
-------
|
2008-06-08 01:36:09 +00:00
|
|
|
-s::
|
|
|
|
|
--strip-comments::
|
2023-10-08 06:45:17 +00:00
|
|
|
Skip and remove all lines starting with a comment character (default '#').
|
2013-01-16 19:18:48 +00:00
|
|
|
|
|
|
|
|
-c::
|
|
|
|
|
--comment-lines::
|
2023-10-08 06:45:03 +00:00
|
|
|
Prepend the comment character and a blank space to each line. Lines will automatically
|
2013-01-16 19:18:48 +00:00
|
|
|
be terminated with a newline. On empty lines, only the comment character
|
|
|
|
|
will be prepended.
|
2011-12-12 23:52:51 +00:00
|
|
|
|
|
|
|
|
EXAMPLES
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
Given the following noisy input with '$' indicating the end of a line:
|
2007-07-23 11:58:27 +00:00
|
|
|
|
2015-05-13 02:15:56 +00:00
|
|
|
---------
|
2011-12-12 23:52:51 +00:00
|
|
|
|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:
|
|
|
|
|
|
2015-05-13 02:15:56 +00:00
|
|
|
---------
|
2011-12-12 23:52:51 +00:00
|
|
|
|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:
|
|
|
|
|
|
2015-05-13 02:15:56 +00:00
|
|
|
---------
|
2011-12-12 23:52:51 +00:00
|
|
|
|A brief introduction$
|
|
|
|
|
|$
|
|
|
|
|
|A new paragraph$
|
|
|
|
|
|explaining lots of stuff.$
|
|
|
|
|
|$
|
|
|
|
|
|The end.$
|
|
|
|
|
---------
|
2005-08-23 08:49:47 +00:00
|
|
|
|
|
|
|
|
GIT
|
|
|
|
|
---
|
2008-06-06 07:07:32 +00:00
|
|
|
Part of the linkgit:git[1] suite
|