]>
Commit | Line | Data |
---|---|---|
7fc9d69f JH |
1 | git-stripspace(1) |
2 | ================= | |
3 | ||
4 | NAME | |
5 | ---- | |
497215d8 | 6 | git-stripspace - Remove unnecessary whitespace |
7fc9d69f JH |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
7791a1d9 | 11 | [verse] |
497215d8 | 12 | 'git stripspace' [-s | --strip-comments] < input |
7fc9d69f JH |
13 | |
14 | DESCRIPTION | |
15 | ----------- | |
497215d8 CI |
16 | |
17 | Clean the input in the manner used by 'git' for text such as commit | |
18 | messages, notes, tags and branch descriptions. | |
19 | ||
20 | With no arguments, this will: | |
21 | ||
22 | - remove trailing whitespace from all lines | |
23 | - collapse multiple consecutive empty lines into one empty line | |
24 | - remove empty lines from the beginning and end of the input | |
25 | - add a missing '\n' to the last line if necessary. | |
26 | ||
27 | In the case where the input consists entirely of whitespace characters, no | |
28 | output will be produced. | |
29 | ||
30 | *NOTE*: This is intended for cleaning metadata, prefer the `--whitespace=fix` | |
31 | mode of linkgit:git-apply[1] for correcting whitespace of patches or files in | |
32 | the repository. | |
7fc9d69f JH |
33 | |
34 | OPTIONS | |
35 | ------- | |
3240240f SB |
36 | -s:: |
37 | --strip-comments:: | |
497215d8 CI |
38 | Skip and remove all lines starting with '#'. |
39 | ||
40 | EXAMPLES | |
41 | -------- | |
42 | ||
43 | Given the following noisy input with '$' indicating the end of a line: | |
f653aee5 | 44 | |
497215d8 CI |
45 | -------- |
46 | |A brief introduction $ | |
47 | | $ | |
48 | |$ | |
49 | |A new paragraph$ | |
50 | |# with a commented-out line $ | |
51 | |explaining lots of stuff.$ | |
52 | |$ | |
53 | |# An old paragraph, also commented-out. $ | |
54 | | $ | |
55 | |The end.$ | |
56 | | $ | |
57 | --------- | |
58 | ||
59 | Use 'git stripspace' with no arguments to obtain: | |
60 | ||
61 | -------- | |
62 | |A brief introduction$ | |
63 | |$ | |
64 | |A new paragraph$ | |
65 | |# with a commented-out line$ | |
66 | |explaining lots of stuff.$ | |
67 | |$ | |
68 | |# An old paragraph, also commented-out.$ | |
69 | |$ | |
70 | |The end.$ | |
71 | --------- | |
72 | ||
73 | Use 'git stripspace --strip-comments' to obtain: | |
74 | ||
75 | -------- | |
76 | |A brief introduction$ | |
77 | |$ | |
78 | |A new paragraph$ | |
79 | |explaining lots of stuff.$ | |
80 | |$ | |
81 | |The end.$ | |
82 | --------- | |
7fc9d69f | 83 | |
7fc9d69f JH |
84 | GIT |
85 | --- | |
9e1f0a85 | 86 | Part of the linkgit:git[1] suite |