comparison docs/index.rst @ 2883:a23045b61e6d

doc-front-page: use a clearer statement about the experimental status This text comes form the Mercurial wiki.
author Pierre-Yves David <pierre-yves.david@octobus.net>
date Wed, 30 Aug 2017 11:26:00 +0200
parents 4b7252600e57
children 5a836fa589a4
comparison
equal deleted inserted replaced
2882:4b7252600e57 2883:a23045b61e6d
132 low latency feedbacks. 132 low latency feedbacks.
133 133
134 Whenever we are happy with a direction experimented in the extension, the 134 Whenever we are happy with a direction experimented in the extension, the
135 relevant code go upstream. 135 relevant code go upstream.
136 136
137 ``evolve`` is experimental! 137 Development status
138 --------------------------- 138 ------------------
139 139
140 The long-term plan for ``evolve`` is to add it to core Mercurial. 140 While well on the way, the full implementation of the changeset evolution
141 However, it is not yet stable enough for that. In particular: 141 concept is still in progress. Core Mercurial already supports many of the
142 associated features, but for now they are still disabled by default. The current
143 implementation has been usable for multiple years already, and some parts of it
144 are used in production in multiple projects and companies (including the
145 Mercurial project itself, Facebook, Google, etc…).
142 146
143 * The UI is unstable: ``evolve``'s command names and command options 147 However, there are still some areas were the current implementation has gaps.
144 are not completely nailed down yet. They are subject to occasional 148 This means some use cases or performance issues are not handled as well as they
145 backwards-incompatible changes. If you write scripts that use 149 currently are without evolution. Mercurial has been around for a long time and
146 evolve commands, a future release could break your scripts. 150 is strongly committed to backward compatibility, and turning evolution on by
151 default nowadays could regress the experience of some of our current users. The
152 feature will be enabled by default at the point where users who do not use or
153 care about the new features added by evolution won't be impacted by it.
147 154
148 * There are still some corner cases that aren't handled yet. If you 155 .. # .. _`this query`: https://bz.mercurial-scm.org/buglist.cgi?component=evolution&bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=NEED_EXAMPLE
149 think you have found such a case, please check if it's already
150 described in the Mercurial bug tracker (https://bz.mercurial-scm.org/).
151 Bugs in ``evolve`` are files under component "evolution": use
152 `this query`_ to view open bugs in ``evolve``.
153
154 .. _`this query`: https://bz.mercurial-scm.org/buglist.cgi?component=evolution&bug_status=UNCONFIRMED&bug_status=CONFIRMED&bug_status=NEED_EXAMPLE
155 156
156 Ressources 157 Ressources
157 ---------- 158 ----------
158 159
159 * For a practical guide to using ``evolve`` in a single repository, 160 * For a practical guide to using ``evolve`` in a single repository,