Guilt v0.37-rc1
[guilt.git] / Documentation / guilt-new.txt
blob698dcb7d2cc6c77c71138e5791b3342dbc6b56a8
1 guilt-new(1)
2 ============
4 NAME
5 ----
6 guilt-new - Create a new patch
8 SYNOPSIS
9 --------
10 include::usage-guilt-new.txt[]
12 DESCRIPTION
13 -----------
14 Create a new patch and push it on top of the stack. An optional patch
15 description can be supplied either interactively on via the command line.
17 OPTIONS
18 -------
19 -f::
20         Force patch creation if there are unrefreshed changes. These changes
21         will get automatically imported into the new patch.
23 -s::
24         Add a Signed-off-by with your committer identifier string to the
25         patch message.
27 -e::
28         Edit the patch message interactively. This option can be combined
29         with -s to easily sign off on the patch.
31 -m <message>::
32         The "<message>" string will used as the commit message. This option
33         can be combined with -s to easily sign off on the patch.
35 <patchname>::
36         Name of the patch to create. This must be a legal relative pathname
37         string. For example, "foo", "foo/bar", and "foo/bar/foobar" are all
38         valid.
40 EXAMPLES
41 --------
43 Create a new patch called 'foobar':
45         $ guilt new foobar
47 Create a patch called 'foo' and supply a patch description interactively:
49         $ guilt new -e foo
51 Create a patch called 'bar' with a provided patch description and sign off
52 on the patch:
54         $ guilt new -s -m patch-fu bar
56 Author
57 ------
58 Written by Josef "Jeff" Sipek <jeffpc@josefsipek.net>
60 Documentation
61 -------------
62 Documentation by Josef "Jeff" Sipek <jeffpc@josefsipek.net>
64 include::footer.txt[]