Documentation/git-stripspace.txt

   1 git-stripspace(1)
   2 =================
   3
   4 NAME
   5 ----
   6 git-stripspace - Remove unnecessary whitespace
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git stripspace' [-s | --strip-comments] < input
  13
  14 DESCRIPTION
  15 -----------
  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.
  33
  34 OPTIONS
  35 -------
  36 -s::
  37 --strip-comments::
  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:
  44
  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 ---------
  83
  84 GIT
  85 ---
  86 Part of the linkgit:git[1] suite