summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2019-05-06 12:44:48 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2019-05-07 10:23:42 +0100
commit59f95aaae45e3b9f6c6a2d3f2acc387ea49add07 (patch)
tree5d5525a1d6489f0ba806d21c5ab316b839e4232f
parent2a540a95a52e5b750d708f7531acf759c8630763 (diff)
downloadpoky-59f95aaae45e3b9f6c6a2d3f2acc387ea49add07.tar.gz
documentation: Cleaned up "plug-in"/"plugin" terminology.
The YP manual set was using the plugin term inconsistently. It was appearing as "plugin" as well as "plug-in". The plugins in the project are all named without a hyphen. The term itself is either/or according to Google. I have changed all references to plugin so that they do not use a hyphen. (From yocto-docs rev: 715bb58e2347c5e37a49da7d9e3e230503672337) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/bsp-guide/bsp.xml2
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml76
-rw-r--r--documentation/ref-manual/migration.xml6
-rw-r--r--documentation/ref-manual/ref-kickstart.xml14
4 files changed, 49 insertions, 49 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml
index 1d37a443ec..6904a81ee9 100644
--- a/documentation/bsp-guide/bsp.xml
+++ b/documentation/bsp-guide/bsp.xml
@@ -2147,7 +2147,7 @@
2147 Files installed into the device's boot partition 2147 Files installed into the device's boot partition
2148 when preparing the image using the Wic tool 2148 when preparing the image using the Wic tool
2149 with the <filename>bootimg-partition</filename> 2149 with the <filename>bootimg-partition</filename>
2150 source plug-in. 2150 source plugin.
2151 </para></listitem> 2151 </para></listitem>
2152 </itemizedlist> 2152 </itemizedlist>
2153 </para> 2153 </para>
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 0fcb7b7064..0056ae7ac7 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -7387,17 +7387,17 @@
7387 it is based on is by definition incomplete. 7387 it is based on is by definition incomplete.
7388 The purpose of the command is to allow the generation of 7388 The purpose of the command is to allow the generation of
7389 customized images, and as such, was designed to be 7389 customized images, and as such, was designed to be
7390 completely extensible through a plug-in interface. 7390 completely extensible through a plugin interface.
7391 See the 7391 See the
7392 "<link linkend='wic-using-the-wic-plug-ins-interface'>Using the Wic Plug-Ins Interface</link>" 7392 "<link linkend='wic-using-the-wic-plugin-interface'>Using the Wic PlugIn Interface</link>"
7393 section for information on these plug-ins. 7393 section for information on these plugins.
7394 </para> 7394 </para>
7395 7395
7396 <para> 7396 <para>
7397 This section provides some background information on Wic, 7397 This section provides some background information on Wic,
7398 describes what you need to have in 7398 describes what you need to have in
7399 place to run the tool, provides instruction on how to use 7399 place to run the tool, provides instruction on how to use
7400 the Wic utility, provides information on using the Wic plug-ins 7400 the Wic utility, provides information on using the Wic plugins
7401 interface, and provides several examples that show how to use 7401 interface, and provides several examples that show how to use
7402 Wic. 7402 Wic.
7403 </para> 7403 </para>
@@ -7792,28 +7792,28 @@
7792 </para> 7792 </para>
7793 </section> 7793 </section>
7794 7794
7795 <section id='wic-using-the-wic-plug-ins-interface'> 7795 <section id='wic-using-the-wic-plugin-interface'>
7796 <title>Using the Wic Plug-Ins Interface</title> 7796 <title>Using the Wic Plugin Interface</title>
7797 7797
7798 <para> 7798 <para>
7799 You can extend and specialize Wic functionality by using 7799 You can extend and specialize Wic functionality by using
7800 Wic plug-ins. 7800 Wic plugins.
7801 This section explains the Wic plug-in interface. 7801 This section explains the Wic plugin interface.
7802 <note> 7802 <note>
7803 Wic plug-ins consist of "source" and "imager" plug-ins. 7803 Wic plugins consist of "source" and "imager" plugins.
7804 Imager plug-ins are beyond the scope of this section. 7804 Imager plugins are beyond the scope of this section.
7805 </note> 7805 </note>
7806 </para> 7806 </para>
7807 7807
7808 <para> 7808 <para>
7809 Source plug-ins provide a mechanism to customize partition 7809 Source plugins provide a mechanism to customize partition
7810 content during the Wic image generation process. 7810 content during the Wic image generation process.
7811 You can use source plug-ins to map values that you specify 7811 You can use source plugins to map values that you specify
7812 using <filename>--source</filename> commands in kickstart 7812 using <filename>--source</filename> commands in kickstart
7813 files (i.e. <filename>*.wks</filename>) to a plug-in 7813 files (i.e. <filename>*.wks</filename>) to a plugin
7814 implementation used to populate a given partition. 7814 implementation used to populate a given partition.
7815 <note> 7815 <note>
7816 If you use plug-ins that have build-time dependencies 7816 If you use plugins that have build-time dependencies
7817 (e.g. native tools, bootloaders, and so forth) 7817 (e.g. native tools, bootloaders, and so forth)
7818 when building a Wic image, you need to specify those 7818 when building a Wic image, you need to specify those
7819 dependencies using the 7819 dependencies using the
@@ -7823,43 +7823,43 @@
7823 </para> 7823 </para>
7824 7824
7825 <para> 7825 <para>
7826 Source plug-ins are subclasses defined in plug-in files. 7826 Source plugins are subclasses defined in plugin files.
7827 As shipped, the Yocto Project provides several plug-in 7827 As shipped, the Yocto Project provides several plugin
7828 files. 7828 files.
7829 You can see the source plug-in files that ship with the 7829 You can see the source plugin files that ship with the
7830 Yocto Project 7830 Yocto Project
7831 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/scripts/lib/wic/plugins/source'>here</ulink>. 7831 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/scripts/lib/wic/plugins/source'>here</ulink>.
7832 Each of these plug-in files contains source plug-ins that 7832 Each of these plugin files contains source plugins that
7833 are designed to populate a specific Wic image partition. 7833 are designed to populate a specific Wic image partition.
7834 </para> 7834 </para>
7835 7835
7836 <para> 7836 <para>
7837 Source plug-ins are subclasses of the 7837 Source plugins are subclasses of the
7838 <filename>SourcePlugin</filename> class, which is 7838 <filename>SourcePlugin</filename> class, which is
7839 defined in the 7839 defined in the
7840 <filename>poky/scripts/lib/wic/pluginbase.py</filename> 7840 <filename>poky/scripts/lib/wic/pluginbase.py</filename>
7841 file. 7841 file.
7842 For example, the <filename>BootimgEFIPlugin</filename> 7842 For example, the <filename>BootimgEFIPlugin</filename>
7843 source plug-in found in the 7843 source plugin found in the
7844 <filename>bootimg-efi.py</filename> file is a subclass of 7844 <filename>bootimg-efi.py</filename> file is a subclass of
7845 the <filename>SourcePlugin</filename> class, which is found 7845 the <filename>SourcePlugin</filename> class, which is found
7846 in the <filename>pluginbase.py</filename> file. 7846 in the <filename>pluginbase.py</filename> file.
7847 </para> 7847 </para>
7848 7848
7849 <para> 7849 <para>
7850 You can also implement source plug-ins in a layer outside 7850 You can also implement source plugins in a layer outside
7851 of the Source Repositories (external layer). 7851 of the Source Repositories (external layer).
7852 To do so, be sure that your plug-in files are located in 7852 To do so, be sure that your plugin files are located in
7853 a directory whose path is 7853 a directory whose path is
7854 <filename>scripts/lib/wic/plugins/source/</filename> 7854 <filename>scripts/lib/wic/plugins/source/</filename>
7855 within your external layer. 7855 within your external layer.
7856 When the plug-in files are located there, the source 7856 When the plugin files are located there, the source
7857 plug-ins they contain are made available to Wic. 7857 plugins they contain are made available to Wic.
7858 </para> 7858 </para>
7859 7859
7860 <para> 7860 <para>
7861 When the Wic implementation needs to invoke a 7861 When the Wic implementation needs to invoke a
7862 partition-specific implementation, it looks for the plug-in 7862 partition-specific implementation, it looks for the plugin
7863 with the same name as the <filename>--source</filename> 7863 with the same name as the <filename>--source</filename>
7864 parameter used in the kickstart file given to that 7864 parameter used in the kickstart file given to that
7865 partition. 7865 partition.
@@ -7869,13 +7869,13 @@
7869 part /boot --source bootimg-pcbios --ondisk sda --label boot --active --align 1024 7869 part /boot --source bootimg-pcbios --ondisk sda --label boot --active --align 1024
7870 </literallayout> 7870 </literallayout>
7871 The methods defined as class members of the matching 7871 The methods defined as class members of the matching
7872 source plug-in (i.e. <filename>bootimg-pcbios</filename>) 7872 source plugin (i.e. <filename>bootimg-pcbios</filename>)
7873 in the <filename>bootimg-pcbios.py</filename> plug-in file 7873 in the <filename>bootimg-pcbios.py</filename> plugin file
7874 are used. 7874 are used.
7875 </para> 7875 </para>
7876 7876
7877 <para> 7877 <para>
7878 To be more concrete, here is the corresponding plug-in 7878 To be more concrete, here is the corresponding plugin
7879 definition from the <filename>bootimg-pcbios.py</filename> 7879 definition from the <filename>bootimg-pcbios.py</filename>
7880 file for the previous command along with an example 7880 file for the previous command along with an example
7881 method called by the Wic implementation when it needs to 7881 method called by the Wic implementation when it needs to
@@ -7907,19 +7907,19 @@
7907 . 7907 .
7908 . 7908 .
7909 </literallayout> 7909 </literallayout>
7910 If a subclass (plug-in) itself does not implement a 7910 If a subclass (plugin) itself does not implement a
7911 particular function, Wic locates and uses the default 7911 particular function, Wic locates and uses the default
7912 version in the superclass. 7912 version in the superclass.
7913 It is for this reason that all source plug-ins are derived 7913 It is for this reason that all source plugins are derived
7914 from the <filename>SourcePlugin</filename> class. 7914 from the <filename>SourcePlugin</filename> class.
7915 </para> 7915 </para>
7916 7916
7917 <para> 7917 <para>
7918 The <filename>SourcePlugin</filename> class defined in 7918 The <filename>SourcePlugin</filename> class defined in
7919 the <filename>pluginbase.py</filename> file defines 7919 the <filename>pluginbase.py</filename> file defines
7920 a set of methods that source plug-ins can implement or 7920 a set of methods that source plugins can implement or
7921 override. 7921 override.
7922 Any plug-ins (subclass of 7922 Any plugins (subclass of
7923 <filename>SourcePlugin</filename>) that do not implement 7923 <filename>SourcePlugin</filename>) that do not implement
7924 a particular method inherit the implementation of the 7924 a particular method inherit the implementation of the
7925 method from the <filename>SourcePlugin</filename> class. 7925 method from the <filename>SourcePlugin</filename> class.
@@ -7980,11 +7980,11 @@
7980 </para> 7980 </para>
7981 7981
7982 <para> 7982 <para>
7983 You can extend the source plug-in mechanism. 7983 You can extend the source plugin mechanism.
7984 To add more hooks, create more source plug-in methods 7984 To add more hooks, create more source plugin methods
7985 within <filename>SourcePlugin</filename> and the 7985 within <filename>SourcePlugin</filename> and the
7986 corresponding derived subclasses. 7986 corresponding derived subclasses.
7987 The code that calls the plug-in methods uses the 7987 The code that calls the plugin methods uses the
7988 <filename>plugin.get_source_plugin_methods()</filename> 7988 <filename>plugin.get_source_plugin_methods()</filename>
7989 function to find the method or methods needed by the call. 7989 function to find the method or methods needed by the call.
7990 Retrieval of those methods is accomplished by filling up 7990 Retrieval of those methods is accomplished by filling up
@@ -9404,7 +9404,7 @@
9404 9404
9405 <para> 9405 <para>
9406 Many pieces of software split functionality into optional 9406 Many pieces of software split functionality into optional
9407 modules (or plug-ins) and the plug-ins that are built 9407 modules (or plugins) and the plugins that are built
9408 might depend on configuration options. 9408 might depend on configuration options.
9409 To avoid having to duplicate the logic that determines what 9409 To avoid having to duplicate the logic that determines what
9410 modules are available in your recipe or to avoid having 9410 modules are available in your recipe or to avoid having
@@ -15061,12 +15061,12 @@
15061 </para> 15061 </para>
15062 15062
15063 <para> 15063 <para>
15064 Specifying audio and video plug-ins as part of the 15064 Specifying audio and video plugins as part of the
15065 <filename>COMMERCIAL_AUDIO_PLUGINS</filename> and 15065 <filename>COMMERCIAL_AUDIO_PLUGINS</filename> and
15066 <filename>COMMERCIAL_VIDEO_PLUGINS</filename> statements 15066 <filename>COMMERCIAL_VIDEO_PLUGINS</filename> statements
15067 (along with the enabling 15067 (along with the enabling
15068 <filename>LICENSE_FLAGS_WHITELIST</filename>) includes the 15068 <filename>LICENSE_FLAGS_WHITELIST</filename>) includes the
15069 plug-ins or components into built images, thus adding 15069 plugins or components into built images, thus adding
15070 support for media formats or components. 15070 support for media formats or components.
15071 </para> 15071 </para>
15072 </section> 15072 </section>
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index 4f57c1e1d3..1ecf5b9996 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -4506,8 +4506,8 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
4506 </para></listitem> 4506 </para></listitem>
4507 <listitem><para> 4507 <listitem><para>
4508 <emphasis>fsimage Plug-in Removed:</emphasis> 4508 <emphasis>fsimage Plug-in Removed:</emphasis>
4509 The Wic fsimage plug-in has been removed as it duplicates 4509 The Wic fsimage plugin has been removed as it duplicates
4510 functionality of the rawcopy plug-in. 4510 functionality of the rawcopy plugin.
4511 </para></listitem> 4511 </para></listitem>
4512 </itemizedlist> 4512 </itemizedlist>
4513 </para> 4513 </para>
@@ -6363,7 +6363,7 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
6363 Support for the Eclipse IDE has been removed. 6363 Support for the Eclipse IDE has been removed.
6364 Support continues for those releases prior to 2.7 that did include 6364 Support continues for those releases prior to 2.7 that did include
6365 support. 6365 support.
6366 The 2.7 release does not include the Eclipse Yocto plug-in. 6366 The 2.7 release does not include the Eclipse Yocto plugin.
6367 </para> 6367 </para>
6368 </section> 6368 </section>
6369 6369
diff --git a/documentation/ref-manual/ref-kickstart.xml b/documentation/ref-manual/ref-kickstart.xml
index a58f9d7c96..1128bd50d0 100644
--- a/documentation/ref-manual/ref-kickstart.xml
+++ b/documentation/ref-manual/ref-kickstart.xml
@@ -117,9 +117,9 @@
117 This option is a Wic-specific option that names the source 117 This option is a Wic-specific option that names the source
118 of the data that populates the partition. 118 of the data that populates the partition.
119 The most common value for this option is "rootfs", but you 119 The most common value for this option is "rootfs", but you
120 can use any value that maps to a valid source plug-in. 120 can use any value that maps to a valid source plugin.
121 For information on the source plug-ins, see the 121 For information on the source plugins, see the
122 "<ulink url='&YOCTO_DOCS_DEV_URL;#wic-using-the-wic-plug-ins-interface'>Using the Wic Plug-Ins Interface</ulink>" 122 "<ulink url='&YOCTO_DOCS_DEV_URL;#wic-using-the-wic-plugin-interface'>Using the Wic Plugins Interface</ulink>"
123 section in the Yocto Project Development Tasks Manual. 123 section in the Yocto Project Development Tasks Manual.
124 </para> 124 </para>
125 125
@@ -139,12 +139,12 @@
139 <filename>--source <replaceable>plugin-name</replaceable></filename>, 139 <filename>--source <replaceable>plugin-name</replaceable></filename>,
140 Wic creates a partition as large as needed and fills it 140 Wic creates a partition as large as needed and fills it
141 with the contents of the partition that is generated by the 141 with the contents of the partition that is generated by the
142 specified plug-in name using the data pointed to by the 142 specified plugin name using the data pointed to by the
143 <filename>-r</filename> command-line option or the 143 <filename>-r</filename> command-line option or the
144 equivalent rootfs derived from the <filename>-e</filename> 144 equivalent rootfs derived from the <filename>-e</filename>
145 command-line option. 145 command-line option.
146 Exactly what those contents are and filesystem type used are 146 Exactly what those contents are and filesystem type used are
147 dependent on the given plug-in implementation. 147 dependent on the given plugin implementation.
148 </para> 148 </para>
149 149
150 <para>If you do not use the <filename>--source</filename> 150 <para>If you do not use the <filename>--source</filename>
@@ -220,7 +220,7 @@
220 This option is a Wic-specific option that excludes the given 220 This option is a Wic-specific option that excludes the given
221 relative path from the resulting image. 221 relative path from the resulting image.
222 This option is only effective with the rootfs source 222 This option is only effective with the rootfs source
223 plug-in. 223 plugin.
224 </para></listitem> 224 </para></listitem>
225 <listitem><para> 225 <listitem><para>
226 <emphasis><filename>--extra-space</filename>:</emphasis> 226 <emphasis><filename>--extra-space</filename>:</emphasis>
@@ -299,7 +299,7 @@
299 supports the following options: 299 supports the following options:
300 <note> 300 <note>
301 Bootloader functionality and boot partitions are implemented by 301 Bootloader functionality and boot partitions are implemented by
302 the various <filename>--source</filename> plug-ins that 302 the various <filename>--source</filename> plugins that
303 implement bootloader functionality. 303 implement bootloader functionality.
304 The bootloader command essentially provides a means of 304 The bootloader command essentially provides a means of
305 modifying bootloader configuration. 305 modifying bootloader configuration.