* [PATCH] ref-manual: extend/add HOSTTOOLS, HOSTTOOLS_DIR defns
@ 2021-03-24 16:43 Robert P. J. Day
2021-03-24 17:09 ` [docs] " Quentin Schulz
0 siblings, 1 reply; 3+ messages in thread
From: Robert P. J. Day @ 2021-03-24 16:43 UTC (permalink / raw)
To: YP docs mailing list
Tighten up the definition for HOSTTOOLS, and add an entry for
HOSTTOOLS_DIR.
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
---
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 0310429bd..80b73f70c 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2793,16 +2793,22 @@ system and gives an overview of their function and contents.
Linux, the value might be "mipsel-linux".
:term:`HOSTTOOLS`
- A space-separated list (filter) of tools on the build host that
- should be allowed to be called from within build tasks. Using this
- filter helps reduce the possibility of host contamination. If a tool
- specified in the value of ``HOSTTOOLS`` is not found on the build
- host, the OpenEmbedded build system produces an error and the build
- is not started.
+ A space-separated list (filter) of tools that must exist on the
+ build host and which will be called from within build tasks.
+ If a tool specified in the value of ``HOSTTOOLS`` is not found
+ on the build host, the OpenEmbedded build system produces an error
+ and the build is not started.
- For additional information, see
+ For additional information, see the related
:term:`HOSTTOOLS_NONFATAL`.
+ :term:`HOSTTOOLS_DIR`
+ The directory which contains symlinks to all of the host tools
+ specified by ``HOSTTOOLS``, as well as any of the available
+ host tools specified by ``HOSTTOOLS_NONFATAL``.
+ The default value for this directory is typically
+ ``${TMPDIR}/hosttools``.
+
:term:`HOSTTOOLS_NONFATAL`
A space-separated list (filter) of tools on the build host that
should be allowed to be called from within build tasks. Using this
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
^ permalink raw reply related [flat|nested] 3+ messages in thread* Re: [docs] [PATCH] ref-manual: extend/add HOSTTOOLS, HOSTTOOLS_DIR defns
2021-03-24 16:43 [PATCH] ref-manual: extend/add HOSTTOOLS, HOSTTOOLS_DIR defns Robert P. J. Day
@ 2021-03-24 17:09 ` Quentin Schulz
2021-03-24 17:16 ` Robert P. J. Day
0 siblings, 1 reply; 3+ messages in thread
From: Quentin Schulz @ 2021-03-24 17:09 UTC (permalink / raw)
To: Robert P. J. Day; +Cc: YP docs mailing list
Hi Robert,
Nitpicking, I'll leave the review of the essence of the patch to people
who know more about it.
On Wed, Mar 24, 2021 at 12:43:52PM -0400, Robert P. J. Day wrote:
> Tighten up the definition for HOSTTOOLS, and add an entry for
> HOSTTOOLS_DIR.
>
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
>
> ---
>
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 0310429bd..80b73f70c 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -2793,16 +2793,22 @@ system and gives an overview of their function and contents.
> Linux, the value might be "mipsel-linux".
>
> :term:`HOSTTOOLS`
> - A space-separated list (filter) of tools on the build host that
> - should be allowed to be called from within build tasks. Using this
> - filter helps reduce the possibility of host contamination. If a tool
> - specified in the value of ``HOSTTOOLS`` is not found on the build
> - host, the OpenEmbedded build system produces an error and the build
> - is not started.
> + A space-separated list (filter) of tools that must exist on the
> + build host and which will be called from within build tasks.
> + If a tool specified in the value of ``HOSTTOOLS`` is not found
> + on the build host, the OpenEmbedded build system produces an error
> + and the build is not started.
>
> - For additional information, see
> + For additional information, see the related
> :term:`HOSTTOOLS_NONFATAL`.
>
> + :term:`HOSTTOOLS_DIR`
> + The directory which contains symlinks to all of the host tools
> + specified by ``HOSTTOOLS``, as well as any of the available
:term:`HOSTTOOLS`
> + host tools specified by ``HOSTTOOLS_NONFATAL``.
:term:`HOSTTOOLS_NONFATAL`
> + The default value for this directory is typically
> + ``${TMPDIR}/hosttools``.
I don't remember if :term: can be surrounded in ``, but if it can :term:
would make sense too here (it probably can't but better know it for sure
:) )
Quentin
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: [docs] [PATCH] ref-manual: extend/add HOSTTOOLS, HOSTTOOLS_DIR defns
2021-03-24 17:09 ` [docs] " Quentin Schulz
@ 2021-03-24 17:16 ` Robert P. J. Day
0 siblings, 0 replies; 3+ messages in thread
From: Robert P. J. Day @ 2021-03-24 17:16 UTC (permalink / raw)
To: Quentin Schulz; +Cc: YP docs mailing list
On Wed, 24 Mar 2021, Quentin Schulz wrote:
> Hi Robert,
>
> Nitpicking, I'll leave the review of the essence of the patch to people
> who know more about it.
>
> On Wed, Mar 24, 2021 at 12:43:52PM -0400, Robert P. J. Day wrote:
> > Tighten up the definition for HOSTTOOLS, and add an entry for
> > HOSTTOOLS_DIR.
> >
> > Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
> >
> > ---
> >
> > diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> > index 0310429bd..80b73f70c 100644
> > --- a/documentation/ref-manual/variables.rst
> > +++ b/documentation/ref-manual/variables.rst
> > @@ -2793,16 +2793,22 @@ system and gives an overview of their function and contents.
> > Linux, the value might be "mipsel-linux".
> >
> > :term:`HOSTTOOLS`
> > - A space-separated list (filter) of tools on the build host that
> > - should be allowed to be called from within build tasks. Using this
> > - filter helps reduce the possibility of host contamination. If a tool
> > - specified in the value of ``HOSTTOOLS`` is not found on the build
> > - host, the OpenEmbedded build system produces an error and the build
> > - is not started.
> > + A space-separated list (filter) of tools that must exist on the
> > + build host and which will be called from within build tasks.
> > + If a tool specified in the value of ``HOSTTOOLS`` is not found
> > + on the build host, the OpenEmbedded build system produces an error
> > + and the build is not started.
> >
> > - For additional information, see
> > + For additional information, see the related
> > :term:`HOSTTOOLS_NONFATAL`.
> >
> > + :term:`HOSTTOOLS_DIR`
> > + The directory which contains symlinks to all of the host tools
> > + specified by ``HOSTTOOLS``, as well as any of the available
>
> :term:`HOSTTOOLS`
>
> > + host tools specified by ``HOSTTOOLS_NONFATAL``.
>
> :term:`HOSTTOOLS_NONFATAL`
>
> > + The default value for this directory is typically
> > + ``${TMPDIR}/hosttools``.
>
> I don't remember if :term: can be surrounded in ``, but if it can :term:
> would make sense too here (it probably can't but better know it for sure
> :) )
i was actually grappling with that, i think it was only because they
were all next to each other that i got lazy.
rday
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-03-24 17:16 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-24 16:43 [PATCH] ref-manual: extend/add HOSTTOOLS, HOSTTOOLS_DIR defns Robert P. J. Day
2021-03-24 17:09 ` [docs] " Quentin Schulz
2021-03-24 17:16 ` Robert P. J. Day
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.