[MPlayer-DOCS] DOCS/tech/cvs-howto.txt

[Ivo]

On Friday 23 June 2006 00:41, Diego Biurrun wrote:
> Somewhere it should be mentioned that you should *always* doublecheck
> changes with 'svn diff' before finally committing.  Also, the
> distinction of the workflow between maintained and unmaintained code
> could be a bit more explicit.

Made all the changes you and The Wanderer suggested and some more. I am 
undecided on how to increase the distinction of the workflow between 
maintained and unmaintained code. I could add some text to III.4 or make 
the note at the bottom a bit longer and more elaborate. I'll think about 
it.

--Ivo
-------------- next part --------------
III. Beginners Guide
====================

The typical flow of development would be:

1. Check out the source:

    svn checkout svn://svn.mplayerhq.hu/mplayer/trunk/ devel

2. Make your changes.

3. Create a patch:

  Run svn diff from the root of the source tree, like this:

    cd devel
    svn diff > ../my_changes.patch

  If you have made several changes, but only want to submit one for review
  by other developers, you can specify the filename(s), for example:

    svn diff mplayer.c > ../major_cleanup.patch

4. Check the patch:

  Checkout another, clean source tree and verify your patch:

    svn checkout svn://svn.mplayerhq.hu/mplayer/trunk/ clean
    cd clean
    patch --dry-run < ../my_changes.patch

  If there are no errors, you can apply your patch:

    patch < ../my_changes.patch

  After that, verify that MPlayer still builds correctly with your patch
  applied. Also, be sure that your patch meets our policy as described in
  section II, specifically rules 1 to 6, before you continue submitting
  the patch.

5. Submit the patch:

  Send an e-mail to the mplayer-dev-eng mailing list. Describe what your
  patch does and why, and attach the patch file for review by others.

6. During the review process, incorporate all suggested fixes. Go to step 2
  repeatedly until there is nothing more to do for step 6. Of course, if
  you don't agree with certain suggestions, things can be discussed on
  the mailing list in a polite manner.

7. Commit the patch:

  If your patch is accepted, double check if your source tree contains the
  most recent version of your patch with svn diff! After verifying that you
  met these conditions, commit with:

    svn commit filename(s)

  Go to step 2 ad infinitum until MPlayer is the perfect media player ;)

Note: If you are listed as the maintainer for a particular piece of code,
you can skip step 5 and 6 if your patch _only_ applies to the code you
maintain. If it touches other code or is otherwise very intrusive, please
post it to mplayer-dev-eng first.