Document -<n> for git-format-patch
[git] / Documentation / git-cvsexportcommit.txt
1 git-cvsexportcommit(1)
2 ======================
3
4 NAME
5 ----
6 git-cvsexportcommit - Export a single commit to a CVS checkout
7
8
9 SYNOPSIS
10 --------
11 'git-cvsexportcommit' [-h] [-v] [-c] [-P] [-p] [-a] [-d cvsroot] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID
12
13
14 DESCRIPTION
15 -----------
16 Exports a commit from GIT to a CVS checkout, making it easier
17 to merge patches from a git repository into a CVS repository. 
18
19 Execute it from the root of the CVS working copy. GIT_DIR must be defined. 
20 See examples below.
21
22 It does its best to do the safe thing, it will check that the files are 
23 unchanged and up to date in the CVS checkout, and it will not autocommit 
24 by default.
25
26 Supports file additions, removals, and commits that affect binary files.
27
28 If the commit is a merge commit, you must tell git-cvsexportcommit what parent
29 should the changeset be done against. 
30
31 OPTIONS
32 -------
33
34 -c::
35         Commit automatically if the patch applied cleanly. It will not
36         commit if any hunks fail to apply or there were other problems.
37
38 -p::
39         Be pedantic (paranoid) when applying patches. Invokes patch with
40         --fuzz=0
41
42 -a::
43         Add authorship information. Adds Author line, and Committer (if
44         different from Author) to the message.
45
46 -d::
47         Set an alternative CVSROOT to use.  This corresponds to the CVS
48         -d parameter.  Usually users will not want to set this, except
49         if using CVS in an asymmetric fashion.
50
51 -f::
52         Force the merge even if the files are not up to date.
53
54 -P::
55         Force the parent commit, even if it is not a direct parent.
56
57 -m::
58         Prepend the commit message with the provided prefix. 
59         Useful for patch series and the like.
60
61 -v::
62         Verbose.
63
64 EXAMPLES
65 --------
66
67 Merge one patch into CVS::
68 +
69 ------------
70 $ export GIT_DIR=~/project/.git
71 $ cd ~/project_cvs_checkout
72 $ git-cvsexportcommit -v <commit-sha1>
73 $ cvs commit -F .mgs <files> 
74 ------------
75
76 Merge pending patches into CVS automatically -- only if you really know what you are doing::
77 +
78 ------------
79 $ export GIT_DIR=~/project/.git
80 $ cd ~/project_cvs_checkout
81 $ git-cherry cvshead myhead | sed -n 's/^+ //p' | xargs -l1 git-cvsexportcommit -c -p -v
82 ------------
83
84 Author
85 ------
86 Written by Martin Langhoff <martin@catalyst.net.nz>
87
88 Documentation
89 --------------
90 Documentation by Martin Langhoff <martin@catalyst.net.nz>
91
92 GIT
93 ---
94 Part of the gitlink:git[7] suite
95