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>
This commit is contained in:
Scott Rifenbark
2018-03-22 09:15:49 -07:00
committed by Richard Purdie
parent ce8c96481e
commit 80c7ca2c28
2 changed files with 25 additions and 15 deletions

View File

@@ -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>

View File

@@ -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>