some more doc update
authorPierre-Yves David <pierre-yves.david@logilab.fr>
Tue, 20 Mar 2012 16:58:00 +0100
changeset 156 3c4826fb374a
parent 155 58301324ac96
child 157 b0ee408732cd
some more doc update
doc/evolve-tutorial.rst
doc/from-mq.rst
--- a/doc/evolve-tutorial.rst	Tue Mar 20 16:23:02 2012 +0100
+++ b/doc/evolve-tutorial.rst	Tue Mar 20 16:58:00 2012 +0100
@@ -122,7 +122,10 @@
 create *unstable* changeset and *suspended obsolete* changeset
 
 .. warning:: ``hg stabilize`` have no --continue to use after conflict
-             resolution
+             resolution. is conflict occurs use::
+
+               $ hg up -C . # cancel the failed merge
+               $ hg stabilize -n # go get a command to execute
 
 .. warning:: stabilization does not handle deletion yet.
 
@@ -168,6 +171,11 @@
 
     $ hg clone http://hg-dev.octopoid.net/hgwebdir.cgi/hgview/
 
+Prevent my unfinished changeset to get published
+------------------------------------------------------------
+
+The easiest way is to set them in the private phase
+
 Important Note
 =====================================================================
 
--- a/doc/from-mq.rst	Tue Mar 20 16:23:02 2012 +0100
+++ b/doc/from-mq.rst	Tue Mar 20 16:58:00 2012 +0100
@@ -1,26 +1,31 @@
 Moving from mq to hg-evolution
 ===============================
 
+Cheat sheet
+-------------
 
-quick reference:
-
-mq command      equivalent
+==============================  ============================================
+mq command                       new equivalent
+==============================  ============================================
 
-hg qseries      hg log
-hg qnew         hg commit
-hg qrefresh     hg amend
-hg qpop         hg update
-hg qpush        hg graft or rebase
-hg qrm          hg kill
-hg qfold        hg collapse
-hg qdiff        hg diff
+qseries                         ``log``
+qnew                            ``commit``
+qrefresh                        ``amend``
+qpop                            ``update`` or ``qdown``
+qpush                           ``update`` or ``gup`` sometimes ``stabilize``
+qrm                             ``kill``
+qfold                           ``amend -c`` (for now, ``collapse`` soon)
+qdiff                           ``odiff``
 
-hg qfinish       --
-hg qimport       --
+qfinish                         --
+qimport                         --
 
 
+Replacement details
+---------------------
+
 hg qseries
------------
+```````````
 
 All your work in progress are now real changeset all the time.
 
@@ -28,27 +33,22 @@
 display unfinished business only and template to have the same kind of compact
 output qseries have.
 
-This will result in something like that
-
-  $ hg log -r 'not public()' --template='{rev}:{node|short} {description|firstline}\n'
+This will result in something like that::
 
   [alias]
   wip = log -r 'not public()' --template='{rev}:{node|short} {description|firstline}\n'
 
 hg qnew
---------
+````````
 
-With evolution you handle standard changeset without additional overlay.
+With evolve you handle standard changeset without additional overlay.
 
 Standard changeset are created using hg commit as usual.
 
   $ hg commit
 
 If you want to keep the "wip are not pushed" behavior, you are looking for
-setting your changeset in the secret phase. This can be achieved with the following sequence:
-
-  $ hg phase --secret
-  $ hg commit
+setting your changeset in the secret phase using the phase command.
 
 Note that you only need it for the first commit you want to be secret. Later
 commit will inherit their parents phase.
@@ -60,15 +60,16 @@
   new-commit=secret
 
 hg qref
---------
+````````
 
 A new command from evolution will allow you to rewrite the changeset you are
-current on. just invoc:
+currently on. just call:
 
   $ hg amend
 
 
 This command takes the same option than commit  plus useful switch '-e' (--edit)
+to edit the commit message.
 
 Amend have also a -c switch which allow you to make and explicit amending
 commit before rewriting a changeset.
@@ -80,16 +81,22 @@
 
 note: refresh is an alias for amend
 
+hg qpop
+`````````
 
-hg qpop
----------
+the following command emule the behavior of hg qpop:
 
-If you need to go back to a previous state just:
+  $ hg gdown
+
+If you need to go back to an arbitrary commit you can just us:
 
   $ hg update
 
+.. note:: gdown and update allow movement with working directory changes applied
+          and gracefully merge them.
+
 hg qpush
---------
+````````
 
 When you rewrite changeset, descendant of rewritten changeset are marked as
 "out of sync". You new to rewrite them on top of the new version of their
@@ -97,7 +104,7 @@
 
 The evolution extension add a command to rewrite the next changeset:
 
-  $ hg evolve
+  $ hg stabilize
 
 You can also decide to do it manually using
 
@@ -112,15 +119,23 @@
 
 
 hg qrm
--------
+```````
 
 evolution introduce a new command to mark a changeset as "not wanted anymore".
 
   $ hg kill <revset>
 
 hg qfold
----------
+`````````
+
+
+::
 
+  $ hg up <top changeset>
+  $ amend --edit -c <bottom changeset>
+
+
+or later::
 
   $ hg collapse # XXX not implemented
 
@@ -128,10 +143,14 @@
 
 
 hg qdiff
----------
+`````````
+
+``odiff`` is an alias for `hg diff -r .^` it works as qdiff event outside mq.
 
 
 
- $ hg diff -r .^
+hg qfinish and hg qimport
+````````````````````````````
 
-
+Is not useful anymore if you want to controll exchange and mutability of
+changeset see the phase feature