diff options
Diffstat (limited to 'README.HG')
| -rw-r--r-- | README.HG | 55 |
1 files changed, 27 insertions, 28 deletions
@@ -54,15 +54,24 @@ kernel development stated at Linux source code, especially: Documentation/SubmittingDrivers Documentation/CodingStyle - 6) Every commit should update the ChangeLog describing who made the -change, what changed and in what files, by using the command: + 6) All commits should have a consistent message. On v4l-dvb, this is +done by using: - make changes + make commit - 7) The latest changelog line will be automatically used as a -prototype to the commit message at the *LOCAL* repository by using: + This will run some scripts that will check changed files, generating a +ChangeLog like comment (that will be removed from the commit) and prepare the +last Signed-off-by field, as described bellow. - make commit + 7) Files can be added, removed or renamed at hg repository. This should +be done by using: + hg add <files> + hg remove <files> + hg rename <source> <dest> + hg addremove + + *Warning* hg addremove will add/removes all files, including object files. +Be careful! You can remove wrongly added files with hg remove. 8) If the commit went wrong, hg allows you to undo the last commit, by using the command: @@ -76,11 +85,11 @@ hg commit will redo the desired commit. make push - 9) To update from the master repository, it is needed to do: + 10) To update from the master repository, it is needed to do: make pull - 10) For hg to work properly, these vars should be defined + 11) For hg to work properly, these vars should be defined (replacing the names at the left): CHANGE_LOG_NAME="Maintainer Name" @@ -92,9 +101,8 @@ export CHANGE_LOG_NAME CHANGE_LOG_EMAIL_ADDRESS CHANGE_LOG_LOGIN HGUSER It is recommended to have these lines at .bashrc or .profile. - 11) All commit messages shall have a Developers Certificate of -Origin version 1.1 at Changelog and cvs commit log, as postulated at -kernel's source at: + 12) All commit messages shall have a Developers Certificate of Origin +version 1.1 at commit log, as postulated at kernel's source at: Documentation/SubmittingPatches @@ -104,20 +112,9 @@ kernel's source at: Signed-off-by: Fake me <me@snakeoilcompany.com> The email should be a valid one. - The bottom signed-off-by should be the CVS maintainer. - - This is an example of ChangeLog entry: + The bottom signed-off-by should be the commiter. - 2005-06-28 18:35 cvsmaintainer - * filelist.c, filelist.h: - - described changes. - - Signed-off-by: Patch Developer <patchdeveloper@patchdevelopersite.com> - Signed-off-by: Cvs Maintainer <cvsmaintainer@cvsmaintainersite.com> - - Obs.: Timestamp should be in GMT. - - 12) Commit messages are very relevant, since they will be used + 13) Commit messages are very relevant, since they will be used when generating the patches for v4l-dvb.git and to mainstream. The format of commit message shall be: @@ -130,6 +127,8 @@ patch descriptions Signed-off-by: Patch Developer <patchdeveloper@patchdevelopersite.com> Signed-off-by: Cvs Maintainer <cvsmaintainer@cvsmaintainersite.com> + All lines starting with # will be removed by make commit stripts. + Subject should be a brief description of the patch. Please notice that, with hg, there's no need (and not desired) to define a Subject: tag. The first msg line will be used as subject, just like @@ -141,7 +140,7 @@ git. else and he also wants to sign. The committer signed-off-by should be the last one. - 13) If the patch also affects other parts of kernel (like alsa + 14) If the patch also affects other parts of kernel (like alsa or i2c), it is required that, at upstream submitting, the patch also goes to the maintainers of that subsystem. To do this, CVS maintainer shall add one or more cc: fields to the commit message, after the subject: @@ -151,7 +150,7 @@ CC: someotherkerneldeveloper@someplace Please notice that this is manually handled by the -git maintainer, so unnecessary usage should be avoided. - 14) Sometimes, mainstream changes do affect v4l-dvb tree, and + 15) Sometimes, mainstream changes do affect v4l-dvb tree, and requires to apply some kernel patches at the tree. This kind of commit should follow the rules above and should also have a line like: @@ -159,7 +158,7 @@ kernel-sync Patches with such lines will not be submitted upstream. - 15) sometimes it is necessary to introduce some testing code + 16) sometimes it is necessary to introduce some testing code inside a module or remove parts that are not yet finished. Also, compatibility tests may be required to provide backporting. @@ -173,7 +172,7 @@ If this code is meant to go also to kernel, this struct should be used: or #if 1 /* keep */ - 16) Nested #ifs are allowed, but the #elif macro shouldn't be + 17) Nested #ifs are allowed, but the #elif macro shouldn't be used, since the macro preprocessing script used to prepare kernel upstream patches (v4l/scripts/gentree.pl) is not able to handle it. |