diff options
| -rw-r--r-- | README | 10 | ||||
| -rw-r--r-- | README.CVS | 108 | ||||
| -rw-r--r-- | README.patches | 59 | ||||
| -rw-r--r-- | v4l/ChangeLog | 11 | ||||
| -rw-r--r-- | v4l/README | 1 | ||||
| -rw-r--r-- | v4l/README.patches | 47 |
6 files changed, 188 insertions, 48 deletions
@@ -0,0 +1,10 @@ +V4L and DVB documentation are at: + linux/Docummentation directory. + +to compile both v4l and dvb, just do: + make + +to install over kernel's old files: + make install + +v4l dir is used as a temporary dir for building both v4l and dvb stuff. diff --git a/README.CVS b/README.CVS new file mode 100644 index 000000000..abfbc7750 --- /dev/null +++ b/README.CVS @@ -0,0 +1,108 @@ +Mauro Carvalho Chehab 2005 Dec 02 + + CVS is a developer database, It means that it might be broken +from time to time. There are more "stable" snapshots at +http://www.linuxtv.org/downloads/snapshot page. + + This file postulates some simple rules for maintaing CVS tree, +as stated bellow: + + 1) It is strongly recommended that CVS maintainers be active at +IRC (irc://irc.freenode.net) #v4l (analog) and/or #linuxtv (digital) +channels. It helps to have more discussions at major changes; + + 2) Minor changes, like simple card additions (only a card row at +a card struct) can be applied directly for the CVS maintainer; + + 3) Medium changes that needs modification on card coding or +creating a new card type should be discussed first at the Mailing Lists +video4linux-list .at. redhat .dot. com (analog/common parts) and/or +linux-dvb .at. linuxtv .dot. org to allow other contributors to discuss +about the way it will be included. The v4l-dvb maintainer should be +warned to create a snapshot (if the change could generate impacts on +other cards) BEFORE commiting the change to CVS at +v4l-dvb-maintainer .at. linuxtv .dot. org; + + 4) Major changes that implies changing some core structs should +be widely discussed on IRC, posted to the list, created a snapshot THEN +committed to CVS. + + 5) Every CVS maintainer should follow the "rules of thumb" of kernel + development stated at Linux source code, especially: + Documenation/SubmittingPatches + Documentation/SubmittingDrivers + Documentation/CodingStyle + + 6) Non active CVS maintainers or that doesn't like to follow these + rules may be dropped. + + 8) Every commit should update ChangeLog describing who did, what +changed and in what files, by using the command: + make changes + + For it to work, these vars should be defined (replacing the +names at the left): + +CHANGE_LOG_NAME="CVS maintainer" +CHANGE_LOG_EMAIL_ADDRESS=cvsmaintainer@cvsmaintainersite.com +CHANGE_LOG_LOGIN=cvsuser +export CHANGE_LOG_NAME CHANGE_LOG_EMAIL_ADDRESS CHANGE_LOG_LOGIN + + It is recommended to have these lines at .bashrc or .profile. + + 9) It shall also have a Developers Certificate of Origin version +1.1 at Changelog and cvs commit log, as postulated at kernel's source at: + Documentation/SubmittingPatches + + This is done by using Signed-off-by: fields at cvs commit message. + + It is not acceptable fake signatures like: + 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: + + 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. + + 9) Commit messages are very rellevant, since they will be used +when generating the patches for mainstream. + The format of commit message shall be: +Subject: patch subject +From: Patch Developer <patchdeveloper@patchdevelopersite.com> + +patch descriptions + +Signed-off-by: Patch Developer <patchdeveloper@patchdevelopersite.com> +Signed-off-by: Cvs Maintainer <cvsmaintainer@cvsmaintainersite.com> + + Subject: should be a brief description of the patch; + From: should be suppressed if the patch is from the CVS maintainer + You may add other signers, if the patch were tested by somebody +else and he also wants to sign. + + 10) if the patch also affects other parts of kernel (like alsa +or i2c), it is required that, at upstream submiting, the patch also go +to the maintainers of that piece. To do this, CVS maintainer shall add +one or more cc: fields at commit cvs message: + +CC: someotherkerneldeveloper@someplace + + 11) Sometimes, mainstream changes do affect CVS 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: + +kernel-sync + + Patches with such lines will not be submited upstream. + +Mauro +Mauro Carvalho Chehab <mchehab .at. linuxtv .dot. org> diff --git a/README.patches b/README.patches new file mode 100644 index 000000000..d6574acf2 --- /dev/null +++ b/README.patches @@ -0,0 +1,59 @@ +Mauro Carvalho Chehab 2005 Dec 02 + + The master copy of the video4linux and dvb kernel subsystem is now +maintained jointly at http://linuxtv.org/ + +=== v4l-dvb snapshots available at linuxtv.org + + We are now publishing periodic snapshots (about once a month or +before rellevant changes) at linuxtv.org. The main idea is to have +"stable" snapshots on Linuxtv. You can check it at: + +http://linuxtv.org/downloads/snapshot + +=== v4l-dvb quilt available at linuxtv.org + + It is also available patches against latest development kernel at: +http://linuxtv.org/downloads/quilt + + patches/series shows the correct order to apply. + +== Getting the latest Snapshot + + To get the latest sources from CVS you need to issue the +following commands: + +cvs -d :pserver:anonymous@cvs.linuxtv.org:/cvs/video4linux login +(use an empty password) + +cvs -z3 -d :pserver:anonymous@cvs.linuxtv.org:/cvs/video4linux co -P v4l-dvb +* Patches should be built against video4linux cvs. + +=== How to get your changes into the mainline tree? + +1. Post your patches to the corresponding mailing list for review and +testing by other people. For analog or core changes, the mailing list is +video4linux-list .at. redhat .dot. com. For DVB changes, the mailing list +is linux-dvb .at. linuxtv .dot. com. The latest requires subscription. + +2. Using [PATCH] at subject will help CVS maintainers to better handing +it. + +3. Please edit also ChangeLog, including some comments about it. + +4. Every patch shall have a Developers Certificate of Origin like + +Signed-off-by: Your name <name@yoursite.com> + +with name of people envolving on making it. + + This should be a real name and address. The exact meaning of the +signed-off-by is postulated at linux source code, at file: + Documentation/SubmittingPatches + +5. Fix problems and repeat until everyone is happy ;) + +6. Maintainers will periodically submit changes to mainstream. + +Mauro +Mauro Carvalho Chehab <mchehab .at. linuxtv .dot. org> diff --git a/v4l/ChangeLog b/v4l/ChangeLog index 96b8a052a..aaf4f9d41 100644 --- a/v4l/ChangeLog +++ b/v4l/ChangeLog @@ -1,3 +1,14 @@ +2005-12-02 10:57 mchehab + + * ../README: + * ../README.CVS: + * ../README.patches: + * ../v4l/README: + * ../v4l/README.patches: + + - Readme updates with common instructions for both v4l and dvb + Signed-off-by: Mauro Carvalho Chehab <mchehab@brturbo.com.br> + 2005-12-02 04:37 mkrufky * ../linux/Documentation/video4linux/CARDLIST.cx88: diff --git a/v4l/README b/v4l/README deleted file mode 100644 index 40cca1787..000000000 --- a/v4l/README +++ /dev/null @@ -1 +0,0 @@ -check out the doc/ directory ... diff --git a/v4l/README.patches b/v4l/README.patches deleted file mode 100644 index c1af1bf76..000000000 --- a/v4l/README.patches +++ /dev/null @@ -1,47 +0,0 @@ -Mauro Carvalho Chehab 10 June 2005 - -The master copy of the video4linux kernel subsystem is now maintained at -http://www.linuxtv.org/downloads/video4linux/ - -=== Video4linux snapshots available from linuxtv.org === - - -We are now publishing periodic snapshots (about once a month) at -linuxtv.org. The main idea is to have "stable" snapshots on Linuxtv. You -can check it at: - - http://www.linuxtv.org/downloads/video4linux/ - -The ChangeLog is also maintained at linuxtv.org. Our intention is to have -one snapshot generated at the same time it is being submited to -mm -series. - -I intend to send a first series of synchronizing patches to -mm this -weekend. There is already a working first patch at the site. - -* The cvs tree at cvs.linuxtv.org is now the "master copy" of the -video4linux subsystem. - -* Patches should be built against video4linux cvs. - -===How to get your changes into the mainline tree?=== - -1. Post your patches to the video4linux mailing list[1] for review and -testing by other people. - -2. Using [PATCH] at subject will help CVS maintainers to better handing -it. - -3. Please edit also ChangeLog, including some comments about it. - -4. Every patch should have a line like '''Signed-off-by: Your name -<name@yoursite.com>''' with name of people envolving on making it. - -5. Fix problems and repeat until everyone is happy ;) - -6. Maintainers will periodically submit changes to mainstream. - - -Mauro - -Mauro Carvalho Chehab <mchehab at brturbo dot com dot br> |