docs/known-doc-issues.rst
author Pierre-Yves David <pierre-yves.david@octobus.net>
Tue, 04 Jun 2019 10:07:08 +0200
changeset 4646 7b986968700b
parent 2961 f98f3f62f8c4
permissions -rw-r--r--
compat: adjust `wrapadd` for upstream Mercurial core updated the API in f385ba70e4af.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2894
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
     1
.. Copyright © 2017 Pierre-Yves David <pierre-yves.david@octobus.net>
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
     2
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
     3
==============================================
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
     4
Known limitations of the current documentation
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
     5
==============================================
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
     6
2961
f98f3f62f8c4 doc: clarify undocumented features
Philippe Pepiot <phil@philpep.org>
parents: 2894
diff changeset
     7
Features not covered by tutorials
f98f3f62f8c4 doc: clarify undocumented features
Philippe Pepiot <phil@philpep.org>
parents: 2894
diff changeset
     8
=================================
2894
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
     9
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    10
Some of the *newer* features of evolution might not be reflected in the
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    11
documentation yet. You can directly check the inline documentation of the
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    12
extension itself for fresher details using `hg help -e evolve`.
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    13
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    14
Known undocumented features are:
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    15
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    16
 * `hg prev`,
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    17
 * `hg next`,
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    18
 * `hg next --evolve`,
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    19
 * `hg evolve --rev`,
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    20
 * `hg evolve --list`,
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    21
 * `hg obslog`,
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    22
 * `hg split`,
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    23
 * `hg metaedit`,
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    24
 * `hg touch`,
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    25
 * `hg amend --extract`,
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    26
 * `hg pdiff`,
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    27
 * `hg pstatus`,
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    28
 * `hg amend -i`,
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    29
 * various topic related elements (in particular `hg stack`),
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    30
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    31
Unreferenced Documents
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    32
======================
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    33
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    34
There are documents with content not linked in the flow of the main
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    35
documentation. Some might be outdated and some are too fresh to be integrated in
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    36
the main flow yet.
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    37
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    38
.. toctree::
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    39
   :maxdepth: 1
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    40
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    41
   evolve-faq
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    42
   evolve-good-practice
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    43
   obs-terms
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    44
   tutorials/topic-tutorial
31aa9d097d29 doc: record all the missings and strange bit we know
Pierre-Yves David <pierre-yves.david@octobus.net>
parents:
diff changeset
    45
   tutorials/tutorial