1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-31 00:39:46 +00:00

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>
This commit is contained in:
Scott Rifenbark
2014-10-16 17:18:18 -07:00
committed by Richard Purdie
parent 5f613896ee
commit d6e89e7122
3 changed files with 23 additions and 22 deletions
@@ -214,7 +214,7 @@
Here is an example that shows a trivial tree of kernel Metadata Here is an example that shows a trivial tree of kernel Metadata
stored in recipe-space within a BSP layer: stored in recipe-space within a BSP layer:
<literallayout class='monospaced'> <literallayout class='monospaced'>
meta-my_bsp_layer/ meta-<replaceable>my_bsp_layer</replaceable>/
`-- recipes-kernel `-- recipes-kernel
`-- linux `-- linux
`-- linux-yocto `-- linux-yocto
@@ -370,7 +370,7 @@
of Metadata. of Metadata.
The following Metadata file hierarchy is recommended: The following Metadata file hierarchy is recommended:
<literallayout class='monospaced'> <literallayout class='monospaced'>
&lt;base&gt;/ <replaceable>base</replaceable>/
bsp/ bsp/
cfg/ cfg/
features/ features/
@@ -513,7 +513,7 @@
patch mypatch.patch patch mypatch.patch
patches/mypatch.patch: patches/mypatch.patch:
&lt;typical-patch&gt; <replaceable>typical-patch</replaceable>
</literallayout> </literallayout>
You can create the typical <filename>.patch</filename> You can create the typical <filename>.patch</filename>
file using <filename>diff -Nurp</filename> or file using <filename>diff -Nurp</filename> or
@@ -968,37 +968,38 @@
hierarchical branching system similar to what the linux-yocto Linux hierarchical branching system similar to what the linux-yocto Linux
kernel repositories use: kernel repositories use:
<literallayout class='monospaced'> <literallayout class='monospaced'>
&lt;common&gt;/&lt;kernel_type&gt;/&lt;machine&gt; <replaceable>common</replaceable>/<replaceable>kernel_type</replaceable>/<replaceable>machine</replaceable>
</literallayout> </literallayout>
</para> </para>
<para> <para>
If you had two kernel types, "standard" and "small" for 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: Git repository might look like this:
<literallayout class='monospaced'> <literallayout class='monospaced'>
common/base mydir/base
common/standard/base mydir/standard/base
common/standard/machine_a mydir/standard/machine_a
common/standard/machine_b mydir/standard/machine_b
common/standard/machine_c mydir/standard/machine_c
common/small/base mydir/small/base
common/small/machine_a mydir/small/machine_a
</literallayout> </literallayout>
</para> </para>
<para> <para>
This organization can help clarify the branch relationships. This organization can help clarify the branch relationships.
In this case, <filename>common/standard/machine_a</filename> In this case, <filename>mydir/standard/machine_a</filename>
includes everything in <filename>common/base</filename> and includes everything in <filename>mydir/base</filename> and
<filename>common/standard/base</filename>. <filename>mydir/standard/base</filename>.
The "standard" and "small" branches add sources specific to those The "standard" and "small" branches add sources specific to those
kernel types that for whatever reason are not appropriate for the kernel types that for whatever reason are not appropriate for the
other branches. other branches.
<note>The "base" branches are an artifact of the way Git manages <note>The "base" branches are an artifact of the way Git manages
its data internally on the filesystem: Git will not allow you its data internally on the filesystem: Git will not allow you
to use <filename>common/standard</filename> and to use <filename>mydir/standard</filename> and
<filename>common/standard/machine_a</filename> because it <filename>mydir/standard/machine_a</filename> because it
would have to create a file and a directory named "standard". would have to create a file and a directory named "standard".
</note> </note>
</para> </para>
@@ -88,7 +88,7 @@
recipe, the append file will typically be located as follows recipe, the append file will typically be located as follows
within your custom layer: within your custom layer:
<literallayout class='monospaced'> <literallayout class='monospaced'>
&lt;your-layer&gt;/recipes-kernel/linux/linux-yocto_3.4.bbappend <replaceable>your-layer</replaceable>/recipes-kernel/linux/linux-yocto_3.4.bbappend
</literallayout> </literallayout>
The append file should initially extend the The append file should initially extend the
<ulink url='&YOCTO_DOCS_REF_URL;#var-FILESPATH'><filename>FILESPATH</filename></ulink> <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 described above, you must place the files in your layer in the
following area: following area:
<literallayout class='monospaced'> <literallayout class='monospaced'>
&lt;your-layer&gt;/recipes-kernel/linux/linux-yocto/ <replaceable>your-layer</replaceable>/recipes-kernel/linux/linux-yocto/
</literallayout> </literallayout>
<note>If you are working on a new machine Board Support Package <note>If you are working on a new machine Board Support Package
(BSP), be sure to refer to the (BSP), be sure to refer to the
@@ -88,7 +88,7 @@
feature description in an <filename>.scc</filename> file feature description in an <filename>.scc</filename> file
whose name follows this format: whose name follows this format:
<literallayout class='monospaced'> <literallayout class='monospaced'>
&lt;bsp_name&gt;-&lt;kernel_type&gt;.scc <replaceable>bsp_name</replaceable>-<replaceable>kernel_type</replaceable>.scc
</literallayout> </literallayout>
</para></listitem> </para></listitem>
<listitem><para>Once located, the feature description is either compiled into a simple script <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. <listitem><para>A BSP build branch exists.
This branch has the following form: This branch has the following form:
<literallayout class='monospaced'> <literallayout class='monospaced'>
&lt;kernel_type&gt;/&lt;bsp_name&gt; <replaceable>kernel_type</replaceable>/<replaceable>bsp_name</replaceable>
</literallayout></para></listitem> </literallayout></para></listitem>
</itemizedlist> </itemizedlist>
@@ -194,7 +194,7 @@
<filename>${MACHINE}</filename> is the metadata name of the machine (BSP) and "kernel_type" is one <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"): of the Yocto Project supported kernel types (e.g. "standard"):
<literallayout class='monospaced'> <literallayout class='monospaced'>
linux-${MACHINE}-&lt;kernel_type&gt;-build linux-${MACHINE}-<replaceable>kernel_type</replaceable>-build
</literallayout> </literallayout>
</para> </para>