diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-10-16 17:18:18 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-10-18 16:15:30 +0200 |
commit | d6e89e7122c7d588cf3a505d4eb5f67fdb520a9d (patch) | |
tree | c549bdbaf22325f46ad5428781b672f7046542d4 /documentation/kernel-dev | |
parent | 5f613896ee90920baf9fe110faf5c8a4a249a9f9 (diff) | |
download | ast2050-yocto-poky-d6e89e7122c7d588cf3a505d4eb5f67fdb520a9d.zip ast2050-yocto-poky-d6e89e7122c7d588cf3a505d4eb5f67fdb520a9d.tar.gz |
kernel-dev: Scrubbed and fixed all user-supplied input formatting.
In the manual I was using angled brackets to denote user-supplied
input values. This was confusing so I changed to using the
<replaceable></replaceable> tag pair.
(From yocto-docs rev: dc73a78f11038a1ff04b16867e7513f31f02374b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.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.xml | 35 | ||||
-rw-r--r-- | documentation/kernel-dev/kernel-dev-common.xml | 4 | ||||
-rw-r--r-- | documentation/kernel-dev/kernel-dev-maint-appx.xml | 6 |
3 files changed, 23 insertions, 22 deletions
diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml index 4a6aeb7..283f483 100644 --- a/documentation/kernel-dev/kernel-dev-advanced.xml +++ b/documentation/kernel-dev/kernel-dev-advanced.xml @@ -214,7 +214,7 @@ Here is an example that shows a trivial tree of kernel Metadata stored in recipe-space within a BSP layer: <literallayout class='monospaced'> - meta-my_bsp_layer/ + meta-<replaceable>my_bsp_layer</replaceable>/ `-- recipes-kernel `-- linux `-- linux-yocto @@ -370,7 +370,7 @@ of Metadata. The following Metadata file hierarchy is recommended: <literallayout class='monospaced'> - <base>/ + <replaceable>base</replaceable>/ bsp/ cfg/ features/ @@ -513,7 +513,7 @@ patch mypatch.patch patches/mypatch.patch: - <typical-patch> + <replaceable>typical-patch</replaceable> </literallayout> You can create the typical <filename>.patch</filename> file using <filename>diff -Nurp</filename> or @@ -968,37 +968,38 @@ hierarchical branching system similar to what the linux-yocto Linux kernel repositories use: <literallayout class='monospaced'> - <common>/<kernel_type>/<machine> + <replaceable>common</replaceable>/<replaceable>kernel_type</replaceable>/<replaceable>machine</replaceable> </literallayout> </para> <para> If you had two kernel types, "standard" and "small" for - instance, and three machines, the branches in your + instance, three machines, and <replaceable>common</replaceable> + as <filename>mydir</filename>, the branches in your Git repository might look like this: <literallayout class='monospaced'> - common/base - common/standard/base - common/standard/machine_a - common/standard/machine_b - common/standard/machine_c - common/small/base - common/small/machine_a + mydir/base + mydir/standard/base + mydir/standard/machine_a + mydir/standard/machine_b + mydir/standard/machine_c + mydir/small/base + mydir/small/machine_a </literallayout> </para> <para> This organization can help clarify the branch relationships. - In this case, <filename>common/standard/machine_a</filename> - includes everything in <filename>common/base</filename> and - <filename>common/standard/base</filename>. + In this case, <filename>mydir/standard/machine_a</filename> + includes everything in <filename>mydir/base</filename> and + <filename>mydir/standard/base</filename>. The "standard" and "small" branches add sources specific to those kernel types that for whatever reason are not appropriate for the other branches. <note>The "base" branches are an artifact of the way Git manages its data internally on the filesystem: Git will not allow you - to use <filename>common/standard</filename> and - <filename>common/standard/machine_a</filename> because it + to use <filename>mydir/standard</filename> and + <filename>mydir/standard/machine_a</filename> because it would have to create a file and a directory named "standard". </note> </para> diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml index 35e7d8b..58cc98d 100644 --- a/documentation/kernel-dev/kernel-dev-common.xml +++ b/documentation/kernel-dev/kernel-dev-common.xml @@ -88,7 +88,7 @@ recipe, the append file will typically be located as follows within your custom layer: <literallayout class='monospaced'> - <your-layer>/recipes-kernel/linux/linux-yocto_3.4.bbappend + <replaceable>your-layer</replaceable>/recipes-kernel/linux/linux-yocto_3.4.bbappend </literallayout> The append file should initially extend the <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESPATH'><filename>FILESPATH</filename></ulink> @@ -107,7 +107,7 @@ described above, you must place the files in your layer in the following area: <literallayout class='monospaced'> - <your-layer>/recipes-kernel/linux/linux-yocto/ + <replaceable>your-layer</replaceable>/recipes-kernel/linux/linux-yocto/ </literallayout> <note>If you are working on a new machine Board Support Package (BSP), be sure to refer to the diff --git a/documentation/kernel-dev/kernel-dev-maint-appx.xml b/documentation/kernel-dev/kernel-dev-maint-appx.xml index a7c144f..a72dcff 100644 --- a/documentation/kernel-dev/kernel-dev-maint-appx.xml +++ b/documentation/kernel-dev/kernel-dev-maint-appx.xml @@ -88,7 +88,7 @@ feature description in an <filename>.scc</filename> file whose name follows this format: <literallayout class='monospaced'> - <bsp_name>-<kernel_type>.scc + <replaceable>bsp_name</replaceable>-<replaceable>kernel_type</replaceable>.scc </literallayout> </para></listitem> <listitem><para>Once located, the feature description is either compiled into a simple script @@ -157,7 +157,7 @@ <listitem><para>A BSP build branch exists. This branch has the following form: <literallayout class='monospaced'> - <kernel_type>/<bsp_name> + <replaceable>kernel_type</replaceable>/<replaceable>bsp_name</replaceable> </literallayout></para></listitem> </itemizedlist> @@ -194,7 +194,7 @@ <filename>${MACHINE}</filename> is the metadata name of the machine (BSP) and "kernel_type" is one of the Yocto Project supported kernel types (e.g. "standard"): <literallayout class='monospaced'> - linux-${MACHINE}-<kernel_type>-build + linux-${MACHINE}-<replaceable>kernel_type</replaceable>-build </literallayout> </para> |