Mercurial > hg > octave-lojdl
changeset 8200:837487bd3450
help new contributors with mercurial
author | Thorsten Meyer <thorsten.meyier@gmx.de> |
---|---|
date | Fri, 03 Oct 2008 23:10:09 +0200 |
parents | ec1b4cd5fbbb |
children | 0ab4eed59455 |
files | doc/ChangeLog doc/interpreter/contrib.txi |
diffstat | 2 files changed, 49 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,4 +1,7 @@ 2008-10-03 Thorsten Meyer <thorsten.meyier@gmx.de> + * interpreter/contrib.txi: added example for mercurial queues + +08-10-03 Thorsten Meyer <thorsten.meyier@gmx.de> * interpreter/contrib.txi: correction of the mercurial example * interpreter/container.txi: minor correction of the text
--- a/doc/interpreter/contrib.txi +++ b/doc/interpreter/contrib.txi @@ -42,22 +42,62 @@ The preferable form of contribution is creating a Mercurial changeset and sending it via e-mail to the octave-maintainers mailing list. Mercurial is the -SCM system currently used to develop Octave. Other forms of contributions (e.g. -simple diff patches) are also acceptable, but they slow down the review process. -If you want to make more contributions, you should really get familiar with -Mercurial. A good place to start is -@url{http://www.selenic.com/mercurial/wiki/index.cgi/Tutorial}. -A simplified contribution sequence could look like this: +source code management system currently used to develop Octave. Other forms of +contributions (e.g. simple diff patches) are also acceptable, but they slow +down the review process. If you want to make more contributions, you should +really get familiar with Mercurial. A good place to start is +@url{http://www.selenic.com/mercurial/wiki/index.cgi/Tutorial}. There you will +also find help how to install Mercurial. +A simple contribution sequence could look like this: @example hg clone http://www.octave.org/hg/octave + # make a local copy of the octave + # source repository cd octave # change some sources... hg commit -m "make Octave the coolest software ever" + # commit the changeset into your + # local repository hg export -o ../cool.diff tip + # export the changeset to a diff + # file # send ../cool.diff via email @end example +You may want to get familiar with Mercurial queues to manage your changesets. +Here is a slightly less simple example using Mercurial queues, where you work +on two unrelated changesets in parallel and update one of the changesets after +discussion in the maintainers mailing list: +@example +hg qnew nasty_bug # create a new patch +# change sources... +hg qref # save the changes into the patch +# change even more... +hg qref -m "solution to nasty bug!" + # save again with commit message +hg export -o ../nasty.diff tip + # export the patch +# send ../nasty.diff via email +hg qpop # undo the application of the patch + # and remove the changes from the + # source tree +hg qnew doc_improvements # create an unrelated patch +# change doc sources... +hg qref -m "could not find myfav.m in the doc" + # save the changes into the patch +hg export -o ../doc.diff tip + # export the second patch +# send ../doc.diff tip via email +hg qpop +# discussion in the maintainers mailing list ... +hg gpush nasty_bug # apply the patch again +# change sources yet again ... +hg qref +hg export -o ../nasty2.diff tip +# send ../nasty2.diff via email +@end example + @node General Guidelines @section General Guidelines