diff mbox series

[v1,1/3] classes: document new go-vendor class

Message ID 20240405100355.2268926-2-joaomarcos.costa@bootlin.com
State New
Headers show
Series Add missing parts to Go language changes | expand

Commit Message

Joao Marcos Costa April 5, 2024, 10:03 a.m. UTC
From: Joao Marcos Costa <joaomarcos.costa@bootlin.com>

A reference to this class in the release notes will be added in a
follow-up commit.

Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
---
 documentation/ref-manual/classes.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)

Comments

Michael Opdenacker April 5, 2024, 12:35 p.m. UTC | #1
Hi João,

Thanks for the updates!
See my edits below...

On 4/5/24 at 12:03, joaomarcos.costa@bootlin.com wrote:
> From: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
>
> A reference to this class in the release notes will be added in a
> follow-up commit.
>
> Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com>
> ---
>   documentation/ref-manual/classes.rst | 13 +++++++++++++
>   1 file changed, 13 insertions(+)
>
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index 8612128f7..272df0dfb 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -939,6 +939,19 @@ 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-vendor:
> +
> +``go-vendor``
> +=============
> +
> +The :ref:`ref-classes-go-vendor` class implements support to offline builds,
s/support to/support for/
> +also known as Go vendoring. In such scenario, the module dependencias are
s/such/such a/
> +downloaded during fetch task rather than when modules are imported, thus bein
s/fetch task/the :ref:`ref-tasks-fetch` task/
Yes, we also have references to tasks :)
> g
> +coherent with Yocto's concept of fetching every source beforehand.
> +
> +The dependencies are unpacked into the modules' ``vendor`` directory, where a
> +manifest file is generated.
> +
>   .. _ref-classes-gobject-introspection:
>   
>   ``gobject-introspection``


I fixed all these by myself. Nothing to do on your side.
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Merged into "master-next"
Cheers
Michael.
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 8612128f7..272df0dfb 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -939,6 +939,19 @@  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-vendor:
+
+``go-vendor``
+=============
+
+The :ref:`ref-classes-go-vendor` class implements support to offline builds,
+also known as Go vendoring. In such scenario, the module dependencias are
+downloaded during fetch task rather than when modules are imported, thus being
+coherent with Yocto's concept of fetching every source beforehand.
+
+The dependencies are unpacked into the modules' ``vendor`` directory, where a
+manifest file is generated.
+
 .. _ref-classes-gobject-introspection:
 
 ``gobject-introspection``