[PATCH 05 of 14 evolve-ext] docs: change `unstable` references to `orphan`
Matt Harbison
mharbison72 at gmail.com
Sun Apr 28 00:28:52 EDT 2019
# HG changeset patch
# User Matt Harbison <matt_harbison at yahoo.com>
# Date 1556414658 14400
# Sat Apr 27 21:24:18 2019 -0400
# Node ID 7bc1b790f02fff5e7fc0aa6baefa17b61fbe183c
# Parent ba7a3461cc5d3c72d98759fa5b07129b1f252f91
docs: change `unstable` references to `orphan`
Per https://www.mercurial-scm.org/wiki/CEDVocabulary
diff --git a/docs/concepts.rst b/docs/concepts.rst
--- a/docs/concepts.rst
+++ b/docs/concepts.rst
@@ -92,8 +92,8 @@
think of the traditional parent/child DAG as the first derivative of
your source code, and the obsolescence DAG as the second derivative.)
-Troubled changesets (unstable, bumped, divergent)
--------------------------------------------------
+Troubled changesets (orphan, bumped, divergent)
+-----------------------------------------------
Evolving history can introduce problems that need to be solved. For
example, if you prune a changeset *P* but not its descendants, those
@@ -102,7 +102,7 @@
at the same time. But Mercurial does not push obsolete changesets like
*P*, so it cannot push the descendants of *P*. Any non-obsolete
changeset that is a descendant of an obsolete changeset is said to be
-*unstable*.
+an *orphan*.
[diagram: obsolete cset with non-obsolete descendant]
@@ -132,13 +132,13 @@
successors are both called *divergent* (unless one of them is in
public phase; only mutable changesets are divergent).
-The collective term for unstable, bumped, and divergent changeset is
+The collective term for orphan, bumped, and divergent changeset is
*troubled*::
- troubled = unstable ∪ bumped ∪ divergent
+ troubled = orphan ∪ bumped ∪ divergent
It is possible for a changeset to be in any of the troubled categories
-at the same time: it might be unstable and divergent, or bumped and
+at the same time: it might be an orphan and divergent, or bumped and
divergent, or whatever.
[diagram: Venn diagram of troubled changesets, showing overlap]
diff --git a/docs/evolve-faq.rst b/docs/evolve-faq.rst
--- a/docs/evolve-faq.rst
+++ b/docs/evolve-faq.rst
@@ -144,7 +144,7 @@
---------------------------------------
When you rewrite (amend) a changeset with children without rewriting
-those children you create *unstable* changesets and *suspended
+those children you create *orphan* changesets and *suspended
obsolete* changesets.
When you are finished amending a given changeset, you will want to
diff --git a/docs/figures/figure-ug06.svg b/docs/figures/figure-ug06.svg
--- a/docs/figures/figure-ug06.svg
+++ b/docs/figures/figure-ug06.svg
@@ -737,7 +737,7 @@
id="tspan4456"
x="150.66776"
y="148.39902"
- style="font-size:10px;line-height:1.25;font-family:sans-serif">unstable</tspan></text>
+ style="font-size:10px;line-height:1.25;font-family:sans-serif">orphan</tspan></text>
<path
style="color:#000000;fill:none;stroke:#707070;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0;marker:none;marker-end:url(#marker3230);visibility:visible;display:inline;overflow:visible;enable-background:accumulate"
d="m 41.433633,155.93241 c 4.445697,11.92656 24.017716,1.13391 25.948336,14.64825"
diff --git a/docs/figures/figure-ug08.svg b/docs/figures/figure-ug08.svg
--- a/docs/figures/figure-ug08.svg
+++ b/docs/figures/figure-ug08.svg
@@ -380,7 +380,7 @@
id="tspan9303"
x="125.75282"
y="939.66284"
- style="font-size:10px;line-height:1.25;font-family:sans-serif">unstable</tspan></text>
+ style="font-size:10px;line-height:1.25;font-family:sans-serif">orphan</tspan></text>
<text
xml:space="preserve"
style="font-style:italic;font-variant:normal;font-weight:normal;font-stretch:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:'Sans Italic';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none"
diff --git a/docs/figures/figure-ug10.svg b/docs/figures/figure-ug10.svg
--- a/docs/figures/figure-ug10.svg
+++ b/docs/figures/figure-ug10.svg
@@ -446,7 +446,7 @@
id="tspan9303"
x="155.24913"
y="668.43335"
- style="font-size:10px;line-height:1.25;font-family:sans-serif">unstable</tspan></text>
+ style="font-size:10px;line-height:1.25;font-family:sans-serif">orphan</tspan></text>
<g
id="g5433"
transform="translate(32.476727,584.47248)">
diff --git a/docs/figures/figure-ug11.svg b/docs/figures/figure-ug11.svg
--- a/docs/figures/figure-ug11.svg
+++ b/docs/figures/figure-ug11.svg
@@ -488,7 +488,7 @@
id="tspan9303"
x="159.24913"
y="668.43335"
- style="font-size:10px;line-height:1.25;font-family:sans-serif">unstable</tspan></text>
+ style="font-size:10px;line-height:1.25;font-family:sans-serif">orphan</tspan></text>
<text
xml:space="preserve"
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;line-height:0%;font-family:monospace;-inkscape-font-specification:Monospace;text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none"
diff --git a/docs/from-mq.rst b/docs/from-mq.rst
--- a/docs/from-mq.rst
+++ b/docs/from-mq.rst
@@ -115,10 +115,10 @@
````````
When you rewrite changesets, descendants of rewritten changesets are marked as
-"unstable". You need to rewrite them on top of the new version of their
+"orphan". You need to rewrite them on top of the new version of their
ancestor.
-The evolution extension adds a command to rewrite "unstable"
+The evolution extension adds a command to rewrite "orphan"
changesets:::
$ hg evolve
diff --git a/docs/obs-terms.rst b/docs/obs-terms.rst
--- a/docs/obs-terms.rst
+++ b/docs/obs-terms.rst
@@ -92,9 +92,9 @@
| | | |
| +--------------------------+-----------------------------+
| | | |
-| | **troubled** | **unstable** |
+| | **troubled** | **orphan** |
| | | |
-| | *troubled* has | *unstable* is a changeset |
+| | *troubled* has | *orphan* is a changeset |
| | unresolved issue caused | with obsolete ancestors. |
| | by *obsolete* relations. | |
| | | |
@@ -105,7 +105,7 @@
| | changeset to combine | (possible alternative name: |
| | multiple issue at once. | precarious) |
| | (a.k.a. divergent and | |
-| | unstable) +-----------------------------+
+| | orphan) +-----------------------------+
| | | |
| | (possible alternative | **bumped** |
| | names: unsettled, | |
@@ -226,7 +226,7 @@
``````
Automatically resolve *troublesome* changesets
-(*unstable*, *bumped* and *divergent*)
+(*orphan*, *bumped* and *divergent*)
This is an important name as hg pull/push will suggest it the same way it
suggest merging when you add heads.
diff --git a/docs/sharing.rst b/docs/sharing.rst
--- a/docs/sharing.rst
+++ b/docs/sharing.rst
@@ -508,7 +508,7 @@
but every competent chef keeps several around. Ever try to chop onions
with a spoon?)
-In the user guide, we saw examples of *unstable* changesets, which are
+In the user guide, we saw examples of *orphan* changesets, which are
the most common type of troubled changeset. (Recall that a
non-obsolete changeset with obsolete ancestors is an orphan.)
diff --git a/docs/tutorial/draft.md b/docs/tutorial/draft.md
--- a/docs/tutorial/draft.md
+++ b/docs/tutorial/draft.md
@@ -527,7 +527,7 @@
}
~~~
-## Unstable
+## Orphan
~~~graphviz
digraph G {
@@ -538,14 +538,14 @@
node[group=main];
Root -> New;
node[group=obsolete];
- Root -> Obsolete -> Unstable;
+ Root -> Obsolete -> Orphan;
// Obsolescence links
edge[dir=back, style=dotted, arrowtail=dot];
Obsolete -> New;
Obsolete [fillcolor="#DFDFFF"];
- Unstable [fillcolor="#FF3535"];
+ Orphan [fillcolor="#FF3535"];
Root[shape="circle"];
}
~~~
diff --git a/docs/tutorial/slides.md b/docs/tutorial/slides.md
--- a/docs/tutorial/slides.md
+++ b/docs/tutorial/slides.md
@@ -852,7 +852,7 @@
output/edit-mid-stack.log
```
-The message `1 new orphan changesets` means that, by amending a changeset having a child, this child is now **unstable**, as we can see with the `hg stack` command:
+The message `1 new orphan changesets` means that, by amending a changeset having a child, this child is now **orphan**, as we can see with the `hg stack` command:
```raw-file
output/edit-mid-stack-after-stack.log
@@ -909,7 +909,7 @@
output/basic-stabilize-before-log-obsolete.log
```
-A changeset can also be **unstable**, meaning that it could be subject to one or more **instabilities**:
+A changeset can also be **orphan**, meaning that it could be subject to one or more **instabilities**:
* **orphan**, a changeset whose an ancestor is **obsolete**.
* **content-divergent**, a changeset which has been rewritten in two different versions.
@@ -1501,7 +1501,7 @@
$> hg update --rev t1
1 files updated, 0 files merged, 0 files removed, 0 files unresolved
$> hg commit --amend -m "Step1"
-<span style="color:gold;">3 new unstable changesets</span>
+<span style="color:gold;">3 new orphan changesets</span>
</pre>
#### What have we done?
@@ -1510,11 +1510,11 @@
$> hg log -G -T compact
@ <span style="color:olive;">9</span>[tip] 1aa1be5ada40 Step1
|
-| o <span style="color:olive;">8</span> cf90b2de7e65 Step4 <span style="color:red;">(unstable)</span>
+| o <span style="color:olive;">8</span> cf90b2de7e65 Step4 <span style="color:red;">(orphan)</span>
| |
-| o <span style="color:olive;">7</span> e208d4205c8e Step3 <span style="color:red;">(unstable)</span>
+| o <span style="color:olive;">7</span> e208d4205c8e Step3 <span style="color:red;">(orphan)</span>
| |
-| o <span style="color:olive;">6</span> 673ff300cf3a Step2 <span style="color:red;">(unstable)</span>
+| o <span style="color:olive;">6</span> 673ff300cf3a Step2 <span style="color:red;">(orphan)</span>
| |
| <span style="color:grey;">x 5 8bb88a31dd28 Step</span>
|/
@@ -1528,9 +1528,9 @@
$> hg stack
###### topic: <span style="color:green;">myfeature</span>
###### branch: feature
-<span style="color:olive;">t4</span><span style="color:red;">$</span> Step4<span style="color:red;"> (unstable)</span>
-<span style="color:olive;">t3</span><span style="color:red;">$</span> Step3<span style="color:red;"> (unstable)</span>
-<span style="color:olive;">t2</span><span style="color:red;">$</span> Step2<span style="color:red;"> (unstable)</span>
+<span style="color:olive;">t4</span><span style="color:red;">$</span> Step4<span style="color:red;"> (orphan)</span>
+<span style="color:olive;">t3</span><span style="color:red;">$</span> Step3<span style="color:red;"> (orphan)</span>
+<span style="color:olive;">t2</span><span style="color:red;">$</span> Step2<span style="color:red;"> (orphan)</span>
<span style="color:teal;">t1</span><span style="color:teal;font-weight:bold;">@</span> <span style="color:teal;">Step1</span><span style="color:teal;font-weight:bold;"> (current)</span>
<span style="color:grey;">t0^ Trunk</span>
</pre>
@@ -1545,8 +1545,8 @@
$> hg stack
###### topic: <span style="color:green;">myfeature</span>
###### branch: feature
-<span style="color:olive;">t4</span><span style="color:red;">$</span> Step4<span style="color:red;"> (unstable)</span>
-<span style="color:olive;">t3</span><span style="color:red;">$</span> Step3<span style="color:red;"> (unstable)</span>
+<span style="color:olive;">t4</span><span style="color:red;">$</span> Step4<span style="color:red;"> (orphan)</span>
+<span style="color:olive;">t3</span><span style="color:red;">$</span> Step3<span style="color:red;"> (orphan)</span>
<span style="color:teal;">t2</span><span style="color:teal;font-weight:bold;">@</span> <span style="color:teal;">Step2</span><span style="color:teal;font-weight:bold;"> (current)</span>
<span style="color:olive;">t1</span><span style="color:green;">:</span> Step1
<span style="color:grey;">t0^ Trunk</span>
@@ -1566,7 +1566,7 @@
$> hg stack
###### topic: <span style="color:green;">myfeature</span>
###### branch: feature
-<span style="color:olive;">t4</span><span style="color:red;">$</span> Step4<span style="color:red;"> (unstable)</span>
+<span style="color:olive;">t4</span><span style="color:red;">$</span> Step4<span style="color:red;"> (orphan)</span>
<span style="color:teal;">t3</span><span style="color:teal;font-weight:bold;">@</span> <span style="color:teal;">Step3</span><span style="color:teal;font-weight:bold;"> (current)</span>
<span style="color:olive;">t2</span><span style="color:green;">:</span> Step2
<span style="color:olive;">t1</span><span style="color:green;">:</span> Step1
@@ -1838,13 +1838,13 @@
<pre>
$> hg summary
-<span style="color:olive;">parent: 10:890ac95deb83 </span>tip (unstable)
+<span style="color:olive;">parent: 10:890ac95deb83 </span>tip (orphan)
Head
branch: feature
commit: (clean)
update: (current)
phases: 9 draft
-unstable: <span style="color:red;">1 changesets</span>
+orphan: <span style="color:red;">1 changesets</span>
topic: <span style="color:green;">myfeature</span>
</pre>
@@ -1864,7 +1864,7 @@
packaging
prev-next
split
- stack_unstable_bug
+ stack_orphan_bug
tutorial
* tutorialtypos
</pre>
@@ -1883,7 +1883,7 @@
obscache (2 months ago)
evolvecolor (2 months ago)
obsrangecacheiterative (2 months ago)
- stack_unstable_bug (2 months ago)
+ stack_orphan_bug (2 months ago)
doc (3 months ago)
split (3 months ago)
import-checker (4 months ago)
@@ -1906,7 +1906,7 @@
packaging (on branch: default, 1 changesets, <span style="color:teal;">2521 behind</span>)
prev-next (on branch: default, 4 changesets, <span style="color:teal;">72 behind</span>)
split (on branch: default, 1 changesets, <span style="color:teal;">492 behind</span>)
- stack_unstable_bug (on branch: default, 1 changesets, <span style="color:teal;">474 behind</span>)
+ stack_orphan_bug (on branch: default, 1 changesets, <span style="color:teal;">474 behind</span>)
tutorial (on branch: default, 2 changesets, <span style="color:teal;">492 behind</span>)
<span style="color:green;"> * </span><span style="color:green;">tutorialtypos </span> (on branch: default, 3 changesets, <span style="color:red;">1 troubled</span>, <span style="color:olive;">2 heads</span>, <span style="color:teal;">2 behind</span>)
</pre>
@@ -1919,7 +1919,7 @@
|
o 23abfc79b7ce
|
-| o 4302274177b9 <span style="color:red;">(unstable)</span>
+| o 4302274177b9 <span style="color:red;">(orphan)</span>
| |
| <span style="color:grey;">x fba593aaaa10</span>
|/ rewritten as c55cb2ee8a91;
@@ -1931,10 +1931,10 @@
<pre>
$> hg evolve --list
<span style="color:gold;">9ac0d376e01c</span>: changelog: introduce a 'tiprev' method
- <span style="color:red;">unstable</span>: <span style="color:grey;">52ec3072fe46</span> (obsolete parent)
+ <span style="color:red;">orphan</span>: <span style="color:grey;">52ec3072fe46</span> (obsolete parent)
<span style="color:gold;">3efd3eab9860</span>: changelog: use 'tiprev()' in 'tip()'
- <span style="color:red;">unstable</span>: <span style="color:red;">9ac0d376e01c</span> (unstable parent)
+ <span style="color:red;">orphan</span>: <span style="color:red;">9ac0d376e01c</span> (orphan parent)
</pre>
(see also `hg evolve --list --rev`)
@@ -2033,7 +2033,7 @@
* Hide **most** of the complexity
-* Help with unstable situations
+* Help with orphan situations
- Automatic detection
@@ -2116,7 +2116,7 @@
}
~~~
-#### Unstable
+#### Orphan
Now called `orphan`
@@ -2129,14 +2129,14 @@
node[group=main];
Root -> New;
node[group=obsolete];
- Root -> Obsolete -> Unstable;
+ Root -> Obsolete -> Orphan;
// Obsolescence links
edge[dir=back, style=dotted, arrowtail=dot];
Obsolete -> New;
Obsolete [fillcolor="#DFDFFF"];
- Unstable [fillcolor="#FF3535"];
+ Orphan [fillcolor="#FF3535"];
Root[shape="circle"];
}
~~~
diff --git a/docs/tutorial/test-training.t b/docs/tutorial/test-training.t
--- a/docs/tutorial/test-training.t
+++ b/docs/tutorial/test-training.t
@@ -2455,7 +2455,7 @@
$ html_output $TESTDIR/output/edit-mid-stack-after-stack.log stack
### target: build/linuxsupport-v2 (branch)
- <span style="color:olive;">b3</span><span style="color:red;">$</span> Third commit on build/linuxsupport-v2<span style="color:red;"> (unstable)</span>
+ <span style="color:olive;">b3</span><span style="color:red;">$</span> Third commit on build/linuxsupport-v2<span style="color:red;"> (orphan)</span>
<span style="color:teal;">b2</span><span style="color:teal;font-weight:bold;">@</span> <span style="color:teal;">Second commit on build/linuxsupport-v2</span><span style="color:teal;font-weight:bold;"> (current)</span>
<span style="color:olive;">b1</span><span style="color:green;">:</span> First commit on build/linuxsupport-v2
b0^ New commit on build/v2 (base)
@@ -2579,7 +2579,7 @@
$ html_output $TESTDIR/output/basic-stabilize-before-evolve-list.log evolve --list
3d2c8a2356a2: Third commit on build/linuxsupport-v2
- unstable: 4686378320d7 (obsolete parent)
+ orphan: 4686378320d7 (obsolete parent)
$ html_output $TESTDIR/output/basic-stabilize-next-evolve.log next --evolve
move:[<span style="color:blue;">20</span>] Third commit on build/linuxsupport-v2
diff --git a/docs/user-guide.rst b/docs/user-guide.rst
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -336,7 +336,7 @@
So far, every obsolete changeset we have seen is also hidden. However,
these are *not* the same thing—that's why they have different names.
It's entirely possible to have obsolete changesets that are not
-hidden. We'll see examples of that soon, when we create *unstable*
+hidden. We'll see examples of that soon, when we create *orphan*
changesets.
Note that all hidden changesets are obsolete: hidden is a subset of
@@ -349,10 +349,10 @@
Now that you've got a solid understanding of how ``evolve`` works in
concert with changeset obsolescence, let's explore some more advanced
-scenarios. All of these scenarios will involve *unstable* changesets,
+scenarios. All of these scenarios will involve *orphan* changesets,
which is an unavoidable consequence of obsolescence. What really sets
``evolve`` apart from other history modification mechanisms is the
-fact that it recognizes instability like unstable changesets and provides
+fact that it recognizes instability like orphan changesets and provides
a consistent way for you to get back to a stable repository.
(Incidentally, there are two other types of instability that changesets
@@ -393,17 +393,17 @@
$ hg amend
At this point, revision 11 is *obsolete* and revisions 12 and 13—the
-descendants of 11—are in a funny state: they are *unstable*.
+descendants of 11—are in a funny state: they are *orphan*.
.. figure:: figures/figure-ug06.svg
Figure 6: amending a changeset with descendants means the amended
changeset is obsolete but remains visible; its non-obsolete
- descendants are *unstable*. The temporary amend commit, revision
+ descendants are *orphan*. The temporary amend commit, revision
14, is hidden because it has no non-obsolete descendants.
All non-obsolete descendants of an obsolete changeset are considered
-unstable. An interesting consequence of this is that revision 11 is
+orphans. An interesting consequence of this is that revision 11 is
still visible, even though it is obsolete. Obsolete changesets with
non-obsolete descendants are not hidden.
@@ -425,7 +425,7 @@
.. figure:: figures/figure-ug07.svg
Figure 7: evolve your repository (``hg evolve --all``) to take care
- of instability. Unstable changesets become obsolete, and are
+ of instability. Orphan changesets become obsolete, and are
replaced by successors just like the amended changeset was.
Example 8: Prune an older changeset
@@ -441,19 +441,19 @@
$ hg prune 19
1 changesets pruned
- 1 new unstable changesets
+ 1 new orphan changesets
As above, this leaves your repository in a funny intermediate state:
revision 20 is the non-obsolete descendant of obsolete revision 19.
-That is, revision 20 is unstable.
+That is, revision 20 is an orphan.
.. figure:: figures/figure-ug08.svg
Figure 8: ``hg prune`` marks a changeset obsolete without creating
a successor. Just like with ``hg amend``, non-obsolete descendants
- of the pruned changeset are now unstable.
+ of the pruned changeset are now orphans.
-As before, the solution to unstable changesets is to evolve your
+As before, the solution to orphan changesets is to evolve your
repository::
$ hg evolve --all
@@ -485,11 +485,11 @@
$ hg update 22
1 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ hg uncommit file2.c
- 1 new unstable changesets
+ 1 new orphan changesets
$ hg status
M file2.c
-Now your repository has unstable changesets, so you need to evolve it.
+Now your repository has orphan changesets, so you need to evolve it.
However, ``hg evolve`` requires a clean working directory to resolve merge
conflicts, so you need to decide what to do with ``file2.c``.
@@ -530,7 +530,7 @@
$ hg update -q 26
1 files updated, 0 files merged, 0 files removed, 0 files unresolved
$ hg uncommit -q file2.c # obsoletes rev 26, creates rev 28
- 1 new unstable changesets
+ 1 new orphan changesets
$ hg status
M file2.c
@@ -541,7 +541,7 @@
Figure 11 shows the story so far: ``uncommit`` obsoleted revision 26
and created revision 28, the successor of 26. Then we committed
revision 29, a child of 28. We still have to deal with the revision 27,
-which is an unstable changeset.
+which is an orphan changeset.
.. figure:: figures/figure-ug11.svg
@@ -549,7 +549,7 @@
separately will soon result in a two-headed repository.
This is where things get tricky. As usual when a repository has
-unstable changesets, we want to evolve it::
+orphan changesets, we want to evolve it::
$ hg evolve --all
@@ -561,7 +561,7 @@
.. figure:: figures/figure-ug12.svg
- Figure 12: ``evolve`` takes care of unstable changesets; it does
+ Figure 12: ``evolve`` takes care of orphan changesets; it does
not solve all the world's problems.
As usual when faced with a two-headed repository, you can either merge
@@ -594,7 +594,7 @@
change in the future. Consider the history in Figure 12, where revision 27
is obsolete and the child of 26, also obsolete. If we ``hg touch 27``, that
creates a new revision which is a non-obsolete child of 26—i.e., it is an
-unstable. It's also *divergent*, another type of trouble that we'll learn
+orphan. It's also *divergent*, another type of trouble that we'll learn
about in the `next section`_.
.. _`next section`: sharing.html
More information about the Mercurial-devel
mailing list