From f191e6fe987f72519dbc14da1b10b92b549e6356 Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Tue, 29 Jul 2025 11:56:45 +0200 Subject: [PATCH] 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 Signed-off-by: Richard Purdie --- documentation/ref-manual/classes.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 0f4405b98f..586930f667 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``