diff options
Diffstat (limited to 'documentation/getting-started/eclipse/html/getting-started/enabling-commercially-licensed-recipes.html')
| -rw-r--r-- | documentation/getting-started/eclipse/html/getting-started/enabling-commercially-licensed-recipes.html | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/documentation/getting-started/eclipse/html/getting-started/enabling-commercially-licensed-recipes.html b/documentation/getting-started/eclipse/html/getting-started/enabling-commercially-licensed-recipes.html new file mode 100644 index 0000000000..1a31d0e6b1 --- /dev/null +++ b/documentation/getting-started/eclipse/html/getting-started/enabling-commercially-licensed-recipes.html | |||
| @@ -0,0 +1,91 @@ | |||
| 1 | <html> | ||
| 2 | <head> | ||
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | ||
| 4 | <title>3.7.2. Enabling Commercially Licensed Recipes</title> | ||
| 5 | <link rel="stylesheet" type="text/css" href="../book.css"> | ||
| 6 | <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> | ||
| 7 | <link rel="home" href="index.html" title="Getting Started With Yocto Project"> | ||
| 8 | <link rel="up" href="overview-licenses.html" title="3.7. Licenses"> | ||
| 9 | <link rel="prev" href="usingpoky-LIC_FILES_CHKSUM-explanation-of-syntax.html" title="3.7.1.2. Explanation of Syntax"> | ||
| 10 | <link rel="next" href="license-flag-matching.html" title="3.7.2.1. License Flag Matching"> | ||
| 11 | </head> | ||
| 12 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="section" title="3.7.2. Enabling Commercially Licensed Recipes"> | ||
| 13 | <div class="titlepage"><div><div><h3 class="title"> | ||
| 14 | <a name="enabling-commercially-licensed-recipes"></a>3.7.2. Enabling Commercially Licensed Recipes</h3></div></div></div> | ||
| 15 | <p> | ||
| 16 | By default, the OpenEmbedded build system disables | ||
| 17 | components that have commercial or other special licensing | ||
| 18 | requirements. | ||
| 19 | Such requirements are defined on a | ||
| 20 | recipe-by-recipe basis through the | ||
| 21 | <a class="link" href="../ref-manual/var-LICENSE_FLAGS.html" target="_self"><code class="filename">LICENSE_FLAGS</code></a> | ||
| 22 | variable definition in the affected recipe. | ||
| 23 | For instance, the | ||
| 24 | <code class="filename">poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</code> | ||
| 25 | recipe contains the following statement: | ||
| 26 | </p> | ||
| 27 | <pre class="literallayout"> | ||
| 28 | LICENSE_FLAGS = "commercial" | ||
| 29 | </pre> | ||
| 30 | <p> | ||
| 31 | Here is a slightly more complicated example that contains both | ||
| 32 | an explicit recipe name and version (after variable expansion): | ||
| 33 | </p> | ||
| 34 | <pre class="literallayout"> | ||
| 35 | LICENSE_FLAGS = "license_${PN}_${PV}" | ||
| 36 | </pre> | ||
| 37 | <p> | ||
| 38 | In order for a component restricted by a | ||
| 39 | <code class="filename">LICENSE_FLAGS</code> definition to be enabled and | ||
| 40 | included in an image, it needs to have a matching entry in the | ||
| 41 | global | ||
| 42 | <a class="link" href="../ref-manual/var-LICENSE_FLAGS_WHITELIST.html" target="_self"><code class="filename">LICENSE_FLAGS_WHITELIST</code></a> | ||
| 43 | variable, which is a variable typically defined in your | ||
| 44 | <code class="filename">local.conf</code> file. | ||
| 45 | For example, to enable the | ||
| 46 | <code class="filename">poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</code> | ||
| 47 | package, you could add either the string | ||
| 48 | "commercial_gst-plugins-ugly" or the more general string | ||
| 49 | "commercial" to <code class="filename">LICENSE_FLAGS_WHITELIST</code>. | ||
| 50 | See the | ||
| 51 | "<a class="link" href="license-flag-matching.html" title="3.7.2.1. License Flag Matching">License Flag Matching</a>" | ||
| 52 | section for a full | ||
| 53 | explanation of how <code class="filename">LICENSE_FLAGS</code> matching | ||
| 54 | works. | ||
| 55 | Here is the example: | ||
| 56 | </p> | ||
| 57 | <pre class="literallayout"> | ||
| 58 | LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly" | ||
| 59 | </pre> | ||
| 60 | <p> | ||
| 61 | Likewise, to additionally enable the package built from the | ||
| 62 | recipe containing | ||
| 63 | <code class="filename">LICENSE_FLAGS = "license_${PN}_${PV}"</code>, | ||
| 64 | and assuming that the actual recipe name was | ||
| 65 | <code class="filename">emgd_1.10.bb</code>, the following string would | ||
| 66 | enable that package as well as the original | ||
| 67 | <code class="filename">gst-plugins-ugly</code> package: | ||
| 68 | </p> | ||
| 69 | <pre class="literallayout"> | ||
| 70 | LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly license_emgd_1.10" | ||
| 71 | </pre> | ||
| 72 | <p> | ||
| 73 | As a convenience, you do not need to specify the complete | ||
| 74 | license string in the whitelist for every package. | ||
| 75 | You can use an abbreviated form, which consists | ||
| 76 | of just the first portion or portions of the license | ||
| 77 | string before the initial underscore character or characters. | ||
| 78 | A partial string will match any license that contains the | ||
| 79 | given string as the first portion of its license. | ||
| 80 | For example, the following whitelist string will also match | ||
| 81 | both of the packages previously mentioned as well as any other | ||
| 82 | packages that have licenses starting with "commercial" or | ||
| 83 | "license". | ||
| 84 | </p> | ||
| 85 | <pre class="literallayout"> | ||
| 86 | LICENSE_FLAGS_WHITELIST = "commercial license" | ||
| 87 | </pre> | ||
| 88 | <p> | ||
| 89 | </p> | ||
| 90 | </div></body> | ||
| 91 | </html> | ||