From: Philip Withnall <withnall@endlessm.com>
Date: Mon, 23 Oct 2017 14:59:31 +0000 (+0100)
Subject: lib/sysroot: Expand docs for ostree_sysroot_get_repo()
X-Git-Tag: archive/raspbian/2022.1-3+rpi1~1^2~4^2~30^2~23
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=4c0f67be0cf0ad28c99bfdef0641af98a2a02d5e;p=ostree.git

lib/sysroot: Expand docs for ostree_sysroot_get_repo()

Add some missing annotations and clarify that it always returns an open
repository on success.

Signed-off-by: Philip Withnall <withnall@endlessm.com>

Closes: #1300
Approved by: cgwalters
---

diff --git a/src/libostree/ostree-sysroot.c b/src/libostree/ostree-sysroot.c
index ac418486..f9d8fb8c 100644
--- a/src/libostree/ostree-sysroot.c
+++ b/src/libostree/ostree-sysroot.c
@@ -983,11 +983,14 @@ ostree_sysroot_get_deployment_origin_path (GFile   *deployment_path)
 /**
  * ostree_sysroot_get_repo:
  * @self: Sysroot
- * @out_repo: (out): Repository in sysroot @self
+ * @out_repo: (out) (transfer full) (optional): Repository in sysroot @self
  * @cancellable: Cancellable
  * @error: Error
  *
- * Retrieve the OSTree repository in sysroot @self.
+ * Retrieve the OSTree repository in sysroot @self. The repo is guaranteed to be open
+ * (see ostree_repo_open()).
+ *
+ * Returns: %TRUE on success, %FALSE otherwise
  */
 gboolean
 ostree_sysroot_get_repo (OstreeSysroot         *self,