summaryrefslogtreecommitdiff
path: root/cli/spdxtool/generate.h
diff options
context:
space:
mode:
Diffstat (limited to 'cli/spdxtool/generate.h')
-rw-r--r--cli/spdxtool/generate.h29
1 files changed, 29 insertions, 0 deletions
diff --git a/cli/spdxtool/generate.h b/cli/spdxtool/generate.h
new file mode 100644
index 000000000000..818b8e4d9192
--- /dev/null
+++ b/cli/spdxtool/generate.h
@@ -0,0 +1,29 @@
+/*
+ * SPDX-License-Identifier: BSD-2-Clause
+ *
+ *​ Copyright (c) 2025 The FreeBSD Foundation
+ *​
+ *​ Portions of this software were developed by
+ * Tuukka Pasanen <tuukka.pasanen@ilmi.fi> under sponsorship from
+ * the FreeBSD Foundation
+ */
+
+#ifndef SPDXTOOL_GENERATE_H
+#define SPDXTOOL_GENERATE_H
+
+#include <stdio.h>
+#include <libpkgconf/libpkgconf.h>
+
+/*
+ * Build an SPDX SBOM for a solved dependency graph and write it to *out*.
+ *
+ * The dependency graph rooted at *world* must already have been solved (e.g.
+ * with pkgconf_queue_solve) so that every package's match is populated. The
+ * spdxtool_util_set_* configuration (URI root, separator, version, license)
+ * must have been applied to *client* beforehand.
+ */
+bool spdxtool_generate(pkgconf_client_t *client, pkgconf_pkg_t *world, FILE *out,
+ int maxdepth, const char *creation_time, const char *creation_id,
+ const char *agent_name);
+
+#endif