diff options
author | Stewart Smith <stewart@linux.vnet.ibm.com> | 2016-07-27 17:43:05 +1000 |
---|---|---|
committer | Stewart Smith <stewart@linux.vnet.ibm.com> | 2016-08-02 17:31:12 +1000 |
commit | c90c25742ad3d41c66d88c22358ddd2a76194900 (patch) | |
tree | e2a0a86502224ae9acb462b7b98e0a772a1a30e3 /doc/stable-skiboot-rules.rst | |
parent | cce80be2fc7d9114ea0000349cc52f0947ea00f1 (diff) | |
download | skiboot-c90c25742ad3d41c66d88c22358ddd2a76194900.zip skiboot-c90c25742ad3d41c66d88c22358ddd2a76194900.tar.gz skiboot-c90c25742ad3d41c66d88c22358ddd2a76194900.tar.bz2 |
doc/*.rst: fix ReSTructured text syntax
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
Diffstat (limited to 'doc/stable-skiboot-rules.rst')
-rw-r--r-- | doc/stable-skiboot-rules.rst | 82 |
1 files changed, 49 insertions, 33 deletions
diff --git a/doc/stable-skiboot-rules.rst b/doc/stable-skiboot-rules.rst index 1db47a3..bf4f5f0 100644 --- a/doc/stable-skiboot-rules.rst +++ b/doc/stable-skiboot-rules.rst @@ -1,5 +1,5 @@ Stable Skiboot tree/releases ----------------------------- +============================ If you're at all familiar with the Linux kernel stable trees, this should seem fairly familiar. @@ -15,48 +15,64 @@ with my IBMer hat on, we'll maintain branches that we ship in products. What patches are accepted? -------------------------- -- Patches must be obviously correct and tested - - A Tested-by signoff is *important* -- A patch must fix a real bug -- No trivial patches, such fixups belong in main branch -- Not fix a purely theoretical problem unless you can prove how +* Patches must be obviously correct and tested + + * A Tested-by signoff is *important* +* A patch must fix a real bug +* No trivial patches, such fixups belong in main branch +* Not fix a purely theoretical problem unless you can prove how it's exploitable -- The patch, or an equivalent one, must already be in master - - Submitting to both at the same time is okay, but backporting is better +* The patch, or an equivalent one, must already be in master + + * Submitting to both at the same time is okay, but backporting is better HOWTO submit to stable ---------------------- Two ways: -1) Send patch to the skiboot@ list with "[PATCH stable]" in subject - - This targets the patch *ONLY* to the stable branch. - - Such commits will *NOT* be merged into master. - - Use this when: - a) cherry-picking a fix from master - b) fixing something that is only broken in stable - c) fix in stable needs to be completely different than in master +1. Send patch to the skiboot@ list with "[PATCH stable]" in subject + + * This targets the patch *ONLY* to the stable branch. + + * Such commits will *NOT* be merged into master. + * Use this when: + + a. cherry-picking a fix from master + b. fixing something that is only broken in stable + c. fix in stable needs to be completely different than in master + If b or c: explain why. - - If cherry-picking, include the following at the top of your - commit message: - commit <sha1> upstream. - - If the patch has been modified, explain why in description. - -2) Add "Cc: stable" above your Signed-off-by line when sending to skiboot@ - - This targets the patch to master and stable. - - You can target a patch to a specific stable tree with: - Cc: stable # 5.1.x + * If cherry-picking, include the following at the top of your + commit message: :: + + commit <sha1> upstream. + * If the patch has been modified, explain why in description. + +2. Add "Cc: stable" above your Signed-off-by line when sending to skiboot@ + + * This targets the patch to master and stable. + * You can target a patch to a specific stable tree with: :: + + Cc: stable # 5.1.x + and that will target it to the 5.1.x branch. - - You can ask for prerequisites to be cherry-picked: - Cc: stable # 5.1.x 55ae15b Ensure we run pollers in cpu_wait_job() - Cc: stable # 5.1.x + * You can ask for prerequisites to be cherry-picked: :: + + Cc: stable # 5.1.x 55ae15b Ensure we run pollers in cpu_wait_job() + Cc: stable # 5.1.x + Which means: - 1) please git cherry-pick 55ae15b - 2) then apply this patch to 5.1.x". + + 1. please ``git cherry-pick 55ae15b`` + 2. then apply this patch to 5.1.x". Trees ----- -- https://github.com/open-power/skiboot/tree/stable - git@github.com:open-power/skiboot.git (branches are skiboot-X.Y.x - e.g. skiboot-5.1.x) -- Some stable versions may last longer than others - - So there may be skiboot-5.1.x and skiboot-5.2.x actively maintained +* https://github.com/open-power/skiboot/tree/stable (or via ssh at ``git@github.com:open-power/skiboot.git`` ) + + * (branches are skiboot-X.Y.x - e.g. skiboot-5.1.x) + +* Some stable versions may last longer than others + + * So there may be skiboot-5.1.x and skiboot-5.2.x actively maintained and skiboot-5.1.x could possibly outlast skiboot-5.2.x |