From 43977dffdea5d2a640e9c0abd01c20b5d4a726f2 Mon Sep 17 00:00:00 2001 From: Philip Withnall Date: Wed, 4 Oct 2017 12:17:31 +0100 Subject: [PATCH] docs: Clarify %NULL argument to ostree_sysroot_new() MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit It’s equivalent to ostree_sysroot_new_default(). Signed-off-by: Philip Withnall Closes: #1246 Approved by: cgwalters --- src/libostree/ostree-sysroot.c | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/libostree/ostree-sysroot.c b/src/libostree/ostree-sysroot.c index fe61a12e..b49b4277 100644 --- a/src/libostree/ostree-sysroot.c +++ b/src/libostree/ostree-sysroot.c @@ -201,7 +201,12 @@ ostree_sysroot_init (OstreeSysroot *self) /** * ostree_sysroot_new: - * @path: (allow-none): Path to a system root directory, or %NULL + * @path: (allow-none): Path to a system root directory, or %NULL to use the + * current visible root file system + * + * Create a new #OstreeSysroot object for the sysroot at @path. If @path is %NULL, + * the current visible root file system is used, equivalent to + * ostree_sysroot_new_default(). * * Returns: (transfer full): An accessor object for an system root located at @path */