Author: julianfoad
Date: Mon Sep 24 12:56:49 2018
New Revision: 1841839
URL: http://svn.apache.org/viewvc?rev=1841839&view=rev
Log:
* publish/docs/release-notes/1.11.html
(checkpointing): Rewrite to emphasize it's only a part of what checkpointing
could ultimately be. Make the command table more accurate.
Modified:
subversion/site/publish/docs/release-notes/1.11.html
Modified: subversion/site/publish/docs/release-notes/1.11.html
URL:
http://svn.apache.org/viewvc/subversion/site/publish/docs/release-notes/1.11.html?rev=1841839&r1=1841838&r2=1841839&view=diff
==============================================================================
--- subversion/site/publish/docs/release-notes/1.11.html (original)
+++ subversion/site/publish/docs/release-notes/1.11.html Mon Sep 24 12:56:49
2018
@@ -38,7 +38,7 @@
<li><a href="#shelving"
>Improved Shelving (experimental)</a></li>
<li><a href="#checkpointing"
- >Checkpointing (experimental)</a></li>
+ >Commit checkpointing (experimental)</a></li>
<li><a href="#conflict-resolver"
>Improvements to the Conflict Resolver</a></li>
<li><a href="#enhancements"
@@ -121,7 +121,7 @@ and what impact these changes may have.<
<a href="#shelving-transition">the transition notes</a></td></tr>
<tr>
<td>
- <a href="#checkpointing">Checkpointing (experimental)</a>
+ <a href="#checkpointing">Commit checkpointing (experimental)</a>
</td>
<td>1.11</td>
<td>any</td>
@@ -243,16 +243,15 @@ PGP digital signatures and SHA-512 check
</h2>
<div class="h3" id="checkpointing">
-<h3>Checkpointing (experimental)
+<h3>Commit checkpointing (experimental)
<a class="sectionlink" href="#checkpointing"
title="Link to this section">¶</a>
</h3>
-<p>Checkpointing (<a
-href="https://issues.apache.org/jira/browse/SVN-3626";>issue #3626</a>)
-is the ability to save a snapshot of an uncommitted change in the WC from
-time to time, and later restore the working copy to one of those previous
-snapshots.</p>
+<p>Subversion 1.11 provides an experimental first cut at solving some of the
+use cases envisioned in <a
+href="https://issues.apache.org/jira/browse/SVN-3626";>issue #3626</a> named
+"Commit checkpointing".</p>
<div class="notice">
<p><span style="color: red"><b>WARNING:</b></span> The checkpointing feature
@@ -262,33 +261,46 @@ snapshots.</p>
while it remains experimental.</p>
</div>
-<p>The implementation is based on letting a shelf contain multiple
-versions. Therefore, see also <a href="#shelving"> Shelving</a>.</p>
-
-<p>The main checkpointing operations are, as listed in <a
href="https://cwiki.apache.org/confluence/x/70cYBQ";>the Wiki page</a>:</p>
+<p>It provides the ability to save a snapshot of an uncommitted change from
+time to time, and later restore one of those previous versions of your
+change back into the working copy.</p>
+
+<p>It does not provide the kind of exact WC state roll back that is also
+discussed in that issue, that could make it possible after a messy update to
+roll back to the exact WC state that existed just before. This remains a
+future possibility.</p>
+
+<p>The ability to checkpoint and roll back an uncommitted change is provided
+within the shelving feature, by letting a shelf hold multiple versions of
+your change. Therefore, see also <a href="#shelving"> Shelving</a>.</p>
+
+<p>The main checkpointing operations are accomplished by the following
+commands, as also listed in
+<a href="https://cwiki.apache.org/confluence/x/70cYBQ";>the Wiki page</a>:</p>
<table>
-<tr><th>Save a checkpoint</th>
- <td><tt>svn x-shelf-save foo</tt></td>
- <td>copy the local changes into a new version of shelf 'foo'<br/>
+<tr><th>Save a checkpoint and continue</th>
+ <td><tt>svn x-<b>shelf-save</b> foo</tt></td>
+ <td>copy the local changes into a new version of shelf 'foo';<br/>
doesn't revert the changes from the WC</td>
</tr>
-<tr><th></th>
- <td><tt>svn x-shelve foo</tt></td>
+<tr><th>Save a checkpoint and shelve</th>
+ <td><tt>svn x-<b>shelve</b> foo</tt></td>
<td>move the local changes into a new version of shelf 'foo'<br/>
and revert the changes from the WC</td>
</tr>
<tr><th>Restore / roll back</th>
- <td><tt>svn x-unshelve foo 3</tt></td>
- <td>unshelve version 3 of shelf 'foo'<br/>
+ <td>first revert your unwanted changes; then<br/>
+ <tt>svn x-<b>unshelve</b> foo 3</tt></td>
+ <td>apply version 3 of shelf 'foo' to the WC<br/>
and delete any newer versions</td>
</tr>
<tr><th>Review checkpoints</th>
- <td><tt>svn x-shelf-log foo</tt></td>
+ <td><tt>svn x-<b>shelf-log</b> foo</tt></td>
<td>list all the versions of shelf 'foo'</td>
</tr>
<tr><th></th>
- <td><tt>svn x-shelf-diff foo 3</tt></td>
+ <td><tt>svn x-<b>shelf-diff</b> foo 3</tt></td>
<td>show version 3 as a diff</td>
</tr>
</table>
