diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-12-27 12:44:15 -0600 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-01-16 15:59:11 +0000 |
| commit | caacd30b2789533845436dc3d34e63b1d16ea2bf (patch) | |
| tree | 02a4ec6037bb70247080ee127cdec8a1c378eeec | |
| parent | 1fa2beffa185438ed0f3c1133bf1304b914c6ca0 (diff) | |
| download | poky-caacd30b2789533845436dc3d34e63b1d16ea2bf.tar.gz | |
kernel-dev: Formatted "Features" section.
(From yocto-docs rev: 500ae50979dad7f730d8c0a5e987c608422f3c71)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
| -rw-r--r-- | documentation/kernel-dev/kernel-dev-advanced.xml | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml index c669357477..9872bf6859 100644 --- a/documentation/kernel-dev/kernel-dev-advanced.xml +++ b/documentation/kernel-dev/kernel-dev-advanced.xml | |||
| @@ -806,6 +806,71 @@ The description file can include multiple patch statements, one per patch. | |||
| 806 | </para> | 806 | </para> |
| 807 | </section> | 807 | </section> |
| 808 | 808 | ||
| 809 | <section id='features'> | ||
| 810 | <title>Features</title> | ||
| 811 | |||
| 812 | <para> | ||
| 813 | Features are a combination of configuration fragments and patches. | ||
| 814 | Or, more accurately, configuration fragments and patches are | ||
| 815 | simple forms of a feature, which is a more complex metadata type. | ||
| 816 | In addition to the <filename>kconf</filename> and | ||
| 817 | <filename>patch</filename> commands, features often aggregate | ||
| 818 | description files with the <filename>include</filename> command. | ||
| 819 | </para> | ||
| 820 | |||
| 821 | <para> | ||
| 822 | A hypothetical example of a feature description file might look | ||
| 823 | like the following: | ||
| 824 | <literallayout class='monospaced'> | ||
| 825 | features/myfeature.scc | ||
| 826 | define KFEATURE_DESCRIPTION "Enable myfeature" | ||
| 827 | |||
| 828 | patch 0001-myfeature-core.patch | ||
| 829 | patch 0002-myfeature-interface.patch | ||
| 830 | |||
| 831 | include cfg/myfeature_dependency.scc | ||
| 832 | kconf non-hardware myfeature.cfg | ||
| 833 | </literallayout> | ||
| 834 | </para> | ||
| 835 | |||
| 836 | <para> | ||
| 837 | Features are typically less granular than configuration | ||
| 838 | fragments and are more likely than configurations fragments | ||
| 839 | and patches to be the types of things you will want to specify | ||
| 840 | in the <filename>KERNEL_FEATURES</filename> variable of the | ||
| 841 | Linux kernel recipe. | ||
| 842 | See the "<link linkend='using-metadata-in-a-recipe'>Using Metadata in a Recipe</link>" | ||
| 843 | section earlier in the manual. | ||
| 844 | </para> | ||
| 845 | |||
| 846 | <para> | ||
| 847 | Original text: | ||
| 848 | <literallayout class='monospaced'> | ||
| 849 | Features are a combination of configuration fragments and patches, or, more | ||
| 850 | accurately, configuration fragments and patches are simple forms of a feature, a | ||
| 851 | more complex meta-data type. In addition to the kconf and patch commands, | ||
| 852 | features often aggregate description files with the include command. | ||
| 853 | |||
| 854 | A hypothetical example of a feature description file might look like the | ||
| 855 | following: | ||
| 856 | |||
| 857 | features/myfeature.scc | ||
| 858 | define KFEATURE_DESCRIPTION "Enable myfeature" | ||
| 859 | |||
| 860 | patch 0001-myfeature-core.patch | ||
| 861 | patch 0002-myfeature-interface.patch | ||
| 862 | |||
| 863 | include cfg/myfeature_dependency.scc | ||
| 864 | kconf non-hardware myfeature.cfg | ||
| 865 | |||
| 866 | Features are typically less granular than configuration fragments and are more | ||
| 867 | likely than configurations fragments and patches to be the types of things you | ||
| 868 | will want to specify in the KERNEL_FEATURES variable of the Linux kernel recipe | ||
| 869 | (see 3.1). | ||
| 870 | </literallayout> | ||
| 871 | </para> | ||
| 872 | </section> | ||
| 873 | |||
| 809 | 874 | ||
| 810 | 875 | ||
| 811 | 876 | ||
