Add Yasushi Shoji to the list of FSF-signed contributors
[worg.git] / worg-git-advanced.org
1 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
2 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
3 #+TITLE:      Advanced usage of git for Worg
4 #+AUTHOR:     Worg people
5 #+TAGS:       Write(w) Update(u) Fix(f) Check(c)
6 #+EMAIL:      mdl AT imapmail DOT org
7 #+LANGUAGE:   en
8 #+PRIORITIES: A C B
9 #+CATEGORY:   worg
10 #+OPTIONS:    H:3 num:nil toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
11
12 [[file:index.org][{Back to Worg's index}]]
13
14 This page answer various questions on how to use git for editing Worg.
15
16 If you're looking for a quick introduction on how to use git to
17 contribute to Worg, please read [[file:worg-git.org][this page]] instead.
18
19 * Shall I create a branch?
20
21 Yes, it's cleaner.
22
23 : ~$ git checkout -b t/my-topic-branch 
24 : ~$ git commit -a -m "A line describing my change"
25
26 From here, either you are a registered Worg contributor and want to
27 merge the branch before pushing to Worg's repo, either you just want to
28 send patches.
29
30 If you want to merge the branch and push to Worg:
31
32 : ~$ git checkout master
33 : ~$ git merge t/my-topic-branch
34 : ~$ git push
35
36 If you just want to send patches, see below.
37
38 When you're done with a branch, you can delete it with:
39
40 : ~$ git branch -D t/my-topic-branch
41
42 * I just want to send patches!
43
44 It's okay.
45
46 You can either either prepare patches with [[http://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html][git format-patch]] or send them
47 directly with [[http://www.kernel.org/pub/software/scm/git/docs/git-send-email.html][git send-email]].
48
49 ** Use git format-patch
50
51 We suppose you are in a branch called =t/my-topic-branch= and that you
52 committed your changes.
53
54 : ~$ git format-patch origin
55
56 will create a separate mbox file for each commit, ready to be sent.
57
58 : ~$ git format-patch -3
59
60 will create three separate files for the last three commits you did in
61 this branch.
62
63 See the documentation of [[http://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html][git format-patch]] to set the value of the
64 various headers.
65
66 ** Use git send-email
67
68 If your Worg repo is in =~/git/Worg= and if your emails are sent through
69 the =sendmail= command, please add this to =~/git/Worg/.git/config=:
70
71 : [sendemail]
72 :       to = bzg AT gnu DOT org
73
74 (Replace =AT= and =DOT= by the =@= and =.=)
75
76 Then the =git send-mail= command with send the patches directly to bzg
77 (Bastien).
78
79 Use =git send-mail= like this:
80
81 : ~$ git send-mail --annotate -3
82
83 to review and annotate the last three commits in the current branch
84 before sending them.
85
86
87
88
89
90