summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-03-22 09:15:49 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-03-25 09:41:13 +0100
commit80c7ca2c28959d08a59d960d318d8360392bd488 (patch)
tree74283e5d9829706cdbf15a2cdf45f1d8f9d6dfbf /documentation/kernel-dev
parentce8c96481ea6aa3a391ac2936af6a472d903c4b4 (diff)
downloadopenembedded-core-contrib-80c7ca2c28959d08a59d960d318d8360392bd488.tar.gz
kernel-dev: Clean up of "bsp_name" placeholder.
This string is now being presented as "bsp_root_name" in the YP manual set. A BSP name is essentially "meta-bsp_root_name". It was being presented in the manual set as "meta-bsp_name", which is not technically correct. (From yocto-docs rev: 9ad25836b2b3ca79aa3430be014871f50205cf9e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/kernel-dev')
-rw-r--r--documentation/kernel-dev/kernel-dev-advanced.xml22
-rw-r--r--documentation/kernel-dev/kernel-dev-maint-appx.xml18
2 files changed, 25 insertions, 15 deletions
diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml
index 8b4ce45d7d..cf8d34dced 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.xml
+++ b/documentation/kernel-dev/kernel-dev-advanced.xml
@@ -631,8 +631,10 @@
<note>
For BSPs supported by the Yocto Project, the BSP description
files are located in the <filename>bsp</filename> directory
- of the <filename>yocto-kernel-cache</filename> repository
- organized under the "Yocto Linux Kernel" heading in the
+ of the
+ <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/yocto-kernel-cache/tree/bsp'><filename>yocto-kernel-cache</filename></ulink>
+ repository organized under the "Yocto Linux Kernel" heading
+ in the
<ulink url='http://git.yoctoproject.org/cgit/cgit.cgi'>Yocto Project Source Repositories</ulink>.
</note>
</para>
@@ -641,27 +643,31 @@
This section overviews the BSP description structure, the
aggregation concepts, and presents a detailed example using
a BSP supported by the Yocto Project (i.e. BeagleBone Board).
+ For complete information on BSP layer file hierarchy, see the
+ <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support
+ Package (BSP) Developer's Guide</ulink>.
</para>
<section id='bsp-description-file-overview'>
<title>Overview</title>
<para>
- For simplicity, consider the following top-level BSP
+ For simplicity, consider the following root BSP layer
description files for the BeagleBone board.
- Top-level BSP descriptions files employ both a structure
- and naming convention for consistency.
+ These files employ both a structure and naming convention
+ for consistency.
The naming convention for the file is as follows:
<literallayout class='monospaced'>
- <replaceable>bsp_name</replaceable>-<replaceable>kernel_type</replaceable>.scc
+ <replaceable>bsp_root_name</replaceable>-<replaceable>kernel_type</replaceable>.scc
</literallayout>
- Here are some example top-level BSP filenames for the
+ Here are some example root layer BSP filenames for the
BeagleBone Board BSP, which is supported by the Yocto Project:
<literallayout class='monospaced'>
beaglebone-standard.scc
beaglebone-preempt-rt.scc
</literallayout>
- Each file uses the BSP name followed by the kernel type.
+ Each file uses the root name (i.e "beaglebone") BSP name
+ followed by the kernel type.
</para>
<para>
diff --git a/documentation/kernel-dev/kernel-dev-maint-appx.xml b/documentation/kernel-dev/kernel-dev-maint-appx.xml
index f5fd183fd0..8acc2a8cad 100644
--- a/documentation/kernel-dev/kernel-dev-maint-appx.xml
+++ b/documentation/kernel-dev/kernel-dev-maint-appx.xml
@@ -120,11 +120,11 @@
(or tree) found at
<ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink> given the
introduction of a new top-level kernel feature or BSP.
- These are the actions that effectively provide the Metadata
- and create the tree that includes the new feature, patch or BSP:
+ The following actions effectively provide the Metadata
+ and create the tree that includes the new feature, patch, or BSP:
<orderedlist>
<listitem><para>
- <emphasis>Pass Feature to Build Subsystem:</emphasis>
+ <emphasis>Pass Feature to the OpenEmbedded Build System:</emphasis>
A top-level kernel feature is passed to the kernel build
subsystem.
Normally, this feature is a BSP for a particular kernel
@@ -138,8 +138,10 @@
<listitem><para>
The in-tree kernel-cache directories, which are
located in the
- <filename>yocto-kernel-cache</filename>
- repository
+ <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/yocto-kernel-cache/tree/bsp'><filename>yocto-kernel-cache</filename></ulink>
+ repository organized under the "Yocto Linux Kernel"
+ heading in the
+ <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi'>Yocto Project Source Repositories</ulink>.
</para></listitem>
<listitem><para>
Areas pointed to by <filename>SRC_URI</filename>
@@ -148,9 +150,11 @@
</itemizedlist>
For a typical build, the target of the search is a
feature description in an <filename>.scc</filename> file
- whose name follows this format:
+ whose name follows this format (e.g.
+ <filename>beaglebone-standard.scc</filename> and
+ <filename>beaglebone-preempt-rt.scc</filename>):
<literallayout class='monospaced'>
- <replaceable>bsp_name</replaceable>-<replaceable>kernel_type</replaceable>.scc
+ <replaceable>bsp_root_name</replaceable>-<replaceable>kernel_type</replaceable>.scc
</literallayout>
</para></listitem>
<listitem><para>