lib/repo: Clarify that ostree_repo_remote_fetch_summary() doesn’t verify
authorPhilip Withnall <withnall@endlessm.com>
Thu, 5 Oct 2017 10:14:41 +0000 (11:14 +0100)
committerAtomic Bot <atomic-devel@projectatomic.io>
Thu, 5 Oct 2017 12:48:28 +0000 (12:48 +0000)
Make that a bit clearer in the documentation.

Signed-off-by: Philip Withnall <withnall@endlessm.com>
Closes: #1253
Approved by: cgwalters

src/libostree/ostree-repo.c

index 4357d5622c340d0597b82c8649afdcdc1fbfd001..594973532783c829d73d36218cabec9d0d88db5d 100644 (file)
@@ -1711,6 +1711,9 @@ out:
  * @NULL.  Likewise if the summary file is not signed, @out_signatures is
  * set to @NULL.  In either case the function still returns %TRUE.
  *
+ * This method does not verify the signature of the downloaded summary file.
+ * Use ostree_repo_verify_summary() for that.
+ *
  * Parse the summary data into a #GVariant using g_variant_new_from_bytes()
  * with #OSTREE_SUMMARY_GVARIANT_FORMAT as the format string.
  *