diff options
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/classes.rst | 67 | ||||
-rw-r--r-- | documentation/ref-manual/migration-2.6.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 10 |
3 files changed, 20 insertions, 59 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 6d9779f6e7..52a50faf67 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -501,29 +501,6 @@ Support for other version control systems such as Subversion is limited | |||
501 | due to BitBake's automatic fetch dependencies (e.g. | 501 | due to BitBake's automatic fetch dependencies (e.g. |
502 | ``subversion-native``). | 502 | ``subversion-native``). |
503 | 503 | ||
504 | .. _ref-classes-distutils: | ||
505 | |||
506 | ``distutils*.bbclass`` | ||
507 | ====================== | ||
508 | |||
509 | The ``distutils*`` classes support recipes for Python version 2.x | ||
510 | extensions, which are simple. These recipes usually only need to point | ||
511 | to the source's archive and then inherit the proper class. Building is | ||
512 | split into two methods depending on which method the module authors | ||
513 | used. | ||
514 | |||
515 | - Extensions that use an Autotools-based build system require Autotools | ||
516 | and the classes based on ``distutils`` in their recipes. | ||
517 | |||
518 | - Extensions that use build systems based on ``distutils`` require the | ||
519 | ``distutils`` class in their recipes. | ||
520 | |||
521 | - Extensions that use build systems based on ``setuptools`` require the | ||
522 | :ref:`setuptools <ref-classes-setuptools>` class in their recipes. | ||
523 | |||
524 | The ``distutils-common-base`` class is required by some of the | ||
525 | ``distutils*`` classes to provide common Python2 support. | ||
526 | |||
527 | .. _ref-classes-distutils3: | 504 | .. _ref-classes-distutils3: |
528 | 505 | ||
529 | ``distutils3*.bbclass`` | 506 | ``distutils3*.bbclass`` |
@@ -542,15 +519,9 @@ used. | |||
542 | ``distutils`` class in their recipes. | 519 | ``distutils`` class in their recipes. |
543 | 520 | ||
544 | - Extensions that use build systems based on ``setuptools3`` require | 521 | - Extensions that use build systems based on ``setuptools3`` require |
545 | the :ref:`setuptools3 <ref-classes-setuptools>` class in their | 522 | the :ref:`setuptools3 <ref-classes-setuptools3>` class in their |
546 | recipes. | 523 | recipes. |
547 | 524 | ||
548 | The ``distutils3*`` classes either inherit their corresponding | ||
549 | ``distutils*`` class or replicate them using a Python3 version instead | ||
550 | (e.g. ``distutils3-base`` inherits ``distutils-common-base``, which is | ||
551 | the same as ``distutils-base`` but inherits ``python3native`` instead of | ||
552 | ``pythonnative``). | ||
553 | |||
554 | .. _ref-classes-externalsrc: | 525 | .. _ref-classes-externalsrc: |
555 | 526 | ||
556 | ``externalsrc.bbclass`` | 527 | ``externalsrc.bbclass`` |
@@ -2138,13 +2109,13 @@ For information on setting up and running ptests, see the | |||
2138 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" | 2109 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" |
2139 | section in the Yocto Project Development Tasks Manual. | 2110 | section in the Yocto Project Development Tasks Manual. |
2140 | 2111 | ||
2141 | .. _ref-classes-python-dir: | 2112 | .. _ref-classes-python3-dir: |
2142 | 2113 | ||
2143 | ``python-dir.bbclass`` | 2114 | ``python3-dir.bbclass`` |
2144 | ====================== | 2115 | ======================= |
2145 | 2116 | ||
2146 | The ``python-dir`` class provides the base version, location, and site | 2117 | The ``python3-dir`` class provides the base version, location, and site |
2147 | package location for Python. | 2118 | package location for Python 3. |
2148 | 2119 | ||
2149 | .. _ref-classes-python3native: | 2120 | .. _ref-classes-python3native: |
2150 | 2121 | ||
@@ -2155,14 +2126,17 @@ The ``python3native`` class supports using the native version of Python | |||
2155 | 3 built by the build system rather than support of the version provided | 2126 | 3 built by the build system rather than support of the version provided |
2156 | by the build host. | 2127 | by the build host. |
2157 | 2128 | ||
2158 | .. _ref-classes-pythonnative: | 2129 | .. _ref-classes-python3targetconfig: |
2159 | 2130 | ||
2160 | ``pythonnative.bbclass`` | 2131 | ``python3targetconfig.bbclass`` |
2161 | ======================== | 2132 | =============================== |
2162 | 2133 | ||
2163 | When inherited by a recipe, the ``pythonnative`` class supports using | 2134 | The ``python3targetconfig`` class supports using the native version of Python |
2164 | the native version of Python built by the build system rather than using | 2135 | 3 built by the build system rather than support of the version provided |
2165 | the version provided by the build host. | 2136 | by the build host, except that the configuration for the target machine |
2137 | is accessible (such as correct installation directories). This also adds a | ||
2138 | dependency on target ``python3``, so should only be used where appropriate | ||
2139 | in order to avoid unnecessarily lengthening builds. | ||
2166 | 2140 | ||
2167 | .. _ref-classes-qemu: | 2141 | .. _ref-classes-qemu: |
2168 | 2142 | ||
@@ -2323,22 +2297,13 @@ additional configuration options you want to pass SCons command line. | |||
2323 | The ``sdl`` class supports recipes that need to build software that uses | 2297 | The ``sdl`` class supports recipes that need to build software that uses |
2324 | the Simple DirectMedia Layer (SDL) library. | 2298 | the Simple DirectMedia Layer (SDL) library. |
2325 | 2299 | ||
2326 | .. _ref-classes-setuptools: | ||
2327 | |||
2328 | ``setuptools.bbclass`` | ||
2329 | ====================== | ||
2330 | |||
2331 | The ``setuptools`` class supports Python version 2.x extensions that use | ||
2332 | build systems based on ``setuptools``. If your recipe uses these build | ||
2333 | systems, the recipe needs to inherit the ``setuptools`` class. | ||
2334 | |||
2335 | .. _ref-classes-setuptools3: | 2300 | .. _ref-classes-setuptools3: |
2336 | 2301 | ||
2337 | ``setuptools3.bbclass`` | 2302 | ``setuptools3.bbclass`` |
2338 | ======================= | 2303 | ======================= |
2339 | 2304 | ||
2340 | The ``setuptools3`` class supports Python version 3.x extensions that | 2305 | The ``setuptools3`` class supports Python version 3.x extensions that |
2341 | use build systems based on ``setuptools3``. If your recipe uses these | 2306 | use build systems based on ``setuptools``. If your recipe uses these |
2342 | build systems, the recipe needs to inherit the ``setuptools3`` class. | 2307 | build systems, the recipe needs to inherit the ``setuptools3`` class. |
2343 | 2308 | ||
2344 | .. _ref-classes-sign_rpm: | 2309 | .. _ref-classes-sign_rpm: |
diff --git a/documentation/ref-manual/migration-2.6.rst b/documentation/ref-manual/migration-2.6.rst index 0517b0a2bb..823d3cbd12 100644 --- a/documentation/ref-manual/migration-2.6.rst +++ b/documentation/ref-manual/migration-2.6.rst | |||
@@ -118,7 +118,7 @@ For names of recipes removed because of this repository change, see the | |||
118 | --------------------------------------------------------------------------------------------------- | 118 | --------------------------------------------------------------------------------------------------- |
119 | 119 | ||
120 | Previously, it was possible for Python recipes that inherited the | 120 | Previously, it was possible for Python recipes that inherited the |
121 | :ref:`distutils <ref-classes-distutils>` and | 121 | ``distutils`` and |
122 | :ref:`distutils3 <ref-classes-distutils3>` classes to fetch code | 122 | :ref:`distutils3 <ref-classes-distutils3>` classes to fetch code |
123 | during the :ref:`ref-tasks-configure` task to satisfy | 123 | during the :ref:`ref-tasks-configure` task to satisfy |
124 | dependencies mentioned in ``setup.py`` if those dependencies were not | 124 | dependencies mentioned in ``setup.py`` if those dependencies were not |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 725600c0e5..5993182568 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -6030,9 +6030,7 @@ system and gives an overview of their function and contents. | |||
6030 | :term:`PYTHON_ABI` | 6030 | :term:`PYTHON_ABI` |
6031 | When used by recipes that inherit the | 6031 | When used by recipes that inherit the |
6032 | :ref:`distutils3 <ref-classes-distutils3>`, | 6032 | :ref:`distutils3 <ref-classes-distutils3>`, |
6033 | :ref:`setuptools3 <ref-classes-setuptools3>`, | 6033 | :ref:`setuptools3 <ref-classes-setuptools3>` classes, denotes the |
6034 | :ref:`distutils <ref-classes-distutils>`, or | ||
6035 | :ref:`setuptools <ref-classes-setuptools>` classes, denotes the | ||
6036 | Application Binary Interface (ABI) currently in use for Python. By | 6034 | Application Binary Interface (ABI) currently in use for Python. By |
6037 | default, the ABI is "m". You do not have to set this variable as the | 6035 | default, the ABI is "m". You do not have to set this variable as the |
6038 | OpenEmbedded build system sets it for you. | 6036 | OpenEmbedded build system sets it for you. |
@@ -6041,16 +6039,14 @@ system and gives an overview of their function and contents. | |||
6041 | names used when installing the Python headers and libraries in | 6039 | names used when installing the Python headers and libraries in |
6042 | sysroot (e.g. ``.../python3.3m/...``). | 6040 | sysroot (e.g. ``.../python3.3m/...``). |
6043 | 6041 | ||
6044 | Recipes that inherit the ``distutils`` class during cross-builds also | 6042 | Recipes that inherit the ``distutils3`` class during cross-builds also |
6045 | use this variable to locate the headers and libraries of the | 6043 | use this variable to locate the headers and libraries of the |
6046 | appropriate Python that the extension is targeting. | 6044 | appropriate Python that the extension is targeting. |
6047 | 6045 | ||
6048 | :term:`PYTHON_PN` | 6046 | :term:`PYTHON_PN` |
6049 | When used by recipes that inherit the | 6047 | When used by recipes that inherit the |
6050 | `distutils3 <ref-classes-distutils3>`, | 6048 | `distutils3 <ref-classes-distutils3>`, |
6051 | :ref:`setuptools3 <ref-classes-setuptools3>`, | 6049 | :ref:`setuptools3 <ref-classes-setuptools3>` classes, specifies the |
6052 | :ref:`distutils <ref-classes-distutils>`, or | ||
6053 | :ref:`setuptools <ref-classes-setuptools>` classes, specifies the | ||
6054 | major Python version being built. For Python 3.x, ``PYTHON_PN`` would | 6050 | major Python version being built. For Python 3.x, ``PYTHON_PN`` would |
6055 | be "python3". You do not have to set this variable as the | 6051 | be "python3". You do not have to set this variable as the |
6056 | OpenEmbedded build system automatically sets it for you. | 6052 | OpenEmbedded build system automatically sets it for you. |