annotate docs/evolve-good-practice.rst @ 4935:3874bc10d4a7 stable

docs: add two more amend commits to simulate temporary amend commits

sharing.rst made reference to temporary amend commits and used them to
demonstrate that hidden commits are not exchanged. Nowadays, evolve doesn't
create such commits, but it still makes sense to show how they are handled
during the exchange process. So let's add two more amend commits, one for each
repo. This way the guide doesn't have to be updated too much, but doesn't lose
this important detail of working with evolve.

Unfortunately, this means that tons of hashes change, but it's better than to
have figure 4 demonstrate absolutely nothing.

Temporary amend commits were removed from test-sharing.t in 06844693bb21,
but sharing.rst continued using them for demonstration purposes. It might've
been better to replace at least some of the temporary amend commits by extra
amends back then, but oh well.

.. Copyright 2011 Pierre-Yves David <[e-mail]>
..                Logilab SA        <[e-mail]>

-----------------------------------------
Good practice for (early) users of evolve
-----------------------------------------

Avoid unstability
-----------------

The less unstability you have the less you need to resolve.

Evolve is not yet able to detect and solve every situation. And your mind is
not ready neither.

Branch as much as possible
--------------------------

This is not MQ; you are not constrained to linear history.

Making a branch per independent branch will help you avoid unstability
and conflict.

Rewrite your changes only
-------------------------

There is no descent conflict detection and handling right now.
Rewriting other people's changesets guarantees that you will get
conflicts. Communicate with your fellow developers before trying to
touch other people's work (which is a good practice in any case).

Using multiple branches will help you to achieve this goal.

Prefer pushing unstability to touching other people changesets
--------------------------------------------------------------


If you have children changesets from other people that you don't really care
about, prefer not altering them to risking a conflict by stabilizing them.


Do not get too confident
------------------------

This is an experimental extension and a complex concept. This is beautiful,
powerful and robust on paper, but the tool and your mind may not be prepared for
all situations yet.