diff mbox series

[11/19] ref-manual/classes.rst: document the go-mod-update-modules class

Message ID 20250729-release-note-5-3-first-bunch-v1-11-058971e37c93@bootlin.com
State New
Headers show
Series Updates from Poky master | expand

Commit Message

Antonin Godard July 29, 2025, 9:56 a.m. UTC 
Added by commit 34bb889ffaae ("classes/go-mod-update-modules: add class
to generate module list") in OE-Core.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/classes.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 0f4405b98..586930f66 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1003,6 +1003,21 @@  The :ref:`ref-classes-go-mod` class allows to use Go modules, and inherits the
 
 See the associated :term:`GO_WORKDIR` variable.
 
+.. _ref-classes-go-mod-update-modules:
+
+``go-mod-update-modules``
+=========================
+
+The :ref:`ref-classes-go-mod-update-modules` class can be used in Go recipes and
+defines a ``do_update_modules`` task that can be run manually to update two
+files ("BPN" below corresponds to :term:`BPN`):
+
+-  ``BPN-go-mods.inc``: list of Go modules the recipe depends on.
+-  ``BPN-licenses.inc``: list of licenses for each Go modules the recipe depends
+   on.
+
+These files can then updated automatically with the ``do_update_modules`` task.
+
 .. _ref-classes-go-vendor:
 
 ``go-vendor``