From: Krzesimir Nowak <krzesimir@kinvolk.io>
Date: Fri, 2 Jun 2017 12:50:29 +0000 (+0200)
Subject: lib/sysroot: Document the NO_CLEAN flag
X-Git-Tag: archive/raspbian/2022.1-3+rpi1~1^2~4^2~36^2~51
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=2fdbdd4b2f2b13b3b99cb2ef993e56445a5d1550;p=ostree.git

lib/sysroot: Document the NO_CLEAN flag

Closes: #900
Approved by: jlebon
---

diff --git a/src/libostree/ostree-sysroot.c b/src/libostree/ostree-sysroot.c
index b8f494bf..03e742f1 100644
--- a/src/libostree/ostree-sysroot.c
+++ b/src/libostree/ostree-sysroot.c
@@ -1412,6 +1412,11 @@ ostree_sysroot_init_osname (OstreeSysroot       *self,
  * If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_NOT_DEFAULT is
  * specified, then instead of prepending, the new deployment will be
  * added right after the booted or merge deployment, instead of first.
+ *
+ * If %OSTREE_SYSROOT_SIMPLE_WRITE_DEPLOYMENT_FLAGS_NO_CLEAN is
+ * specified, then no cleanup will be performed after adding the
+ * deployment. Make sure to call ostree_sysroot_cleanup() sometime
+ * later, instead.
  */
 gboolean
 ostree_sysroot_simple_write_deployment (OstreeSysroot      *sysroot,