diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-02-21 11:40:57 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-02-24 15:43:25 +0000 |
commit | efc97fe72091f8b0d0f7702d5ad337f48611249f (patch) | |
tree | 3faa63b5088190c8e199905aeafc8beb94c82f3a /documentation | |
parent | 22af38b3d9e97e5506832c5c0faadd6df747cdb7 (diff) | |
download | poky-efc97fe72091f8b0d0f7702d5ad337f48611249f.tar.gz |
manuals: document COMMERCIAL_[AUDIO|VIDEO]_PLUGINS variables
- Add COMMERCIAL_[AUDIO|VIDEO]_PLUGINS variables to the
variable index.
- Clarify that these plugins are still open-source
- Improve line width
(From yocto-docs rev: 8b161faad6b698b33165f02e1f5e78a693c7817b)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/licenses.rst | 30 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 20 |
2 files changed, 37 insertions, 13 deletions
diff --git a/documentation/dev-manual/licenses.rst b/documentation/dev-manual/licenses.rst index 65914e5efe..9629dc5329 100644 --- a/documentation/dev-manual/licenses.rst +++ b/documentation/dev-manual/licenses.rst | |||
@@ -242,10 +242,8 @@ defined in the | |||
242 | COMMERCIAL_AUDIO_PLUGINS ?= "" | 242 | COMMERCIAL_AUDIO_PLUGINS ?= "" |
243 | COMMERCIAL_VIDEO_PLUGINS ?= "" | 243 | COMMERCIAL_VIDEO_PLUGINS ?= "" |
244 | 244 | ||
245 | If you | 245 | If you want to enable these components, you can do so by making sure you have |
246 | want to enable these components, you can do so by making sure you have | 246 | statements similar to the following in your ``local.conf`` configuration file:: |
247 | statements similar to the following in your ``local.conf`` configuration | ||
248 | file:: | ||
249 | 247 | ||
250 | COMMERCIAL_AUDIO_PLUGINS = "gst-plugins-ugly-mad \ | 248 | COMMERCIAL_AUDIO_PLUGINS = "gst-plugins-ugly-mad \ |
251 | gst-plugins-ugly-mpegaudioparse" | 249 | gst-plugins-ugly-mpegaudioparse" |
@@ -253,20 +251,26 @@ file:: | |||
253 | gst-plugins-ugly-mpegstream gst-plugins-bad-mpegvideoparse" | 251 | gst-plugins-ugly-mpegstream gst-plugins-bad-mpegvideoparse" |
254 | LICENSE_FLAGS_ACCEPTED = "commercial_gst-plugins-ugly commercial_gst-plugins-bad commercial_qmmp" | 252 | LICENSE_FLAGS_ACCEPTED = "commercial_gst-plugins-ugly commercial_gst-plugins-bad commercial_qmmp" |
255 | 253 | ||
256 | 254 | Of course, you could also create a matching list for those components using the | |
257 | Of course, you could also create a matching list for those | 255 | more general "commercial" string in the :term:`LICENSE_FLAGS_ACCEPTED` variable, |
258 | components using the more general "commercial" in the | 256 | but that would also enable all the other packages with :term:`LICENSE_FLAGS` |
259 | :term:`LICENSE_FLAGS_ACCEPTED` variable, but that would also enable all | ||
260 | the other packages with :term:`LICENSE_FLAGS` | ||
261 | containing "commercial", which you may or may not want:: | 257 | containing "commercial", which you may or may not want:: |
262 | 258 | ||
263 | LICENSE_FLAGS_ACCEPTED = "commercial" | 259 | LICENSE_FLAGS_ACCEPTED = "commercial" |
264 | 260 | ||
265 | Specifying audio and video plugins as part of the | 261 | Specifying audio and video plugins as part of the |
266 | ``COMMERCIAL_AUDIO_PLUGINS`` and ``COMMERCIAL_VIDEO_PLUGINS`` statements | 262 | :term:`COMMERCIAL_AUDIO_PLUGINS` and :term:`COMMERCIAL_VIDEO_PLUGINS` statements |
267 | (along with the enabling :term:`LICENSE_FLAGS_ACCEPTED`) includes the | 263 | (along with :term:`LICENSE_FLAGS_ACCEPTED`) includes the plugins or |
268 | plugins or components into built images, thus adding support for media | 264 | components into built images, thus adding support for media formats or |
269 | formats or components. | 265 | components. |
266 | |||
267 | .. note:: | ||
268 | |||
269 | GStreamer "ugly" and "bad" plugins are actually available through | ||
270 | open source licenses. However, the "ugly" ones can be subject to software | ||
271 | patents in some countries, making it necessary to pay licensing fees | ||
272 | to distribute them. The "bad" ones are just deemed unreliable by the | ||
273 | GStreamer community and should therefore be used with care. | ||
270 | 274 | ||
271 | Maintaining Open Source License Compliance During Your Product's Lifecycle | 275 | Maintaining Open Source License Compliance During Your Product's Lifecycle |
272 | ========================================================================== | 276 | ========================================================================== |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 117ef4b264..9b581599e3 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -1313,6 +1313,26 @@ system and gives an overview of their function and contents. | |||
1313 | optional at the distribution level, in case the hardware supports | 1313 | optional at the distribution level, in case the hardware supports |
1314 | Bluetooth but you do not ever intend to use it. | 1314 | Bluetooth but you do not ever intend to use it. |
1315 | 1315 | ||
1316 | :term:`COMMERCIAL_AUDIO_PLUGINS` | ||
1317 | This variable is specific to the :yocto_git:`GStreamer recipes | ||
1318 | </poky/tree/meta/recipes-multimedia/gstreamer/gstreamer1.0-meta-base.bb>`. | ||
1319 | It allows to build the GStreamer `"ugly" | ||
1320 | <https://github.com/GStreamer/gst-plugins-ugly>`__ and | ||
1321 | `"bad" <https://github.com/GStreamer/gst-plugins-bad>`__ audio plugins. | ||
1322 | |||
1323 | See the :ref:`dev-manual/licenses:other variables related to commercial licenses` | ||
1324 | section for usage details. | ||
1325 | |||
1326 | :term:`COMMERCIAL_VIDEO_PLUGINS` | ||
1327 | This variable is specific to the :yocto_git:`GStreamer recipes | ||
1328 | </poky/tree/meta/recipes-multimedia/gstreamer/gstreamer1.0-meta-base.bb>`. | ||
1329 | It allows to build the GStreamer `"ugly" | ||
1330 | <https://github.com/GStreamer/gst-plugins-ugly>`__ and | ||
1331 | `"bad" <https://github.com/GStreamer/gst-plugins-bad>`__ video plugins. | ||
1332 | |||
1333 | See the :ref:`dev-manual/licenses:other variables related to commercial licenses` | ||
1334 | section for usage details. | ||
1335 | |||
1316 | :term:`COMMON_LICENSE_DIR` | 1336 | :term:`COMMON_LICENSE_DIR` |
1317 | Points to ``meta/files/common-licenses`` in the | 1337 | Points to ``meta/files/common-licenses`` in the |
1318 | :term:`Source Directory`, which is where generic license | 1338 | :term:`Source Directory`, which is where generic license |