packaging
/
ostree
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

repo: Document non-obvious way to list all commits 

I was going to add an API for this and then realized the empty
string does it.
This commit is contained in:
Colin Walters 2022-06-09 18:34:25 -04:00
parent 10212626d2
commit a13d812368
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/libostree/ostree-repo.c
View File

@ -4999,7 +4999,7 @@ ostree_repo_list_objects (OstreeRepo *self,
/** /**
* ostree_repo_list_commit_objects_starting_with: * ostree_repo_list_commit_objects_starting_with:
* @self: Repo * @self: Repo
* @start: List commits starting with this checksum * @start: List commits starting with this checksum (empty string for all)
* @out_commits: (out) (transfer container) (element-type GVariant GVariant): * @out_commits: (out) (transfer container) (element-type GVariant GVariant):
* Map of serialized commit name to variant data * Map of serialized commit name to variant data
* @cancellable: Cancellable * @cancellable: Cancellable
@ -5008,6 +5008,8 @@ ostree_repo_list_objects (OstreeRepo *self,
* This function synchronously enumerates all commit objects starting * This function synchronously enumerates all commit objects starting
* with @start, returning data in @out_commits. * with @start, returning data in @out_commits.
* *
* To list all commit objects, provide the empty string `""` for @start.
*
* Returns: %TRUE on success, %FALSE on error, and @error will be set * Returns: %TRUE on success, %FALSE on error, and @error will be set
*/ */
gboolean gboolean