diff options
Diffstat (limited to 'documentation')
-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 4a6aeb7391..283f483112 100644 --- a/documentation/kernel-dev/kernel-dev-advanced.xml +++ b/documentation/kernel-dev/kernel-dev-advanced.xml | |||
@@ -214,7 +214,7 @@ | |||
214 | Here is an example that shows a trivial tree of kernel Metadata | 214 | Here is an example that shows a trivial tree of kernel Metadata |
215 | stored in recipe-space within a BSP layer: | 215 | stored in recipe-space within a BSP layer: |
216 | <literallayout class='monospaced'> | 216 | <literallayout class='monospaced'> |
217 | meta-my_bsp_layer/ | 217 | meta-<replaceable>my_bsp_layer</replaceable>/ |
218 | `-- recipes-kernel | 218 | `-- recipes-kernel |
219 | `-- linux | 219 | `-- linux |
220 | `-- linux-yocto | 220 | `-- linux-yocto |
@@ -370,7 +370,7 @@ | |||
370 | of Metadata. | 370 | of Metadata. |
371 | The following Metadata file hierarchy is recommended: | 371 | The following Metadata file hierarchy is recommended: |
372 | <literallayout class='monospaced'> | 372 | <literallayout class='monospaced'> |
373 | <base>/ | 373 | <replaceable>base</replaceable>/ |
374 | bsp/ | 374 | bsp/ |
375 | cfg/ | 375 | cfg/ |
376 | features/ | 376 | features/ |
@@ -513,7 +513,7 @@ | |||
513 | patch mypatch.patch | 513 | patch mypatch.patch |
514 | 514 | ||
515 | patches/mypatch.patch: | 515 | patches/mypatch.patch: |
516 | <typical-patch> | 516 | <replaceable>typical-patch</replaceable> |
517 | </literallayout> | 517 | </literallayout> |
518 | You can create the typical <filename>.patch</filename> | 518 | You can create the typical <filename>.patch</filename> |
519 | file using <filename>diff -Nurp</filename> or | 519 | file using <filename>diff -Nurp</filename> or |
@@ -968,37 +968,38 @@ | |||
968 | hierarchical branching system similar to what the linux-yocto Linux | 968 | hierarchical branching system similar to what the linux-yocto Linux |
969 | kernel repositories use: | 969 | kernel repositories use: |
970 | <literallayout class='monospaced'> | 970 | <literallayout class='monospaced'> |
971 | <common>/<kernel_type>/<machine> | 971 | <replaceable>common</replaceable>/<replaceable>kernel_type</replaceable>/<replaceable>machine</replaceable> |
972 | </literallayout> | 972 | </literallayout> |
973 | </para> | 973 | </para> |
974 | 974 | ||
975 | <para> | 975 | <para> |
976 | If you had two kernel types, "standard" and "small" for | 976 | If you had two kernel types, "standard" and "small" for |
977 | instance, and three machines, the branches in your | 977 | instance, three machines, and <replaceable>common</replaceable> |
978 | as <filename>mydir</filename>, the branches in your | ||
978 | Git repository might look like this: | 979 | Git repository might look like this: |
979 | <literallayout class='monospaced'> | 980 | <literallayout class='monospaced'> |
980 | common/base | 981 | mydir/base |
981 | common/standard/base | 982 | mydir/standard/base |
982 | common/standard/machine_a | 983 | mydir/standard/machine_a |
983 | common/standard/machine_b | 984 | mydir/standard/machine_b |
984 | common/standard/machine_c | 985 | mydir/standard/machine_c |
985 | common/small/base | 986 | mydir/small/base |
986 | common/small/machine_a | 987 | mydir/small/machine_a |
987 | </literallayout> | 988 | </literallayout> |
988 | </para> | 989 | </para> |
989 | 990 | ||
990 | <para> | 991 | <para> |
991 | This organization can help clarify the branch relationships. | 992 | This organization can help clarify the branch relationships. |
992 | In this case, <filename>common/standard/machine_a</filename> | 993 | In this case, <filename>mydir/standard/machine_a</filename> |
993 | includes everything in <filename>common/base</filename> and | 994 | includes everything in <filename>mydir/base</filename> and |
994 | <filename>common/standard/base</filename>. | 995 | <filename>mydir/standard/base</filename>. |
995 | The "standard" and "small" branches add sources specific to those | 996 | The "standard" and "small" branches add sources specific to those |
996 | kernel types that for whatever reason are not appropriate for the | 997 | kernel types that for whatever reason are not appropriate for the |
997 | other branches. | 998 | other branches. |
998 | <note>The "base" branches are an artifact of the way Git manages | 999 | <note>The "base" branches are an artifact of the way Git manages |
999 | its data internally on the filesystem: Git will not allow you | 1000 | its data internally on the filesystem: Git will not allow you |
1000 | to use <filename>common/standard</filename> and | 1001 | to use <filename>mydir/standard</filename> and |
1001 | <filename>common/standard/machine_a</filename> because it | 1002 | <filename>mydir/standard/machine_a</filename> because it |
1002 | would have to create a file and a directory named "standard". | 1003 | would have to create a file and a directory named "standard". |
1003 | </note> | 1004 | </note> |
1004 | </para> | 1005 | </para> |
diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml index 35e7d8b080..58cc98ddff 100644 --- a/documentation/kernel-dev/kernel-dev-common.xml +++ b/documentation/kernel-dev/kernel-dev-common.xml | |||
@@ -88,7 +88,7 @@ | |||
88 | recipe, the append file will typically be located as follows | 88 | recipe, the append file will typically be located as follows |
89 | within your custom layer: | 89 | within your custom layer: |
90 | <literallayout class='monospaced'> | 90 | <literallayout class='monospaced'> |
91 | <your-layer>/recipes-kernel/linux/linux-yocto_3.4.bbappend | 91 | <replaceable>your-layer</replaceable>/recipes-kernel/linux/linux-yocto_3.4.bbappend |
92 | </literallayout> | 92 | </literallayout> |
93 | The append file should initially extend the | 93 | The append file should initially extend the |
94 | <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESPATH'><filename>FILESPATH</filename></ulink> | 94 | <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESPATH'><filename>FILESPATH</filename></ulink> |
@@ -107,7 +107,7 @@ | |||
107 | described above, you must place the files in your layer in the | 107 | described above, you must place the files in your layer in the |
108 | following area: | 108 | following area: |
109 | <literallayout class='monospaced'> | 109 | <literallayout class='monospaced'> |
110 | <your-layer>/recipes-kernel/linux/linux-yocto/ | 110 | <replaceable>your-layer</replaceable>/recipes-kernel/linux/linux-yocto/ |
111 | </literallayout> | 111 | </literallayout> |
112 | <note>If you are working on a new machine Board Support Package | 112 | <note>If you are working on a new machine Board Support Package |
113 | (BSP), be sure to refer to the | 113 | (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 a7c144ff75..a72dcff01b 100644 --- a/documentation/kernel-dev/kernel-dev-maint-appx.xml +++ b/documentation/kernel-dev/kernel-dev-maint-appx.xml | |||
@@ -88,7 +88,7 @@ | |||
88 | feature description in an <filename>.scc</filename> file | 88 | feature description in an <filename>.scc</filename> file |
89 | whose name follows this format: | 89 | whose name follows this format: |
90 | <literallayout class='monospaced'> | 90 | <literallayout class='monospaced'> |
91 | <bsp_name>-<kernel_type>.scc | 91 | <replaceable>bsp_name</replaceable>-<replaceable>kernel_type</replaceable>.scc |
92 | </literallayout> | 92 | </literallayout> |
93 | </para></listitem> | 93 | </para></listitem> |
94 | <listitem><para>Once located, the feature description is either compiled into a simple script | 94 | <listitem><para>Once located, the feature description is either compiled into a simple script |
@@ -157,7 +157,7 @@ | |||
157 | <listitem><para>A BSP build branch exists. | 157 | <listitem><para>A BSP build branch exists. |
158 | This branch has the following form: | 158 | This branch has the following form: |
159 | <literallayout class='monospaced'> | 159 | <literallayout class='monospaced'> |
160 | <kernel_type>/<bsp_name> | 160 | <replaceable>kernel_type</replaceable>/<replaceable>bsp_name</replaceable> |
161 | </literallayout></para></listitem> | 161 | </literallayout></para></listitem> |
162 | </itemizedlist> | 162 | </itemizedlist> |
163 | 163 | ||
@@ -194,7 +194,7 @@ | |||
194 | <filename>${MACHINE}</filename> is the metadata name of the machine (BSP) and "kernel_type" is one | 194 | <filename>${MACHINE}</filename> is the metadata name of the machine (BSP) and "kernel_type" is one |
195 | of the Yocto Project supported kernel types (e.g. "standard"): | 195 | of the Yocto Project supported kernel types (e.g. "standard"): |
196 | <literallayout class='monospaced'> | 196 | <literallayout class='monospaced'> |
197 | linux-${MACHINE}-<kernel_type>-build | 197 | linux-${MACHINE}-<replaceable>kernel_type</replaceable>-build |
198 | </literallayout> | 198 | </literallayout> |
199 | </para> | 199 | </para> |
200 | 200 | ||