]> git.ipfire.org Git - thirdparty/openembedded/openembedded-core-contrib.git/commitdiff
dev-manual: Updates to the section on creating a layer
authorScott Rifenbark <srifenbark@gmail.com>
Tue, 20 Mar 2018 18:25:07 +0000 (11:25 -0700)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Sun, 25 Mar 2018 08:41:12 +0000 (09:41 +0100)
Provided some key links to help clarify content.

(From yocto-docs rev: 8d27b9946dad89729d30497bcc4de26b9a5c87d9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
documentation/dev-manual/dev-manual-common-tasks.xml

index e513c67e040efc467df34902b03172aaf15b27cf..6bb42752672f975644265bc5f43e2f41f59ade9a 100644 (file)
@@ -37,7 +37,7 @@
                 The Yocto Project ships with tools that speed up creating
                 layers.
                 This section describes the steps you perform by hand to create
-                a layer so that you can better understand them.
+                layers so that you can better understand them.
                 For information about the layer-creation tools, see the
                 "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-bitbake-layers-script'>Creating a New BSP Layer Using the <filename>bitbake-layers</filename> Script</ulink>"
                 section in the Yocto Project Board Support Package (BSP)
@@ -95,7 +95,7 @@
                        <para>The
                        <filename>meta-yocto-bsp/conf/layer.conf</filename> file
                        in the Yocto Project
-                       <ulink url='&YOCTO_GIT_URL;'>Source Repositories</ulink>
+                       <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto-bsp/conf'>Source Repositories</ulink>
                        demonstrates the required syntax.
                        For your layer, you need to replace "yoctobsp" with the
                        root name of your layer:
                                 appended to
                                 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBPATH'><filename>BBPATH</filename></ulink>.
                                 <note>
-                                    All non-distro layers, which include all BSP
-                                    layers, are expected to append the layer
-                                    directory to <filename>BBPATH</filename>.
+                                    All non-distro layers are expected to
+                                    append the layer directory to
+                                    <filename>BBPATH</filename>.
                                     On the other hand, distro layers, such as
                                     <filename>meta-poky</filename>, can choose
                                     to enforce their own precedence over
                                     <filename>BBPATH</filename>.
                                     For an example of that syntax, see the
                                     <filename>meta-poky/conf/layer.conf</filename>
-                                    file for in the Source Repositories.
+                                    file for in the
+                                    <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf'>Source Repositories</ulink>.
                                 </note>
                                 </para></listitem>
                             <listitem><para>
                             <listitem><para>
                                 The
                                 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_COLLECTIONS'>BBFILE_COLLECTIONS</ulink></filename>
-                                variable is then appended with the layer name,
+                                variable is appended with the layer name,
                                 which is "yoctobsp" in this example.
                                 </para></listitem>
                             <listitem><para>
                             <listitem><para>
                                 The
                                 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBFILE_PRIORITY'>BBFILE_PRIORITY</ulink></filename>
-                                variable then assigns a priority to the layer.
+                                variable assigns a priority to the layer.
                                 Applying priorities is useful in situations
                                 where the same recipe might appear in multiple
                                 layers.
                         you need in <filename>recipes-*</filename>
                         subdirectories within the layer.
                         <note>
-                            In order to be compliant with the Yocto Project,
-                            a layer must contain a
-                            <ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout-readme'>README file.</ulink>
+                            For an explanation of layer hierarchy that
+                            is compliant with the Yocto Project, see
+                            the
+                            "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout'>Example Filesystem Layout</ulink>"
+                            section in the Yocto Project Board
+                            Support Package (BSP) Developer's Guide.
                         </note>
                         </para></listitem>
                     <listitem><para>