mirror of
git://git.yoctoproject.org/poky.git
synced 2025-07-19 12:59:02 +02:00
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>
This commit is contained in:
parent
2a540a95a5
commit
59f95aaae4
|
@ -2147,7 +2147,7 @@
|
||||||
Files installed into the device's boot partition
|
Files installed into the device's boot partition
|
||||||
when preparing the image using the Wic tool
|
when preparing the image using the Wic tool
|
||||||
with the <filename>bootimg-partition</filename>
|
with the <filename>bootimg-partition</filename>
|
||||||
source plug-in.
|
source plugin.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
</para>
|
</para>
|
||||||
|
|
|
@ -7387,17 +7387,17 @@
|
||||||
it is based on is by definition incomplete.
|
it is based on is by definition incomplete.
|
||||||
The purpose of the command is to allow the generation of
|
The purpose of the command is to allow the generation of
|
||||||
customized images, and as such, was designed to be
|
customized images, and as such, was designed to be
|
||||||
completely extensible through a plug-in interface.
|
completely extensible through a plugin interface.
|
||||||
See the
|
See the
|
||||||
"<link linkend='wic-using-the-wic-plug-ins-interface'>Using the Wic Plug-Ins Interface</link>"
|
"<link linkend='wic-using-the-wic-plugin-interface'>Using the Wic PlugIn Interface</link>"
|
||||||
section for information on these plug-ins.
|
section for information on these plugins.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
This section provides some background information on Wic,
|
This section provides some background information on Wic,
|
||||||
describes what you need to have in
|
describes what you need to have in
|
||||||
place to run the tool, provides instruction on how to use
|
place to run the tool, provides instruction on how to use
|
||||||
the Wic utility, provides information on using the Wic plug-ins
|
the Wic utility, provides information on using the Wic plugins
|
||||||
interface, and provides several examples that show how to use
|
interface, and provides several examples that show how to use
|
||||||
Wic.
|
Wic.
|
||||||
</para>
|
</para>
|
||||||
|
@ -7792,28 +7792,28 @@
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id='wic-using-the-wic-plug-ins-interface'>
|
<section id='wic-using-the-wic-plugin-interface'>
|
||||||
<title>Using the Wic Plug-Ins Interface</title>
|
<title>Using the Wic Plugin Interface</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
You can extend and specialize Wic functionality by using
|
You can extend and specialize Wic functionality by using
|
||||||
Wic plug-ins.
|
Wic plugins.
|
||||||
This section explains the Wic plug-in interface.
|
This section explains the Wic plugin interface.
|
||||||
<note>
|
<note>
|
||||||
Wic plug-ins consist of "source" and "imager" plug-ins.
|
Wic plugins consist of "source" and "imager" plugins.
|
||||||
Imager plug-ins are beyond the scope of this section.
|
Imager plugins are beyond the scope of this section.
|
||||||
</note>
|
</note>
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Source plug-ins provide a mechanism to customize partition
|
Source plugins provide a mechanism to customize partition
|
||||||
content during the Wic image generation process.
|
content during the Wic image generation process.
|
||||||
You can use source plug-ins to map values that you specify
|
You can use source plugins to map values that you specify
|
||||||
using <filename>--source</filename> commands in kickstart
|
using <filename>--source</filename> commands in kickstart
|
||||||
files (i.e. <filename>*.wks</filename>) to a plug-in
|
files (i.e. <filename>*.wks</filename>) to a plugin
|
||||||
implementation used to populate a given partition.
|
implementation used to populate a given partition.
|
||||||
<note>
|
<note>
|
||||||
If you use plug-ins that have build-time dependencies
|
If you use plugins that have build-time dependencies
|
||||||
(e.g. native tools, bootloaders, and so forth)
|
(e.g. native tools, bootloaders, and so forth)
|
||||||
when building a Wic image, you need to specify those
|
when building a Wic image, you need to specify those
|
||||||
dependencies using the
|
dependencies using the
|
||||||
|
@ -7823,43 +7823,43 @@
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Source plug-ins are subclasses defined in plug-in files.
|
Source plugins are subclasses defined in plugin files.
|
||||||
As shipped, the Yocto Project provides several plug-in
|
As shipped, the Yocto Project provides several plugin
|
||||||
files.
|
files.
|
||||||
You can see the source plug-in files that ship with the
|
You can see the source plugin files that ship with the
|
||||||
Yocto Project
|
Yocto Project
|
||||||
<ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/scripts/lib/wic/plugins/source'>here</ulink>.
|
<ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/scripts/lib/wic/plugins/source'>here</ulink>.
|
||||||
Each of these plug-in files contains source plug-ins that
|
Each of these plugin files contains source plugins that
|
||||||
are designed to populate a specific Wic image partition.
|
are designed to populate a specific Wic image partition.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Source plug-ins are subclasses of the
|
Source plugins are subclasses of the
|
||||||
<filename>SourcePlugin</filename> class, which is
|
<filename>SourcePlugin</filename> class, which is
|
||||||
defined in the
|
defined in the
|
||||||
<filename>poky/scripts/lib/wic/pluginbase.py</filename>
|
<filename>poky/scripts/lib/wic/pluginbase.py</filename>
|
||||||
file.
|
file.
|
||||||
For example, the <filename>BootimgEFIPlugin</filename>
|
For example, the <filename>BootimgEFIPlugin</filename>
|
||||||
source plug-in found in the
|
source plugin found in the
|
||||||
<filename>bootimg-efi.py</filename> file is a subclass of
|
<filename>bootimg-efi.py</filename> file is a subclass of
|
||||||
the <filename>SourcePlugin</filename> class, which is found
|
the <filename>SourcePlugin</filename> class, which is found
|
||||||
in the <filename>pluginbase.py</filename> file.
|
in the <filename>pluginbase.py</filename> file.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
You can also implement source plug-ins in a layer outside
|
You can also implement source plugins in a layer outside
|
||||||
of the Source Repositories (external layer).
|
of the Source Repositories (external layer).
|
||||||
To do so, be sure that your plug-in files are located in
|
To do so, be sure that your plugin files are located in
|
||||||
a directory whose path is
|
a directory whose path is
|
||||||
<filename>scripts/lib/wic/plugins/source/</filename>
|
<filename>scripts/lib/wic/plugins/source/</filename>
|
||||||
within your external layer.
|
within your external layer.
|
||||||
When the plug-in files are located there, the source
|
When the plugin files are located there, the source
|
||||||
plug-ins they contain are made available to Wic.
|
plugins they contain are made available to Wic.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
When the Wic implementation needs to invoke a
|
When the Wic implementation needs to invoke a
|
||||||
partition-specific implementation, it looks for the plug-in
|
partition-specific implementation, it looks for the plugin
|
||||||
with the same name as the <filename>--source</filename>
|
with the same name as the <filename>--source</filename>
|
||||||
parameter used in the kickstart file given to that
|
parameter used in the kickstart file given to that
|
||||||
partition.
|
partition.
|
||||||
|
@ -7869,13 +7869,13 @@
|
||||||
part /boot --source bootimg-pcbios --ondisk sda --label boot --active --align 1024
|
part /boot --source bootimg-pcbios --ondisk sda --label boot --active --align 1024
|
||||||
</literallayout>
|
</literallayout>
|
||||||
The methods defined as class members of the matching
|
The methods defined as class members of the matching
|
||||||
source plug-in (i.e. <filename>bootimg-pcbios</filename>)
|
source plugin (i.e. <filename>bootimg-pcbios</filename>)
|
||||||
in the <filename>bootimg-pcbios.py</filename> plug-in file
|
in the <filename>bootimg-pcbios.py</filename> plugin file
|
||||||
are used.
|
are used.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
To be more concrete, here is the corresponding plug-in
|
To be more concrete, here is the corresponding plugin
|
||||||
definition from the <filename>bootimg-pcbios.py</filename>
|
definition from the <filename>bootimg-pcbios.py</filename>
|
||||||
file for the previous command along with an example
|
file for the previous command along with an example
|
||||||
method called by the Wic implementation when it needs to
|
method called by the Wic implementation when it needs to
|
||||||
|
@ -7907,19 +7907,19 @@
|
||||||
.
|
.
|
||||||
.
|
.
|
||||||
</literallayout>
|
</literallayout>
|
||||||
If a subclass (plug-in) itself does not implement a
|
If a subclass (plugin) itself does not implement a
|
||||||
particular function, Wic locates and uses the default
|
particular function, Wic locates and uses the default
|
||||||
version in the superclass.
|
version in the superclass.
|
||||||
It is for this reason that all source plug-ins are derived
|
It is for this reason that all source plugins are derived
|
||||||
from the <filename>SourcePlugin</filename> class.
|
from the <filename>SourcePlugin</filename> class.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The <filename>SourcePlugin</filename> class defined in
|
The <filename>SourcePlugin</filename> class defined in
|
||||||
the <filename>pluginbase.py</filename> file defines
|
the <filename>pluginbase.py</filename> file defines
|
||||||
a set of methods that source plug-ins can implement or
|
a set of methods that source plugins can implement or
|
||||||
override.
|
override.
|
||||||
Any plug-ins (subclass of
|
Any plugins (subclass of
|
||||||
<filename>SourcePlugin</filename>) that do not implement
|
<filename>SourcePlugin</filename>) that do not implement
|
||||||
a particular method inherit the implementation of the
|
a particular method inherit the implementation of the
|
||||||
method from the <filename>SourcePlugin</filename> class.
|
method from the <filename>SourcePlugin</filename> class.
|
||||||
|
@ -7980,11 +7980,11 @@
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
You can extend the source plug-in mechanism.
|
You can extend the source plugin mechanism.
|
||||||
To add more hooks, create more source plug-in methods
|
To add more hooks, create more source plugin methods
|
||||||
within <filename>SourcePlugin</filename> and the
|
within <filename>SourcePlugin</filename> and the
|
||||||
corresponding derived subclasses.
|
corresponding derived subclasses.
|
||||||
The code that calls the plug-in methods uses the
|
The code that calls the plugin methods uses the
|
||||||
<filename>plugin.get_source_plugin_methods()</filename>
|
<filename>plugin.get_source_plugin_methods()</filename>
|
||||||
function to find the method or methods needed by the call.
|
function to find the method or methods needed by the call.
|
||||||
Retrieval of those methods is accomplished by filling up
|
Retrieval of those methods is accomplished by filling up
|
||||||
|
@ -9404,7 +9404,7 @@
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Many pieces of software split functionality into optional
|
Many pieces of software split functionality into optional
|
||||||
modules (or plug-ins) and the plug-ins that are built
|
modules (or plugins) and the plugins that are built
|
||||||
might depend on configuration options.
|
might depend on configuration options.
|
||||||
To avoid having to duplicate the logic that determines what
|
To avoid having to duplicate the logic that determines what
|
||||||
modules are available in your recipe or to avoid having
|
modules are available in your recipe or to avoid having
|
||||||
|
@ -15061,12 +15061,12 @@
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Specifying audio and video plug-ins as part of the
|
Specifying audio and video plugins as part of the
|
||||||
<filename>COMMERCIAL_AUDIO_PLUGINS</filename> and
|
<filename>COMMERCIAL_AUDIO_PLUGINS</filename> and
|
||||||
<filename>COMMERCIAL_VIDEO_PLUGINS</filename> statements
|
<filename>COMMERCIAL_VIDEO_PLUGINS</filename> statements
|
||||||
(along with the enabling
|
(along with the enabling
|
||||||
<filename>LICENSE_FLAGS_WHITELIST</filename>) includes the
|
<filename>LICENSE_FLAGS_WHITELIST</filename>) includes the
|
||||||
plug-ins or components into built images, thus adding
|
plugins or components into built images, thus adding
|
||||||
support for media formats or components.
|
support for media formats or components.
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
|
@ -4506,8 +4506,8 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
<emphasis>fsimage Plug-in Removed:</emphasis>
|
<emphasis>fsimage Plug-in Removed:</emphasis>
|
||||||
The Wic fsimage plug-in has been removed as it duplicates
|
The Wic fsimage plugin has been removed as it duplicates
|
||||||
functionality of the rawcopy plug-in.
|
functionality of the rawcopy plugin.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
</para>
|
</para>
|
||||||
|
@ -6363,7 +6363,7 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>.
|
||||||
Support for the Eclipse IDE has been removed.
|
Support for the Eclipse IDE has been removed.
|
||||||
Support continues for those releases prior to 2.7 that did include
|
Support continues for those releases prior to 2.7 that did include
|
||||||
support.
|
support.
|
||||||
The 2.7 release does not include the Eclipse Yocto plug-in.
|
The 2.7 release does not include the Eclipse Yocto plugin.
|
||||||
</para>
|
</para>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|
|
@ -117,9 +117,9 @@
|
||||||
This option is a Wic-specific option that names the source
|
This option is a Wic-specific option that names the source
|
||||||
of the data that populates the partition.
|
of the data that populates the partition.
|
||||||
The most common value for this option is "rootfs", but you
|
The most common value for this option is "rootfs", but you
|
||||||
can use any value that maps to a valid source plug-in.
|
can use any value that maps to a valid source plugin.
|
||||||
For information on the source plug-ins, see the
|
For information on the source plugins, see the
|
||||||
"<ulink url='&YOCTO_DOCS_DEV_URL;#wic-using-the-wic-plug-ins-interface'>Using the Wic Plug-Ins Interface</ulink>"
|
"<ulink url='&YOCTO_DOCS_DEV_URL;#wic-using-the-wic-plugin-interface'>Using the Wic Plugins Interface</ulink>"
|
||||||
section in the Yocto Project Development Tasks Manual.
|
section in the Yocto Project Development Tasks Manual.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
@ -139,12 +139,12 @@
|
||||||
<filename>--source <replaceable>plugin-name</replaceable></filename>,
|
<filename>--source <replaceable>plugin-name</replaceable></filename>,
|
||||||
Wic creates a partition as large as needed and fills it
|
Wic creates a partition as large as needed and fills it
|
||||||
with the contents of the partition that is generated by the
|
with the contents of the partition that is generated by the
|
||||||
specified plug-in name using the data pointed to by the
|
specified plugin name using the data pointed to by the
|
||||||
<filename>-r</filename> command-line option or the
|
<filename>-r</filename> command-line option or the
|
||||||
equivalent rootfs derived from the <filename>-e</filename>
|
equivalent rootfs derived from the <filename>-e</filename>
|
||||||
command-line option.
|
command-line option.
|
||||||
Exactly what those contents are and filesystem type used are
|
Exactly what those contents are and filesystem type used are
|
||||||
dependent on the given plug-in implementation.
|
dependent on the given plugin implementation.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>If you do not use the <filename>--source</filename>
|
<para>If you do not use the <filename>--source</filename>
|
||||||
|
@ -220,7 +220,7 @@
|
||||||
This option is a Wic-specific option that excludes the given
|
This option is a Wic-specific option that excludes the given
|
||||||
relative path from the resulting image.
|
relative path from the resulting image.
|
||||||
This option is only effective with the rootfs source
|
This option is only effective with the rootfs source
|
||||||
plug-in.
|
plugin.
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
<emphasis><filename>--extra-space</filename>:</emphasis>
|
<emphasis><filename>--extra-space</filename>:</emphasis>
|
||||||
|
@ -299,7 +299,7 @@
|
||||||
supports the following options:
|
supports the following options:
|
||||||
<note>
|
<note>
|
||||||
Bootloader functionality and boot partitions are implemented by
|
Bootloader functionality and boot partitions are implemented by
|
||||||
the various <filename>--source</filename> plug-ins that
|
the various <filename>--source</filename> plugins that
|
||||||
implement bootloader functionality.
|
implement bootloader functionality.
|
||||||
The bootloader command essentially provides a means of
|
The bootloader command essentially provides a means of
|
||||||
modifying bootloader configuration.
|
modifying bootloader configuration.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user