Yocto Project Documentation
 help / color / mirror / Atom feed
From: Joshua Watt <jpewhacker@gmail.com>
To: docs@lists.yoctoproject.org
Cc: Joshua Watt <JPEWhacker@gmail.com>
Subject: [docs][PATCH 2/2] ref-manual/variables.rst: Document SPDX_AUTHORS
Date: Mon, 14 Sep 2026 10:08:36 -0600	[thread overview]
Message-ID: <20260914160836.1673868-2-JPEWhacker@gmail.com> (raw)
In-Reply-To: <20260914160836.1673868-1-JPEWhacker@gmail.com>

Document the SPDX_AUTHORS variable. There was some confusion about how
this variable works compared to the other single-agent variables, so
adding explicit documentation that indicates how it diverges is useful.

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
---
 documentation/ref-manual/variables.rst | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index e1d3cd70f..4ec4ce988 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -9499,6 +9499,29 @@ system and gives an overview of their function and contents.
       ``SPDX_IMPORTS``, :term:`SPDX_INVOKED_BY`,
       and :term:`SPDX_ON_BEHALF_OF`.
 
+   :term:`SPDX_AUTHORS`
+      This variable is used to list the authors of the created SPDX data.
+      It works slightly differently than the other agent variables (like
+      :term:`SPDX_IMAGE_SUPPLIER`) in that the base variable provides a list of
+      suffixes which are used to construct the variable prefixes for the
+      created authors. For example::
+
+        SPDX_AUTHORS = "myorg myself"
+        SPDX_AUTHORS_myorg_name = "My Organization"
+        SPDX_AUTHORS_myorg_type = "organization"
+        SPDX_AUTHORS_myself_name = "My Name"
+        SPDX_AUTHORS_myself_type = "Person"
+
+
+      Note that references to other objects can be made using the ``_ref``
+      suffix, for example::
+
+        SPDX_AUTHORS_myself_ref = "SPDX_IMAGE_SUPPLIER"
+
+      And other variables can reference authors by using the correct prefix::
+
+        SPDX_IMAGE_SUPPLIER_ref = "SPDX_AUTHORS_myorg"
+
    :term:`SPDX_CONCLUDED_LICENSE`
       The :term:`SPDX_CONCLUDED_LICENSE` variable allows overriding the
       ``hasConcludedLicense`` object to individual SBOM packages. This can be
-- 
2.55.0



  reply	other threads:[~2026-09-14 16:08 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-14 16:08 [docs][PATCH 1/2] ref-manual/variables.rst: Fix the documentation for the SPDX agent variables Joshua Watt
2026-09-14 16:08 ` Joshua Watt [this message]
2026-09-17 14:52 ` Antonin Godard

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260914160836.1673868-2-JPEWhacker@gmail.com \
    --to=jpewhacker@gmail.com \
    --cc=docs@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox