summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJonathan Lebon <jonathan@jlebon.com>2018-07-30 10:54:15 -0400
committerAtomic Bot <atomic-devel@projectatomic.io>2018-08-01 19:59:07 +0000
commit72a54fa877e7b459ab4dc19dbb5cc288f219b41c (patch)
tree25650776ece705fc6cd0fe0212243558d82c8bbc /man
parent786ee6bdec8cac24b127af7828659d71702d4f8e (diff)
downloadostree-72a54fa877e7b459ab4dc19dbb5cc288f219b41c.tar.gz
lib/config: Deprecate commit-update-summary option
Now that we have `auto-update-summary`, there is no point in having `commit-update-summary`. The latter also only had an effect through the `commit` CLI command, whereas the former is embedded directly in libostree. There is one corner case that slips through: `commit` would update the summary file even if orphan commits were created, which we no longer do here. I can't imagine anyone relying on this, so it seems safe to drop. Closes: #1689 Closes: #1693 Approved by: mwleeds
Diffstat (limited to 'man')
-rw-r--r--man/ostree.repo-config.xml20
1 files changed, 10 insertions, 10 deletions
diff --git a/man/ostree.repo-config.xml b/man/ostree.repo-config.xml
index 5424467c..bb406a2e 100644
--- a/man/ostree.repo-config.xml
+++ b/man/ostree.repo-config.xml
@@ -87,23 +87,23 @@ Boston, MA 02111-1307, USA.
</varlistentry>
<varlistentry>
- <term><varname>commit-update-summary</varname></term>
- <listitem><para>Boolean value controlling whether or not to
- automatically update the summary file after a commit. Defaults
- to <literal>false</literal>.</para></listitem>
- </varlistentry>
-
- <varlistentry>
<term><varname>auto-update-summary</varname></term>
<listitem><para>Boolean value controlling whether or not to
automatically update the summary file after any ref is added,
- removed, or updated. This covers a superset of the cases covered by
- commit-update-summary, with the exception of orphan commits which
- shouldn't affect the summary anyway. Defaults to <literal>false</literal>.
+ removed, or updated. Other modifications which may render a
+ summary file stale (like static deltas, or collection IDs) do
+ not currently trigger an auto-update.
</para></listitem>
</varlistentry>
<varlistentry>
+ <term><varname>commit-update-summary</varname></term>
+ <listitem><para>This option is deprecated. Use
+ <literal>auto-update-summary</literal> instead, for which this
+ option is now an alias.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><varname>fsync</varname></term>
<listitem><para>Boolean value controlling whether or not to
ensure files are on stable storage when performing operations