From: Colin Walters <walters@verbum.org>
Date: Thu, 9 Jun 2022 22:34:25 +0000 (-0400)
Subject: repo: Document non-obvious way to list all commits
X-Git-Tag: archive/raspbian/2022.5-1+rpi1^2~9^2^2~27^2~1
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=a13d812368639865bacb59237e33a6a09035b771;p=ostree.git

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.
---

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