1 [[!meta title="Mastering the DragonFly git repository"]]
5 ## Clone the repository
7 Look at the [[download]] page on how to clone the DragonFly repository. ***Note***: Please use a git mirror to reduce the bandwidth on the main servers.
11 If you (as a non-developer) made some changes to the DragonFly source and want to get them included in the main repository, send your patches to `submit@lists.dragonflybsd.org`.
12 In order to be able to do that, you need to have yourself and the email address you are using registered with the <http://bugs.dragonflybsd.org/> bug/issue tracker; otherwise, your contribution will get silently dropped.
14 Git assists you in creating patches which are easy to handle for the developers.
17 **Note:** The change in this example is completely useless, it only serves demonstration purposes!
21 At first edit the files you want to change:
25 Then review your changes with `git diff`:
30 diff --git a/README b/README
31 index 495a262..6a95d1f 100644
34 @@ -59,7 +59,7 @@ lib System libraries
36 libexec System daemons.
38 -nrelease Framework for building the ***live*** CD image.
39 +nrelease Framework for building the ***live CD*** image.
44 If you are satisfied with your changes, commit them. **Note:** The first line of your commit message should describe your change in a small sentence. Add more details after one newline.
49 ".git/COMMIT_EDITMSG" 10L, 342C written
50 Created commit cbb871b: Change parentheses
51 1 files changed, 1 insertions(+), 1 deletions(-)
53 Now you can use `git format-patch` to generate a patch file. This file is ready for submission to submit@. `git format-patch` will generate one file for every commit you did.
57 > git format-patch origin/master
58 0001-Change-parentheses.patch
59 > cat 0001-Change-parentheses.patch
60 From cbb871b4588c695f000bc701b4f3c16a0a518991 Mon Sep 17 00:00:00 2001
61 From: Matthias Schmidt <matthiasdragonflybsd.org>
62 Date: Tue, 2 Dec 2008 09:54:47 +0100
63 Subject: [PATCH] Change parentheses
68 1 files changed, 1 insertions(+), 1 deletions(-)
72 diff --git a/README b/README
73 index 495a262..6a95d1f 100644
76 @@ -59,7 +59,7 @@ lib System libraries.
78 libexec System daemons.
80 -nrelease Framework for building the ***live*** CD image.
81 +nrelease Framework for building the ***live CD*** image.
89 Attach the generated files to a mail and submit it. Write some lines about your intention and why you changed what ...
93 ## Working with branches
95 It is **not** recommended to work directly in your **master** branch, except maybe for one-liners. Branches in git are very cheap, so just keep your **master** branch pure, and always work on a different local branch.
97 Say you want to work on a simple change. Just create a temporary branch, make the change and commit it.
101 > git checkout -b work # you're now in the work branch
105 Now, you can switch back to **master** , merge in the changes in your **work** branch and push away:
109 > git checkout master # you're now in the master branch
110 > git merge work # now master has your changes
112 Afterwards, you may (or not, if you want to do further development) want to delete the **work** branch by
117 For more complex changes, you probably want to create a longer-lived branch. For example
120 > git checkout -b myfeature
122 You can work in the **myfeature** branch until your feature is ready. You can commit there as often as you like. If your work goes on for a significant amount of time, you will want to merge with the upstream **master** from time to time. It is recommended that you use git rebase, so that the merge points won't show up in the repo history on crater (they don't really add much information). For this, you'd do:
125 > git checkout master
127 > git checkout myfeature
131 ## Push your work upstream
133 When you judge that your code is ready for inclusion in mainline, you can merge it into your local **master** branch and push away:
137 > git checkout master
138 > git merge myfeature
142 as the command will not push any branch that is not in the remote repository.