diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-10-16 16:31:19 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-10-18 16:15:30 +0200 |
commit | 2eaf7e6e7524ec2a1eeca35b41f123fdee7e120b (patch) | |
tree | ace8abdef240fafd3bdbeed9001e67da40d7cbd8 /documentation/ref-manual/ref-classes.xml | |
parent | b96378eb6b2443301b04dfc83eecf36eced6a27c (diff) | |
download | poky-2eaf7e6e7524ec2a1eeca35b41f123fdee7e120b.tar.gz |
ref-manual: Scrubbed for variable (user) input.
Throughout the manual I had been using angled bracket sets to
denote user-supplied input. This is confusing and better shown
by using the <replaceable></replaceable> tags. I scrubbed all
the chapters and replaced as needed.
Some other minor formatting changes were caught and fixed during
the scrub as well.
(From yocto-docs rev: 9a668574dd18828a750cfa2e8c28e1f089a19609)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-classes.xml')
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 0bc917c09c..ed6d059e01 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
@@ -1947,7 +1947,7 @@ | |||
1947 | You can create a recipe that builds tools that run natively on the | 1947 | You can create a recipe that builds tools that run natively on the |
1948 | host a couple different ways: | 1948 | host a couple different ways: |
1949 | <itemizedlist> | 1949 | <itemizedlist> |
1950 | <listitem><para>Create a <filename>myrecipe-native.bb</filename> | 1950 | <listitem><para>Create a <replaceable>myrecipe</replaceable><filename>-native.bb</filename> |
1951 | that inherits the <filename>native</filename> class. | 1951 | that inherits the <filename>native</filename> class. |
1952 | If you use this method, you must order the inherit statement | 1952 | If you use this method, you must order the inherit statement |
1953 | in the recipe after all other inherit statements so that the | 1953 | in the recipe after all other inherit statements so that the |
@@ -1988,7 +1988,7 @@ | |||
1988 | You can create a recipe that builds tools that run on the SDK machine | 1988 | You can create a recipe that builds tools that run on the SDK machine |
1989 | a couple different ways: | 1989 | a couple different ways: |
1990 | <itemizedlist> | 1990 | <itemizedlist> |
1991 | <listitem><para>Create a <filename>myrecipe-nativesdk.bb</filename> | 1991 | <listitem><para>Create a <replaceable>myrecipe</replaceable><filename>-nativesdk.bb</filename> |
1992 | recipe that inherits the <filename>nativesdk</filename> class. | 1992 | recipe that inherits the <filename>nativesdk</filename> class. |
1993 | If you use this method, you must order the inherit statement | 1993 | If you use this method, you must order the inherit statement |
1994 | in the recipe after all other inherit statements so that the | 1994 | in the recipe after all other inherit statements so that the |
@@ -2915,37 +2915,37 @@ | |||
2915 | <para> | 2915 | <para> |
2916 | The class supports the following variables: | 2916 | The class supports the following variables: |
2917 | <itemizedlist> | 2917 | <itemizedlist> |
2918 | <listitem><para><emphasis><link linkend='var-INITRD'><filename>INITRD</filename></link>:</emphasis> | 2918 | <listitem><para><link linkend='var-INITRD'><filename>INITRD</filename></link>: |
2919 | Indicates list of filesystem images to concatenate and use as | 2919 | Indicates list of filesystem images to concatenate and use as |
2920 | an initial RAM disk (initrd). | 2920 | an initial RAM disk (initrd). |
2921 | This variable is optional.</para></listitem> | 2921 | This variable is optional.</para></listitem> |
2922 | <listitem><para><emphasis><link linkend='var-ROOTFS'><filename>ROOTFS</filename></link>:</emphasis> | 2922 | <listitem><para><link linkend='var-ROOTFS'><filename>ROOTFS</filename></link>: |
2923 | Indicates a filesystem image to include as the root filesystem. | 2923 | Indicates a filesystem image to include as the root filesystem. |
2924 | This variable is optional.</para></listitem> | 2924 | This variable is optional.</para></listitem> |
2925 | <listitem><para><emphasis><link linkend='var-AUTO_SYSLINUXMENU'><filename>AUTO_SYSLINUXMENU</filename></link>:</emphasis> | 2925 | <listitem><para><link linkend='var-AUTO_SYSLINUXMENU'><filename>AUTO_SYSLINUXMENU</filename></link>: |
2926 | Enables creating an automatic menu when set to "1". | 2926 | Enables creating an automatic menu when set to "1". |
2927 | </para></listitem> | 2927 | </para></listitem> |
2928 | <listitem><para><emphasis><link linkend='var-LABELS'><filename>LABELS</filename></link>:</emphasis> | 2928 | <listitem><para><link linkend='var-LABELS'><filename>LABELS</filename></link>: |
2929 | Lists targets for automatic configuration. | 2929 | Lists targets for automatic configuration. |
2930 | </para></listitem> | 2930 | </para></listitem> |
2931 | <listitem><para><emphasis><link linkend='var-APPEND'><filename>APPEND</filename></link>:</emphasis> | 2931 | <listitem><para><link linkend='var-APPEND'><filename>APPEND</filename></link>: |
2932 | Lists append string overrides for each label. | 2932 | Lists append string overrides for each label. |
2933 | </para></listitem> | 2933 | </para></listitem> |
2934 | <listitem><para><emphasis><link linkend='var-SYSLINUX_OPTS'><filename>SYSLINUX_OPTS</filename></link>:</emphasis> | 2934 | <listitem><para><link linkend='var-SYSLINUX_OPTS'><filename>SYSLINUX_OPTS</filename></link>: |
2935 | Lists additional options to add to the syslinux file. | 2935 | Lists additional options to add to the syslinux file. |
2936 | Semicolon characters separate multiple options. | 2936 | Semicolon characters separate multiple options. |
2937 | </para></listitem> | 2937 | </para></listitem> |
2938 | <listitem><para><emphasis><link linkend='var-SYSLINUX_SPLASH'><filename>SYSLINUX_SPLASH</filename></link>:</emphasis> | 2938 | <listitem><para><link linkend='var-SYSLINUX_SPLASH'><filename>SYSLINUX_SPLASH</filename></link>: |
2939 | Lists a background for the VGA boot menu when you are using the | 2939 | Lists a background for the VGA boot menu when you are using the |
2940 | boot menu.</para></listitem> | 2940 | boot menu.</para></listitem> |
2941 | <listitem><para><emphasis><link linkend='var-SYSLINUX_DEFAULT_CONSOLE'><filename>SYSLINUX_DEFAULT_CONSOLE</filename></link>:</emphasis> | 2941 | <listitem><para><link linkend='var-SYSLINUX_DEFAULT_CONSOLE'><filename>SYSLINUX_DEFAULT_CONSOLE</filename></link>: |
2942 | Set to "console=ttyX" to change kernel boot default console. | 2942 | Set to "console=ttyX" to change kernel boot default console. |
2943 | </para></listitem> | 2943 | </para></listitem> |
2944 | <listitem><para><emphasis><link linkend='var-SYSLINUX_SERIAL'><filename>SYSLINUX_SERIAL</filename></link>:</emphasis> | 2944 | <listitem><para><link linkend='var-SYSLINUX_SERIAL'><filename>SYSLINUX_SERIAL</filename></link>: |
2945 | Sets an alternate serial port. | 2945 | Sets an alternate serial port. |
2946 | Or, turns off serial when the variable is set with an | 2946 | Or, turns off serial when the variable is set with an |
2947 | empty string.</para></listitem> | 2947 | empty string.</para></listitem> |
2948 | <listitem><para><emphasis><link linkend='var-SYSLINUX_SERIAL_TTY'><filename>SYSLINUX_SERIAL_TTY</filename></link>:</emphasis> | 2948 | <listitem><para><link linkend='var-SYSLINUX_SERIAL_TTY'><filename>SYSLINUX_SERIAL_TTY</filename></link>: |
2949 | Sets an alternate "console=tty..." kernel boot argument. | 2949 | Sets an alternate "console=tty..." kernel boot argument. |
2950 | </para></listitem> | 2950 | </para></listitem> |
2951 | </itemizedlist> | 2951 | </itemizedlist> |