diff options
| author | Philip Withnall <withnall@endlessm.com> | 2017-10-23 15:59:31 +0100 |
|---|---|---|
| committer | Atomic Bot <atomic-devel@projectatomic.io> | 2017-10-23 16:17:20 +0000 |
| commit | 4c0f67be0cf0ad28c99bfdef0641af98a2a02d5e (patch) | |
| tree | a99b5bf12ac3f83d83b8737128e2371dedac6f82 | |
| parent | 795a953a3605e7caab14ecda5d48d70276126bff (diff) | |
| download | ostree-4c0f67be0cf0ad28c99bfdef0641af98a2a02d5e.tar.gz | |
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
| -rw-r--r-- | src/libostree/ostree-sysroot.c | 7 |
1 files changed, 5 insertions, 2 deletions
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, |