view docs/known-doc-issues.rst @ 6699:ddebaa161306 stable

evolve: use functions from topic extension to set current topic and tns

In some cases in evolve we need to relocate commits on disk instead of purely
in-memory. Previously we were writing .hg/topic file by hand here, but it
wasn't the right thing to do, and also we could sometimes write an empty string
to the file. Let's use the functions in topic that are specifically made to
change current topic and tns.

I don't think we can simply manipulate commit extras to copy topic and
topic_namespace, because sometimes we can have unresolved merge conflicts
(since we're dealing with relocating on disk), and in this case users might
need to continue evolve later after resolving the situation, so I think we
definitely want to write current topic and tns to the files for persistence.

.. Copyright © 2017 Pierre-Yves David <[e-mail]>

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