man1/git-stripspace.1

   1 '\" t
   2 .\"     Title: git-stripspace
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2024-04-10
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.44.0.568.g436d4e5b14
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-STRIPSPACE" "1" "2024\-04\-10" "Git 2\&.44\&.0\&.568\&.g436d4e" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-stripspace \- Remove unnecessary whitespace
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit stripspace\fR [\-s | \-\-strip\-comments]
  36 \fIgit stripspace\fR [\-c | \-\-comment\-lines]
  37 .fi
  38 .sp
  39 .SH "DESCRIPTION"
  40 .sp
  41 Read text, such as commit messages, notes, tags and branch descriptions, from the standard input and clean it in the manner used by Git\&.
  42 .sp
  43 With no arguments, this will:
  44 .sp
  45 .RS 4
  46 .ie n \{\
  47 \h'-04'\(bu\h'+03'\c
  48 .\}
  49 .el \{\
  50 .sp -1
  51 .IP \(bu 2.3
  52 .\}
  53 remove trailing whitespace from all lines
  54 .RE
  55 .sp
  56 .RS 4
  57 .ie n \{\
  58 \h'-04'\(bu\h'+03'\c
  59 .\}
  60 .el \{\
  61 .sp -1
  62 .IP \(bu 2.3
  63 .\}
  64 collapse multiple consecutive empty lines into one empty line
  65 .RE
  66 .sp
  67 .RS 4
  68 .ie n \{\
  69 \h'-04'\(bu\h'+03'\c
  70 .\}
  71 .el \{\
  72 .sp -1
  73 .IP \(bu 2.3
  74 .\}
  75 remove empty lines from the beginning and end of the input
  76 .RE
  77 .sp
  78 .RS 4
  79 .ie n \{\
  80 \h'-04'\(bu\h'+03'\c
  81 .\}
  82 .el \{\
  83 .sp -1
  84 .IP \(bu 2.3
  85 .\}
  86 add a missing
  87 \fI\en\fR
  88 to the last line if necessary\&.
  89 .RE
  90 .sp
  91 In the case where the input consists entirely of whitespace characters, no output will be produced\&.
  92 .sp
  93 \fBNOTE\fR: This is intended for cleaning metadata\&. Prefer the \fB\-\-whitespace=fix\fR mode of \fBgit-apply\fR(1) for correcting whitespace of patches or files in the repository\&.
  94 .SH "OPTIONS"
  95 .PP
  96 \-s, \-\-strip\-comments
  97 .RS 4
  98 Skip and remove all lines starting with a comment character (default
  99 \fI#\fR)\&.
 100 .RE
 101 .PP
 102 \-c, \-\-comment\-lines
 103 .RS 4
 104 Prepend the comment character and a blank space to each line\&. Lines will automatically be terminated with a newline\&. On empty lines, only the comment character will be prepended\&.
 105 .RE
 106 .SH "EXAMPLES"
 107 .sp
 108 Given the following noisy input with \fI$\fR indicating the end of a line:
 109 .sp
 110 .if n \{\
 111 .RS 4
 112 .\}
 113 .nf
 114 |A brief introduction   $
 115 |   $
 116 |$
 117 |A new paragraph$
 118 |# with a commented\-out line    $
 119 |explaining lots of stuff\&.$
 120 |$
 121 |# An old paragraph, also commented\-out\&. $
 122 |      $
 123 |The end\&.$
 124 |  $
 125 .fi
 126 .if n \{\
 127 .RE
 128 .\}
 129 .sp
 130 .sp
 131 Use \fIgit stripspace\fR with no arguments to obtain:
 132 .sp
 133 .if n \{\
 134 .RS 4
 135 .\}
 136 .nf
 137 |A brief introduction$
 138 |$
 139 |A new paragraph$
 140 |# with a commented\-out line$
 141 |explaining lots of stuff\&.$
 142 |$
 143 |# An old paragraph, also commented\-out\&.$
 144 |$
 145 |The end\&.$
 146 .fi
 147 .if n \{\
 148 .RE
 149 .\}
 150 .sp
 151 .sp
 152 Use \fIgit stripspace \-\-strip\-comments\fR to obtain:
 153 .sp
 154 .if n \{\
 155 .RS 4
 156 .\}
 157 .nf
 158 |A brief introduction$
 159 |$
 160 |A new paragraph$
 161 |explaining lots of stuff\&.$
 162 |$
 163 |The end\&.$
 164 .fi
 165 .if n \{\
 166 .RE
 167 .\}
 168 .sp
 169 .SH "GIT"
 170 .sp
 171 Part of the \fBgit\fR(1) suite