CaROS/poky
3
1
Fork 0
mirror of https://git.yoctoproject.org/git/poky synced 2026-01-01 13:58:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

kernel-dev: Scrubbed and fixed all user-supplied input formatting.

Browse Source 
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
documentation/kernel-dev/kernel-dev-advanced.xml
View File

@ -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'>
&lt;base&gt;/
<replaceable>base</replaceable>/
bsp/
cfg/
features/
@ -513,7 +513,7 @@
patch mypatch.patch
patches/mypatch.patch:
&lt;typical-patch&gt;
<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'>
&lt;common&gt;/&lt;kernel_type&gt;/&lt;machine&gt;
<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>

4
documentation/kernel-dev/kernel-dev-common.xml
View File

@ -88,7 +88,7 @@
recipe, the append file will typically be located as follows
within your custom layer:
<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>
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'>
&lt;your-layer&gt;/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

6
documentation/kernel-dev/kernel-dev-maint-appx.xml
View File

@ -88,7 +88,7 @@
feature description in an <filename>.scc</filename> file
whose name follows this format:
<literallayout class='monospaced'>
&lt;bsp_name&gt;-&lt;kernel_type&gt;.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'>
&lt;kernel_type&gt;/&lt;bsp_name&gt;
<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}-&lt;kernel_type&gt;-build
linux-${MACHINE}-<replaceable>kernel_type</replaceable>-build
</literallayout>
</para>