From 48624c99ad66dbc20833f2c08e24a0e537518958 Mon Sep 17 00:00:00 2001 From: Matthew Leeds Date: Tue, 25 Jun 2019 16:58:38 -0700 Subject: [PATCH] lib/repo: Improve docs for get_min_free_space_bytes() Closes: #1879 Approved by: jlebon --- src/libostree/ostree-repo.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/libostree/ostree-repo.c b/src/libostree/ostree-repo.c index c6860408..804ff6c6 100644 --- a/src/libostree/ostree-repo.c +++ b/src/libostree/ostree-repo.c @@ -3496,7 +3496,10 @@ ostree_repo_get_mode (OstreeRepo *self) * @out_reserved_bytes: (out): Location to store the result * @error: Return location for a #GError * - * It can be used to query the value (in bytes) of min-free-space-* config option. + * Determine the number of bytes of free disk space that are reserved according + * to the repo config and return that number in @out_reserved_bytes. See the + * documentation for the core.min-free-space-size and + * core.min-free-space-percent repo config options. * * Returns: %TRUE on success, %FALSE otherwise. * Since: 2018.9