Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

PATCHES: update the patch howto

  • Loading branch information...
commit 93b2499ad667e388478a92fd51ba4f3a22be996b 1 parent 8bb6621
@gxben gxben authored
Showing with 19 additions and 33 deletions.
  1. +19 −33 PATCHES
View
52 PATCHES
@@ -1,16 +1,3 @@
-
- ooooo oo o o oo o
- M" "Mo Mo oM" M Mo oM"
- M oM""Mo oM""Mo "Mo" Mo"""o oM""Mo "Mo"
- M """M MooooMM MooooMM oMMo M "M M M oMMo
- "o oM M o M o oM Mo M oM M M oM Mo
- "MoooM"M "MooM" "MooM" M" "M M"ooo" "MooM" M" "M
-
-
-
-| SENDING PATCHES
-| ~~~~~~~~~~~~~~~
-
We know our rules place a burden on you, but rest assured that maintaining a
big and complex software project is even harder, so please accept our rules.
We cannot afford to spend our time fixing buggy, broken or outdated patches.
@@ -21,7 +8,7 @@ When sending us patches, please follow the rules below :
1. Accept the license.
- The GeeXboX code is licensed under GPL and most of its components are
+ The OpenBricks code is licensed under GPL and most of its components are
licensed the same way (some others might be LPGL or BSD). From the moment
you send a patch, you'll have to accept the original license of the file
you're modifying. You have no right to change the distribution license
@@ -37,16 +24,15 @@ When sending us patches, please follow the rules below :
3. Always make patches against the development version.
When doing a patch, please always do it against one of the development
- branches (ideally geexbox mercurial branch). Check on the website's
- 'Developers' section howto to grab the latest version of our sources
+ branches (ideally OpenBricks mercurial branch). Check on the website's
+ 'Download' section howto to grab the latest version of our sources
from the Mercurial repository. Please never start working from an
- officially released tree (like 0.97, 0.98.5 ...) as they are
- _ALWAYS_ outdated.
+ officially released tree as it is _ALWAYS_ outdated.
4. Make unified diffs ('diff -Naur' or 'hg diff').
Unified diffs can be applied easily with 'patch'. This is much harder
- with other diff types. Create the diff from the root of the GeeXboX
+ with other diff types. Create the diff from the root of the OpenBricks
source tree, this makes the diff easier to apply as it saves the step of
changing to the correct directory.
@@ -62,9 +48,9 @@ When sending us patches, please follow the rules below :
7. Your patch must comply with current code's indentation.
- GeeXboX rule is to use a 2 spaces indentation for shell scripts and to
+ OpenBricks rule is to use a 2 spaces indentation for shell scripts and to
comply with the C code indentation of the program you're patching for
- any other case. Remember that your patch against non-GeeXboX specific
+ any other case. Remember that your patch against non-OpenBricks specific
software might be sent upstream some day and so, must comply with these
projects' policies.
@@ -75,8 +61,8 @@ When sending us patches, please follow the rules below :
years/months after it has been applied. Commenting trivial code is not
required neither recommended. Comments must be English only! Do _NOT_
put your name in the code/comments you send. From the moment your patch
- has been accepted and applied, you'll be mentionned in the AUTHORS file,
- no need to spam the code.
+ has been accepted and applied, you'll be mentionned in SCM log history
+ or in the AUTHORS file, no need to spam the code.
9. Keep the documentation updated.
@@ -93,19 +79,19 @@ When sending us patches, please follow the rules below :
separately. Logical units should stay together, though, e.g. do not send
a patch for every file you change.
- 11. Send your patch to the geexbox-devel mailing list.
+ 11. Send your patch to the openbricks-devel mailing list.
In the mail, describe in a few sentences what you've changed and why.
All mails have to be written in English only. Do not send your patch as a
- reply to some other unrelated mail, compose a new message, otherwise it
+ reply to some other unrelated mail; compose a new message, otherwise it
will probably get overlooked. Do not compress your patch unless it is
really large. It only makes handling the patch more difficult.
If you have to compress your patch, use either bzip2, gzip or zip to
compress it, not a different format.
- You have to subscribe to geexbox-devel since we've blocked postings from
- non-subscribers after spam problems and because patches get reviewed by
- the developers on the list. We want you to be available for discussing
+ You have to subscribe to openbricks-devel since we've blocked postings
+ from non-subscribers after spam problems and because patches get reviewed
+ by the developers on the list. We want you to be available for discussing
your code, you might be asked to make modifications before we accept it.
Do not upload the patch to a web or FTP site, send it directly to the
@@ -116,11 +102,11 @@ When sending us patches, please follow the rules below :
12. Give us a few days to react.
We try to review patches as fast as possible, but unfortunately we are
- constantly overloaded with work, be it GeeXboX-related or from our day to
- day lives. If your patch seems to be ignored, send a reminder asking for
- opinions as a reply to the original patch and mention that you got
+ constantly overloaded with work, be it OpenBricks-related or from our day
+ to day lives. If your patch seems to be ignored, send a reminder asking
+ for opinions as a reply to the original patch and mention that you got
ignored. We are interested in your work and will eventually either accept
- it or reject it with an explanation of what we disliked about your patch.
+ it or reject it with an explanation of what we (dis)liked about your patch.
We will often ask you to make changes to your patch to make it
acceptable. Implement them if you want to see your patch applied and send
@@ -130,4 +116,4 @@ When sending us patches, please follow the rules below :
Thank you!
-The GeeXboX development team,
+The OpenBricks development team,
Please sign in to comment.
Something went wrong with that request. Please try again.