doc: describe git svn init --ignore-refs
[git/git-svn.git] / Documentation / git-stripspace.txt
blob2438f76da05ebf013103a08962d634c4baa9ea15
1 git-stripspace(1)
2 =================
4 NAME
5 ----
6 git-stripspace - Remove unnecessary whitespace
9 SYNOPSIS
10 --------
11 [verse]
12 'git stripspace' [-s | --strip-comments]
13 'git stripspace' [-c | --comment-lines]
15 DESCRIPTION
16 -----------
18 Read text, such as commit messages, notes, tags and branch
19 descriptions, from the standard input and clean it in the manner
20 used by Git.
22 With no arguments, this will:
24 - remove trailing whitespace from all lines
25 - collapse multiple consecutive empty lines into one empty line
26 - remove empty lines from the beginning and end of the input
27 - add a missing '\n' to the last line if necessary.
29 In the case where the input consists entirely of whitespace characters, no
30 output will be produced.
32 *NOTE*: This is intended for cleaning metadata, prefer the `--whitespace=fix`
33 mode of linkgit:git-apply[1] for correcting whitespace of patches or files in
34 the repository.
36 OPTIONS
37 -------
38 -s::
39 --strip-comments::
40         Skip and remove all lines starting with comment character (default '#').
42 -c::
43 --comment-lines::
44         Prepend comment character and blank to each line. Lines will automatically
45         be terminated with a newline. On empty lines, only the comment character
46         will be prepended.
48 EXAMPLES
49 --------
51 Given the following noisy input with '$' indicating the end of a line:
53 ---------
54 |A brief introduction   $
55 |   $
57 |A new paragraph$
58 |# with a commented-out line    $
59 |explaining lots of stuff.$
61 |# An old paragraph, also commented-out. $
62 |      $
63 |The end.$
64 |  $
65 ---------
67 Use 'git stripspace' with no arguments to obtain:
69 ---------
70 |A brief introduction$
72 |A new paragraph$
73 |# with a commented-out line$
74 |explaining lots of stuff.$
76 |# An old paragraph, also commented-out.$
78 |The end.$
79 ---------
81 Use 'git stripspace --strip-comments' to obtain:
83 ---------
84 |A brief introduction$
86 |A new paragraph$
87 |explaining lots of stuff.$
89 |The end.$
90 ---------
92 GIT
93 ---
94 Part of the linkgit:git[1] suite