Guilt v0.35
[guilt.git] / Documentation / guilt-new.1
blobec45050b6800065a35a58f6a281d7ba2c5ecadec
1 '\" t
2 .\"     Title: guilt-new
3 .\"    Author: [see the "Author" section]
4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5 .\"      Date: 07/17/2011
6 .\"    Manual: Guilt Manual
7 .\"    Source: Guilt v0.35
8 .\"  Language: English
9 .\"
10 .TH "GUILT\-NEW" "1" "07/17/2011" "Guilt v0\&.35" "Guilt 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 guilt-new \- Create a new patch
32 .SH "SYNOPSIS"
33 \fIguilt\-new\fR [\-f] [\-s] [\-e|\-m message] <patchname>
34 .SH "DESCRIPTION"
35 Create a new patch and push it on top of the stack\&. An optional patch description can be supplied either interactively on via the command line\&.
36 .SH "OPTIONS"
37 .PP
38 \-f
39 .RS 4
40 Force patch creation if there are unrefreshed changes\&. These changes will get automatically imported into the new patch\&.
41 .RE
42 .PP
43 \-s
44 .RS 4
45 Add a Signed\-off\-by with your committer identifier string to the patch message\&.
46 .RE
47 .PP
48 \-e
49 .RS 4
50 Edit the patch message interactively\&. This option can be combined with \-s to easily sign off on the patch\&.
51 .RE
52 .PP
53 \-m <message>
54 .RS 4
55 The "<message>" string will used as the commit message\&. This option can be combined with \-s to easily sign off on the patch\&.
56 .RE
57 .PP
58 <patchname>
59 .RS 4
60 Name of the patch to create\&. This must be a legal relative pathname string\&. For example, "foo", "foo/bar", and "foo/bar/foobar" are all valid\&.
61 .RE
62 .SH "EXAMPLES"
63 Create a new patch called \fIfoobar\fR:
65 .sp
66 .if n \{\
67 .RS 4
68 .\}
69 .nf
70 $ guilt\-new foobar
71 .fi
72 .if n \{\
73 .RE
74 .\}
75 .sp
76 Create a patch called \fIfoo\fR and supply a patch description interactively:
78 .sp
79 .if n \{\
80 .RS 4
81 .\}
82 .nf
83 $ guilt\-new \-e foo
84 .fi
85 .if n \{\
86 .RE
87 .\}
88 .sp
89 Create a patch called \fIbar\fR with a provided patch description and sign off on the patch:
91 .sp
92 .if n \{\
93 .RS 4
94 .\}
95 .nf
96 $ guilt\-new \-s \-m patch\-fu bar
97 .fi
98 .if n \{\
99 .RE
101 .SH "AUTHOR"
102 Written by Josef "Jeff" Sipek <\m[blue]\fBjeffpc@josefsipek\&.net\fR\m[]\&\s-2\u[1]\d\s+2>
103 .SH "DOCUMENTATION"
104 Documentation by Josef "Jeff" Sipek <\m[blue]\fBjeffpc@josefsipek\&.net\fR\m[]\&\s-2\u[1]\d\s+2>
105 .SH "GUILT"
106 Part of the \fBguilt\fR(7) suite (Generated for Guilt v0\&.35)
107 .SH "NOTES"
108 .IP " 1." 4
109 jeffpc@josefsipek.net
110 .RS 4
111 \%mailto:jeffpc@josefsipek.net