evolve: document the "if not shouldupdate" block
I missed the "not" in "if not shouldupdate: ... hg.updaterepo()" and
it took a long time for me to realize it's about updating *back* to
the original commit (or to its successor). Let's add a comment to
maybe help the person not make the same mistake.
.. Copyright © 2017 Pierre-Yves David <pierre-yves.david@octobus.net>
==============================================
Known limitations of the current documentation
==============================================
Features not covered by tutorials
=================================
Some of the *newer* features of evolution might not be reflected in the
documentation yet. You can directly check the inline documentation of the
extension itself for fresher details using `hg help -e evolve`.
Known undocumented features are:
* `hg prev`,
* `hg next`,
* `hg next --evolve`,
* `hg evolve --rev`,
* `hg evolve --list`,
* `hg obslog`,
* `hg split`,
* `hg metaedit`,
* `hg touch`,
* `hg amend --extract`,
* `hg pdiff`,
* `hg pstatus`,
* `hg amend -i`,
* various topic related elements (in particular `hg stack`),
Unreferenced Documents
======================
There are documents with content not linked in the flow of the main
documentation. Some might be outdated and some are too fresh to be integrated in
the main flow yet.
.. toctree::
:maxdepth: 1
evolve-faq
evolve-good-practice
obs-terms
tutorials/topic-tutorial
tutorials/tutorial