blob: 2438f76da05ebf013103a08962d634c4baa9ea15 [file] [log] [blame]
Junio C Hamano7fc9d692005-08-23 01:49:47 -07001git-stripspace(1)
2=================
3
4NAME
5----
Conrad Irwin497215d2011-12-12 15:52:51 -08006git-stripspace - Remove unnecessary whitespace
Junio C Hamano7fc9d692005-08-23 01:49:47 -07007
8
9SYNOPSIS
10--------
Martin von Zweigbergk7791a1d2011-07-01 22:38:26 -040011[verse]
Junio C Hamano33e8fc82015-10-16 11:27:42 -070012'git stripspace' [-s | --strip-comments]
13'git stripspace' [-c | --comment-lines]
Junio C Hamano7fc9d692005-08-23 01:49:47 -070014
15DESCRIPTION
16-----------
Conrad Irwin497215d2011-12-12 15:52:51 -080017
Junio C Hamano33e8fc82015-10-16 11:27:42 -070018Read text, such as commit messages, notes, tags and branch
19descriptions, from the standard input and clean it in the manner
20used by Git.
Conrad Irwin497215d2011-12-12 15:52:51 -080021
22With no arguments, this will:
23
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.
28
29In the case where the input consists entirely of whitespace characters, no
30output will be produced.
31
32*NOTE*: This is intended for cleaning metadata, prefer the `--whitespace=fix`
33mode of linkgit:git-apply[1] for correcting whitespace of patches or files in
34the repository.
Junio C Hamano7fc9d692005-08-23 01:49:47 -070035
36OPTIONS
37-------
Stephan Beyer32402402008-06-08 03:36:09 +020038-s::
39--strip-comments::
Junio C Hamanoeff80a92013-01-16 20:18:48 +010040 Skip and remove all lines starting with comment character (default '#').
41
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.
Johannes Schindelinf653aee2007-07-23 12:58:27 +010047
Conrad Irwin497215d2011-12-12 15:52:51 -080048EXAMPLES
49--------
50
51Given the following noisy input with '$' indicating the end of a line:
52
Jeff Kingad3967a2015-05-12 22:15:56 -040053---------
Conrad Irwin497215d2011-12-12 15:52:51 -080054|A brief introduction $
55| $
56|$
57|A new paragraph$
58|# with a commented-out line $
59|explaining lots of stuff.$
60|$
61|# An old paragraph, also commented-out. $
62| $
63|The end.$
64| $
65---------
66
67Use 'git stripspace' with no arguments to obtain:
68
Jeff Kingad3967a2015-05-12 22:15:56 -040069---------
Conrad Irwin497215d2011-12-12 15:52:51 -080070|A brief introduction$
71|$
72|A new paragraph$
73|# with a commented-out line$
74|explaining lots of stuff.$
75|$
76|# An old paragraph, also commented-out.$
77|$
78|The end.$
79---------
80
81Use 'git stripspace --strip-comments' to obtain:
82
Jeff Kingad3967a2015-05-12 22:15:56 -040083---------
Conrad Irwin497215d2011-12-12 15:52:51 -080084|A brief introduction$
85|$
86|A new paragraph$
87|explaining lots of stuff.$
88|$
89|The end.$
90---------
Junio C Hamano7fc9d692005-08-23 01:49:47 -070091
Junio C Hamano7fc9d692005-08-23 01:49:47 -070092GIT
93---
Christian Couder9e1f0a82008-06-06 09:07:32 +020094Part of the linkgit:git[1] suite