ref-manual/classes.rst: document the go-mod-update-modules class

Added by commit 34bb889ffaae ("classes/go-mod-update-modules: add class
to generate module list") in OE-Core.

(From yocto-docs rev: b1a9848d2bba9e1392d153ff992304b83b259318)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Antonin Godard
2025-07-29 11:56:45 +02:00
committed by Richard Purdie
parent ba0d3de2d7
commit f191e6fe98

View File

@@ -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``