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