diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-09-26 13:19:10 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-10-04 14:33:50 +0100 |
commit | 6d9de01c181066326365ff743c4c4cb5707db1e2 (patch) | |
tree | 9740a45d542e6ae39599d226c614e6b889d42b17 | |
parent | a2d14e5b6d218fe778d75afbb5b76e153f909f21 (diff) | |
download | poky-6d9de01c181066326365ff743c4c4cb5707db1e2.tar.gz |
ref-manual: Updates to native.bbclass
Fixes [YOCTO #12924]
Naming convention does not apply to the second recipe-creation
method described in this class. I have moved the note about that
to be under the applicable method (i.e. the first bullet).
Fixed the syntax reversal of the sample name in the example.
(From yocto-docs rev: f7f1a89043156527fa4b426c0322ad225a9f2ff1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 36 |
1 files changed, 21 insertions, 15 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 1728139aba..24d7a0a99e 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
@@ -2173,8 +2173,9 @@ This check was removed for YP 2.3 release | |||
2173 | 2173 | ||
2174 | <para> | 2174 | <para> |
2175 | The <filename>native</filename> class provides common | 2175 | The <filename>native</filename> class provides common |
2176 | functionality for recipes that wish to build tools to run on the build | 2176 | functionality for recipes that build tools to run on the |
2177 | host (i.e. tools that use the compiler or other tools from the | 2177 | <link linkend='hardware-build-system-term'>build host</link> |
2178 | (i.e. tools that use the compiler or other tools from the | ||
2178 | build host). | 2179 | build host). |
2179 | </para> | 2180 | </para> |
2180 | 2181 | ||
@@ -2182,30 +2183,35 @@ This check was removed for YP 2.3 release | |||
2182 | You can create a recipe that builds tools that run natively on the | 2183 | You can create a recipe that builds tools that run natively on the |
2183 | host a couple different ways: | 2184 | host a couple different ways: |
2184 | <itemizedlist> | 2185 | <itemizedlist> |
2185 | <listitem><para>Create a <replaceable>myrecipe</replaceable><filename>-native.bb</filename> | 2186 | <listitem><para> |
2186 | that inherits the <filename>native</filename> class. | 2187 | Create a |
2188 | <replaceable>myrecipe</replaceable><filename>-native.bb</filename> | ||
2189 | recipe that inherits the <filename>native</filename> class. | ||
2187 | If you use this method, you must order the inherit statement | 2190 | If you use this method, you must order the inherit statement |
2188 | in the recipe after all other inherit statements so that the | 2191 | in the recipe after all other inherit statements so that the |
2189 | <filename>native</filename> class is inherited last. | 2192 | <filename>native</filename> class is inherited last. |
2193 | <note><title>Warning</title> | ||
2194 | When creating a recipe this way, the recipe name must | ||
2195 | follow this naming convention: | ||
2196 | <literallayout class='monospaced'> | ||
2197 | <replaceable>myrecipe</replaceable>-native.bb | ||
2198 | </literallayout> | ||
2199 | Not using this naming convention can lead to subtle | ||
2200 | problems caused by existing code that depends on that | ||
2201 | naming convention. | ||
2202 | </note> | ||
2190 | </para></listitem> | 2203 | </para></listitem> |
2191 | <listitem><para>Create or modify a target recipe that contains | 2204 | <listitem><para> |
2192 | the following: | 2205 | Create or modify a target recipe that contains the following: |
2193 | <literallayout class='monospaced'> | 2206 | <literallayout class='monospaced'> |
2194 | <link linkend='var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></link> = "native" | 2207 | <link linkend='var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></link> = "native" |
2195 | </literallayout> | 2208 | </literallayout> |
2196 | Inside the recipe, use <filename>_class-native</filename> and | 2209 | Inside the recipe, use <filename>_class-native</filename> and |
2197 | <filename>_class-target</filename> overrides to specify any | 2210 | <filename>_class-target</filename> overrides to specify any |
2198 | functionality specific to the respective native or target | 2211 | functionality specific to the respective native or target |
2199 | case.</para></listitem> | 2212 | case. |
2213 | </para></listitem> | ||
2200 | </itemizedlist> | 2214 | </itemizedlist> |
2201 | <note><title>Warning</title> | ||
2202 | When creating a recipe, you must follow this naming convention: | ||
2203 | <literallayout class='monospaced'> | ||
2204 | native-<replaceable>myrecipe</replaceable>.bb | ||
2205 | </literallayout> | ||
2206 | Not doing so can lead to subtle problems because code exists | ||
2207 | that depends on the naming convention. | ||
2208 | </note> | ||
2209 | </para> | 2215 | </para> |
2210 | 2216 | ||
2211 | <para> | 2217 | <para> |