From 80c7ca2c28959d08a59d960d318d8360392bd488 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 22 Mar 2018 09:15:49 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/kernel-dev/kernel-dev-advanced.xml | 22 ++++++++++++++-------- documentation/kernel-dev/kernel-dev-maint-appx.xml | 18 +++++++++++------- 2 files changed, 25 insertions(+), 15 deletions(-) (limited to 'documentation') 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 @@ For BSPs supported by the Yocto Project, the BSP description files are located in the bsp directory - of the yocto-kernel-cache repository - organized under the "Yocto Linux Kernel" heading in the + of the + yocto-kernel-cache + repository organized under the "Yocto Linux Kernel" heading + in the Yocto Project Source Repositories. @@ -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 + Yocto Project Board Support + Package (BSP) Developer's Guide.
Overview - 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: - bsp_name-kernel_type.scc + bsp_root_name-kernel_type.scc - 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: beaglebone-standard.scc beaglebone-preempt-rt.scc - 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. 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 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: - Pass Feature to Build Subsystem: + Pass Feature to the OpenEmbedded Build System: 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 @@ The in-tree kernel-cache directories, which are located in the - yocto-kernel-cache - repository + yocto-kernel-cache + repository organized under the "Yocto Linux Kernel" + heading in the + Yocto Project Source Repositories. Areas pointed to by SRC_URI @@ -148,9 +150,11 @@ For a typical build, the target of the search is a feature description in an .scc file - whose name follows this format: + whose name follows this format (e.g. + beaglebone-standard.scc and + beaglebone-preempt-rt.scc): - bsp_name-kernel_type.scc + bsp_root_name-kernel_type.scc -- cgit v1.2.3-54-g00ecf