summaryrefslogtreecommitdiff
path: root/Documentation/git-stripspace.txt
blob: c87bfcb674b9a1026ab0d7b8e4907d538c99c7e5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
git-stripspace(1)
=================
 
NAME
----
git-stripspace - Remove unnecessary whitespace
 
 
SYNOPSIS
--------
[verse]
'git stripspace' [-s | --strip-comments] < input
 
DESCRIPTION
-----------
 
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::
	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