From a13d812368639865bacb59237e33a6a09035b771 Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Thu, 9 Jun 2022 18:34:25 -0400 Subject: [PATCH] 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. --- src/libostree/ostree-repo.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/libostree/ostree-repo.c b/src/libostree/ostree-repo.c index e823e19e..9b29bd3f 100644 --- a/src/libostree/ostree-repo.c +++ b/src/libostree/ostree-repo.c @@ -4999,7 +4999,7 @@ ostree_repo_list_objects (OstreeRepo *self, /** * ostree_repo_list_commit_objects_starting_with: * @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): * Map of serialized commit name to variant data * @cancellable: Cancellable @@ -5008,6 +5008,8 @@ ostree_repo_list_objects (OstreeRepo *self, * This function synchronously enumerates all commit objects starting * 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 */ gboolean