shaba/ostree
1
0
Fork 0
mirror of https://github.com/ostreedev/ostree.git synced 2025-01-18 10:04:17 +03:00
Code Issues Projects Releases Wiki Activity

docs: Clarify %NULL argument to ostree_sysroot_new()

Browse Source 
It’s equivalent to ostree_sysroot_new_default().

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

Closes: #1246
Approved by: cgwalters
This commit is contained in:
Philip Withnall 2017-10-04 12:17:31 +01:00 committed by Atomic Bot
parent c3c13846ad
commit 43977dffde
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/libostree/ostree-sysroot.c
View File

@ -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
*/