summaryrefslogtreecommitdiffstats
path: root/documentation
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
parentce8c96481ea6aa3a391ac2936af6a472d903c4b4 (diff)
downloadpoky-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')
-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 @@
631 <note> 631 <note>
632 For BSPs supported by the Yocto Project, the BSP description 632 For BSPs supported by the Yocto Project, the BSP description
633 files are located in the <filename>bsp</filename> directory 633 files are located in the <filename>bsp</filename> directory
634 of the <filename>yocto-kernel-cache</filename> repository 634 of the
635 organized under the "Yocto Linux Kernel" heading in the 635 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/yocto-kernel-cache/tree/bsp'><filename>yocto-kernel-cache</filename></ulink>
636 repository organized under the "Yocto Linux Kernel" heading
637 in the
636 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi'>Yocto Project Source Repositories</ulink>. 638 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi'>Yocto Project Source Repositories</ulink>.
637 </note> 639 </note>
638 </para> 640 </para>
@@ -641,27 +643,31 @@
641 This section overviews the BSP description structure, the 643 This section overviews the BSP description structure, the
642 aggregation concepts, and presents a detailed example using 644 aggregation concepts, and presents a detailed example using
643 a BSP supported by the Yocto Project (i.e. BeagleBone Board). 645 a BSP supported by the Yocto Project (i.e. BeagleBone Board).
646 For complete information on BSP layer file hierarchy, see the
647 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support
648 Package (BSP) Developer's Guide</ulink>.
644 </para> 649 </para>
645 650
646 <section id='bsp-description-file-overview'> 651 <section id='bsp-description-file-overview'>
647 <title>Overview</title> 652 <title>Overview</title>
648 653
649 <para> 654 <para>
650 For simplicity, consider the following top-level BSP 655 For simplicity, consider the following root BSP layer
651 description files for the BeagleBone board. 656 description files for the BeagleBone board.
652 Top-level BSP descriptions files employ both a structure 657 These files employ both a structure and naming convention
653 and naming convention for consistency. 658 for consistency.
654 The naming convention for the file is as follows: 659 The naming convention for the file is as follows:
655 <literallayout class='monospaced'> 660 <literallayout class='monospaced'>
656 <replaceable>bsp_name</replaceable>-<replaceable>kernel_type</replaceable>.scc 661 <replaceable>bsp_root_name</replaceable>-<replaceable>kernel_type</replaceable>.scc
657 </literallayout> 662 </literallayout>
658 Here are some example top-level BSP filenames for the 663 Here are some example root layer BSP filenames for the
659 BeagleBone Board BSP, which is supported by the Yocto Project: 664 BeagleBone Board BSP, which is supported by the Yocto Project:
660 <literallayout class='monospaced'> 665 <literallayout class='monospaced'>
661 beaglebone-standard.scc 666 beaglebone-standard.scc
662 beaglebone-preempt-rt.scc 667 beaglebone-preempt-rt.scc
663 </literallayout> 668 </literallayout>
664 Each file uses the BSP name followed by the kernel type. 669 Each file uses the root name (i.e "beaglebone") BSP name
670 followed by the kernel type.
665 </para> 671 </para>
666 672
667 <para> 673 <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 @@
120 (or tree) found at 120 (or tree) found at
121 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink> given the 121 <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink> given the
122 introduction of a new top-level kernel feature or BSP. 122 introduction of a new top-level kernel feature or BSP.
123 These are the actions that effectively provide the Metadata 123 The following actions effectively provide the Metadata
124 and create the tree that includes the new feature, patch or BSP: 124 and create the tree that includes the new feature, patch, or BSP:
125 <orderedlist> 125 <orderedlist>
126 <listitem><para> 126 <listitem><para>
127 <emphasis>Pass Feature to Build Subsystem:</emphasis> 127 <emphasis>Pass Feature to the OpenEmbedded Build System:</emphasis>
128 A top-level kernel feature is passed to the kernel build 128 A top-level kernel feature is passed to the kernel build
129 subsystem. 129 subsystem.
130 Normally, this feature is a BSP for a particular kernel 130 Normally, this feature is a BSP for a particular kernel
@@ -138,8 +138,10 @@
138 <listitem><para> 138 <listitem><para>
139 The in-tree kernel-cache directories, which are 139 The in-tree kernel-cache directories, which are
140 located in the 140 located in the
141 <filename>yocto-kernel-cache</filename> 141 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/yocto-kernel-cache/tree/bsp'><filename>yocto-kernel-cache</filename></ulink>
142 repository 142 repository organized under the "Yocto Linux Kernel"
143 heading in the
144 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi'>Yocto Project Source Repositories</ulink>.
143 </para></listitem> 145 </para></listitem>
144 <listitem><para> 146 <listitem><para>
145 Areas pointed to by <filename>SRC_URI</filename> 147 Areas pointed to by <filename>SRC_URI</filename>
@@ -148,9 +150,11 @@
148 </itemizedlist> 150 </itemizedlist>
149 For a typical build, the target of the search is a 151 For a typical build, the target of the search is a
150 feature description in an <filename>.scc</filename> file 152 feature description in an <filename>.scc</filename> file
151 whose name follows this format: 153 whose name follows this format (e.g.
154 <filename>beaglebone-standard.scc</filename> and
155 <filename>beaglebone-preempt-rt.scc</filename>):
152 <literallayout class='monospaced'> 156 <literallayout class='monospaced'>
153 <replaceable>bsp_name</replaceable>-<replaceable>kernel_type</replaceable>.scc 157 <replaceable>bsp_root_name</replaceable>-<replaceable>kernel_type</replaceable>.scc
154 </literallayout> 158 </literallayout>
155 </para></listitem> 159 </para></listitem>
156 <listitem><para> 160 <listitem><para>