Documentation / git-format-patch.txton commit Documentation: git-add -- do not say "cache", add examples. (810bf1f)
   1git-format-patch(1)
   2===================
   3
   4NAME
   5----
   6git-format-patch - Prepare patches for e-mail submission.
   7
   8
   9SYNOPSIS
  10--------
  11'git-format-patch' [-n][-o <dir>|--stdout][-k][--mbox][--diff-options] <his> [<mine>]
  12
  13DESCRIPTION
  14-----------
  15Prepare each commit with its patch since <mine> head forked from
  16<his> head, one file per patch, for e-mail submission.  Each
  17output file is numbered sequentially from 1, and uses the first
  18line of the commit message (massaged for pathname safety) as the
  19filename.
  20
  21When -o is specified, output files are created in that
  22directory; otherwise in the current working directory.
  23
  24When -n is specified, instead of "[PATCH] Subject", the first
  25line is formatted as "[PATCH N/M] Subject", unless you have only
  26one patch.
  27
  28When --mbox is specified, the output is formatted to resemble
  29UNIX mailbox format, and can be concatenated together for
  30processing with applymbox.
  31
  32
  33OPTIONS
  34-------
  35-o <dir>::
  36        Use <dir> to store the resulting files, instead of the
  37        current working directory.
  38
  39-n::
  40        Name output in '[PATCH n/m]' format.
  41
  42-k::
  43        Do not strip/add '[PATCH]' from the first line of the
  44        commit log message.
  45
  46--author, --date::
  47        Output From: and Date: headers for commits made by
  48        yourself as well.  Usually these are output only for
  49        commits made by people other than yourself.
  50
  51--mbox::
  52        Format the output files for closer to mbox format by
  53        adding a phony Unix "From " line, so they can be
  54        concatenated together and fed to `git-applymbox`.
  55        Implies --author and --date.
  56
  57--stdout::
  58        This flag generates the mbox formatted output to the
  59        standard output, instead of saving them into a file per
  60        patch and implies --mbox.
  61
  62Author
  63------
  64Written by Junio C Hamano <junkio@cox.net>
  65
  66Documentation
  67--------------
  68Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
  69
  70GIT
  71---
  72Part of the gitlink:git[7] suite
  73