aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorColin Guthrie <colin@mageia.org>2013-08-02 11:03:36 +0100
committerColin Guthrie <colin@mageia.org>2013-08-02 11:03:36 +0100
commit8b81da1b7531ba178f30bab0987e0f07a208e684 (patch)
treee3159c1f0e0b0568166cd0fc13f246d34af19e08
parent81075b595a96238b833ca90429002a70f3df7fd9 (diff)
downloadinitscripts-8b81da1b7531ba178f30bab0987e0f07a208e684.tar
initscripts-8b81da1b7531ba178f30bab0987e0f07a208e684.tar.gz
initscripts-8b81da1b7531ba178f30bab0987e0f07a208e684.tar.bz2
initscripts-8b81da1b7531ba178f30bab0987e0f07a208e684.tar.xz
initscripts-8b81da1b7531ba178f30bab0987e0f07a208e684.zip
Update Mageia docs
-rw-r--r--README.md19
1 files changed, 10 insertions, 9 deletions
diff --git a/README.md b/README.md
index cfa516ef..9b680155 100644
--- a/README.md
+++ b/README.md
@@ -28,11 +28,12 @@ Once it's cloned, you need to then add a remote for *our* fork:
$ cd initscripts
$ git remote add mga ssh://git@git.mageia.org/software/forks/initscripts
-And once you have that cloned, you should setup a local tracking branch for our main development branch which is named after the current stable distro version + 1:
+And once you have that cloned, you should setup a local tracking branch for our main development branch which is named simple *distro/mga*:
- $ git checkout -t mga/distro/mga4
+ $ git checkout -t mga/distro/mga
-Note: It is strongly recommended to install the *git-prompt* package to see which branch you are currently using.
+* Note 1: The branches for stable distro releases are named *distro/mga1*, *distro/mga2* etc.
+* Note 2: It is strongly recommended to install the *git-prompt* package to see which branch you are currently using.
### Merging with upstream
@@ -52,7 +53,7 @@ You can then push this to us quite happily:
$ git push mga master
$ git push mga --tags
-**Important Note**: Keep in mind that our master branch should just be a mirror of Fedora's. We should not put any of our own changes on this branch.
+* **Important Note**: Keep in mind that our master branch should just be a mirror of Fedora's. We should not put any of our own changes on this branch.
#### Merging
@@ -71,9 +72,9 @@ If you have decided to revert a file to the upstream version in your commit, ple
#### Super patch
Periodically, we will generate a **super patch** containing all our changes. This patch is generated from the upstream tag of the tarball we are using and our current HEAD. It is generated via a command similar to:
- $ git diff initscripts-9.48-1..mga/distro/mga4 | xz >initscripts-mgaconf.patch.xz
+ $ git diff initscripts-9.48-1..mga/distro/mga | xz >initscripts-mgaconf.patch.xz
-Note that the *upstream* branch for *distro/mga4* is used (as it's prefixed with the remote name *mga/*). This is because you should be careful to only generate the super patch from changes you **have already pushed**. If you do not do this other contributors may not be able to verify your patch and some commits may even be lost. You have been warned!
+* Note that the *upstream* branch for *distro/mga* is used (as it's prefixed with the remote name *mga/*). This is because you should be careful to only generate the super patch from changes you **have already pushed**. If you do not do this other contributors may not be able to verify your patch and some commits may even be lost. You have been warned!
Once you have generated the super patch you should note the sha1 of the the current head and include it as a comment in the initscripts.spec file.
@@ -83,14 +84,14 @@ In order to cut down on the number of times we regenerate the super patch we wil
To generate the incremental patches take the sha1 sum as noted in the initscripts.spec and run the following command:
- $ git format-patch --start-number 100 SHA1..mga/distro/mga4
+ $ git format-patch --start-number 100 SHA1..mga/distro/mga
-Note that I've used the full remote branch name here too which means changes have to be pushed first, but if you are creating a package for testing you can of course just use your local branch.
+* Note: that I've used the full remote branch name here too which means changes have to be pushed first, but if you are creating a package for testing you can of course just use your local branch.
### Pushing changes
When you are happy with your changes you should push them. To do this type:
- $ git push mga distro/mga4
+ $ git push mga distro/mga
You can adjust this accordingly to match various git config settings as you see fit.