docs/known-doc-issues.rst
author Pulkit Goyal <7895pulkit@gmail.com>
Mon, 11 Jun 2018 20:13:36 +0530
changeset 3831 987e335dbe11
parent 2961 f98f3f62f8c4
permissions -rw-r--r--
evolve: store the obsmarkers to be deleted in evolvestate Sometimes, we don't create a new node and obsolete one of the old node in favour of an existing node. When user calls, `hg evolve --abort`, we need to strip that obsmarker to go back in the same old state. The obsmarker created for new node are stripped when the new nodes are stripped. This patch start storing such obsmarkers in the evolvestate so that we can delete them later if required. Right now we just store successsor and predecessor information, we might need a better obsmarker serialization techinque in future to make it more robust.

.. 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