summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorColin Walters <walters@verbum.org>2018-03-05 17:18:54 -0500
committerAtomic Bot <atomic-devel@projectatomic.io>2018-03-06 14:02:32 +0000
commit1c9baad8a886399ef2362420fe34c4718d06f0de (patch)
tree2ca2fdf9eb4057a39d02657ae6c98b0da571d6b8
parent969e4eb72e9aff95024bc460b2d6b50bce5136f6 (diff)
downloadostree-1c9baad8a886399ef2362420fe34c4718d06f0de.tar.gz
docs/prune: Document that --static-deltas-only isn't that useful
This is the documentation followup to: https://github.com/ostreedev/ostree/pull/1482 See also https://github.com/ostreedev/ostree/issues/1481 Closes: #1484 Approved by: jlebon
-rw-r--r--man/ostree-prune.xml8
1 files changed, 6 insertions, 2 deletions
diff --git a/man/ostree-prune.xml b/man/ostree-prune.xml
index 641176ba..f1b517f3 100644
--- a/man/ostree-prune.xml
+++ b/man/ostree-prune.xml
@@ -114,8 +114,12 @@ Boston, MA 02111-1307, USA.
<term><option>--static-deltas-only</option>=DEPTH</term>
<listitem><para>
- Change the behaviour of --keep-younger-than and --delete-commit to prune only
- the static deltas files.
+ This option may currently <emphasis>only</emphasis> be used in combination with
+ <option>--delete-commit</option>. Previous versions of ostree silently accepted
+ the option without that, and ignored it. However, there are desired use
+ cases for pruning just static deltas (while retaining the commits), and it's
+ likely at some point this option will be supported for use cases outside of just
+ <option>--delete-commit</option>.
</para></listitem>
</varlistentry>
</variablelist>