From 1b61cd1597068dbba2ef1ac6018339cf91c19b70 Mon Sep 17 00:00:00 2001
From: Adriaan de Groot <groot@kde.org>
Date: Tue, 5 Jul 2022 14:24:31 +0200
Subject: FreeBSD: explain the pkg_create() call

- the upstream API is undocumented, so dig in the C sources
  to get parameter names.
---
 Source/CPack/cmCPackFreeBSDGenerator.cxx | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/Source/CPack/cmCPackFreeBSDGenerator.cxx b/Source/CPack/cmCPackFreeBSDGenerator.cxx
index 9f04925..4f07ad4 100644
--- a/Source/CPack/cmCPackFreeBSDGenerator.cxx
+++ b/Source/CPack/cmCPackFreeBSDGenerator.cxx
@@ -81,6 +81,14 @@ public:
   {
     if (!isValid())
       return false;
+    // The API in the FreeBSD sources (the header has no documentation),
+    // is as follows:
+    //
+    // int pkg_create(struct pkg_create *pc, const char *metadata, const char
+    // *plist, bool hash)
+    //
+    // We let the plist be determined from what is installed, and all
+    // the rest comes from the manifest data.
     int r = pkg_create(d, manifest.c_str(), nullptr, false);
     return r == 0;
   }
-- 
cgit v0.12