docs/known-doc-issues.rst
author Pierre-Yves David <pierre-yves.david@octobus.net>
Mon, 03 Sep 2018 16:29:02 +0200
changeset 4065 fbc51e98cf13
parent 2961 f98f3f62f8c4
permissions -rw-r--r--
alias: allow reference through 's#' We keep the 't#' option, but we hope to be able to deprecate it at some point. We move to 's#' because it refers to `stack` a more generic concept. than topic. In addition, this allows to phase out 'b#' that collide with normal hex-node.

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