From patchwork Thu Jan 13 15:38:41 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tim Orling X-Patchwork-Id: 2392 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id B8025C433F5 for ; Thu, 13 Jan 2022 15:39:04 +0000 (UTC) Received: from mail-pj1-f43.google.com (mail-pj1-f43.google.com [209.85.216.43]) by mx.groups.io with SMTP id smtpd.web11.10517.1642088343840583836 for ; Thu, 13 Jan 2022 07:39:04 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20210112 header.b=ZOq2Wmd1; spf=pass (domain: gmail.com, ip: 209.85.216.43, mailfrom: ticotimo@gmail.com) Received: by mail-pj1-f43.google.com with SMTP id rj2-20020a17090b3e8200b001b1944bad25so11504774pjb.5 for ; Thu, 13 Jan 2022 07:39:03 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=Qra5qHC6ExRoJpJI/mbtNrKcp2g+AbxAkOMQYspYBBo=; b=ZOq2Wmd10kEYVJOuPCw3Woz54yQNVSLr3NhibTVHwB1FSzIh5SMwO7TAJhKNwRf+8f PBAWOzGAs0xAxA5NJveSqOV318gf7a7zbMJ7OBtnekr4QdGqXZNicH5FyL2top5t5Dgh MmCquD+HdKARMtupGb/lYoxF8jLkpnHqkyl73/8PT9C1e57swbpWqzLdtKIS8s11TxGj iDSpyLpH0J30ePym5NW6d9vWQTo77Hy5+AtEEofpVv6cy6kVqGyvEKka9AdCiUCJQ3Ih Wfn4O/4LLIQ2JKAkYH5BgcBkeHCCrRaDFiNEnWZ2JrghjJ1vVDuMhmkcgHVzAtJ80kYK mXoA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=Qra5qHC6ExRoJpJI/mbtNrKcp2g+AbxAkOMQYspYBBo=; b=eNC9c58EMjTh9VNmlL5f4FM03TEN9o1lupQR24b3/iB//zLOy9+RpdtkV8CLsdmwVf MTJ20rf9+Iut+OFe5p4eqJv+lfTmzLY4+Nz0dj92kmqPSJ/KCvyefb9FUuLgNKXCic66 9uZ2cSNy06c9HY6rhyLxWywMIVpCPjqWXLEssf3B8lHxw5P8IueOg3QwJDtf/i4PnVTU W//Osuv8bT9PlHmIwhmalpWx7MWAeKDRd97nxJi7x8lnimUuAx2yY/fcsJ93/Knv8IE6 IyRFgnTSynIJou15BHC0v2LtRgdQ4Q9Ln9ZhfvoqwJSzHcRo//0dweJy/5U2Pyomjnz+ mP0g== X-Gm-Message-State: AOAM533m6NNLPOMTbkjgLvkh3JQ/q57SfYmBU6Dqawu2XDhI4CjbVlCj KACWfq3LGsc8XFfw5Snczgp3ew2wBjs= X-Google-Smtp-Source: ABdhPJzcnEe04JPGtMKT2Ime0/5BSIXGYRCeBD1d5CX/Ap+mhu409Z3Iryr8Jo2D0rwWoPTGja/WXw== X-Received: by 2002:a17:90b:4a90:: with SMTP id lp16mr11857427pjb.39.1642088342690; Thu, 13 Jan 2022 07:39:02 -0800 (PST) Received: from nereus.hsd1.or.comcast.net ([2601:1c0:6000:1b20:bf73:e59:4f56:2dd4]) by smtp.gmail.com with ESMTPSA id q12sm3278507pfk.136.2022.01.13.07.39.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Jan 2022 07:39:02 -0800 (PST) From: Tim Orling X-Google-Original-From: Tim Orling To: docs@lists.yoctoproject.org Cc: Tim Orling Subject: [PATCH v2 1/3] ref-manual/variables.rst: add SETUPTOOLS_SETUP_PATH Date: Thu, 13 Jan 2022 07:38:41 -0800 Message-Id: <20220113153843.2544066-1-tim.orling@konsulko.com> X-Mailer: git-send-email 2.30.2 MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 13 Jan 2022 15:39:04 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/2406 Add SETUPTOOLS_SETUP_PATH for setuptools3 class. Deprecate DISTUTILS_SETUP_PATH and drop mention of ref-classes-setuptools3 as that class has moved to new variable. [YOCTO #14610] Signed-off-by: Tim Orling --- Changes in v2: - fix whitespace error documentation/ref-manual/variables.rst | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index be496161b..7c2f74a39 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -1985,8 +1985,7 @@ system and gives an overview of their function and contents. :term:`DISTUTILS_SETUP_PATH` When used by recipes that inherit the - :ref:`distutils3 ` or - :ref:`setuptools3 ` class, this variable should + :ref:`distutils3 ` class, this variable should be used to specify the directory in which the ``setup.py`` file is located if it is not at the root of the source tree (as specified by :term:`S`). For example, in a recipe where the sources are fetched from @@ -1996,6 +1995,13 @@ system and gives an overview of their function and contents. S = "${WORKDIR}/git" DISTUTILS_SETUP_PATH = "${S}/python/pythonmodule" + .. note:: + + ``distutils`` has been deprecated in Python 3.10 and will be removed + in Python 3.12. For this reason, the use of :ref:`distutils3 ` + is deprecated. Instead use :ref:`setuptools3 ` and the + :term:`SETUPTOOLS_SETUP_PATH` variable. + :term:`DL_DIR` The central download directory used by the build process to store downloads. By default, :term:`DL_DIR` gets files suitable for mirroring @@ -6841,6 +6847,18 @@ system and gives an overview of their function and contents. EXTRA_IMAGE_FEATURES += "read-only-rootfs" + :term:`SETUPTOOLS_SETUP_PATH` + When used by recipes that inherit the + :ref:`setuptools3 ` class, this variable should + be used to specify the directory in which the ``setup.py`` file is + located if it is not at the root of the source tree (as specified by + :term:`S`). For example, in a recipe where the sources are fetched from + a Git repository and ``setup.py`` is in a ``python/pythonmodule`` + subdirectory, you would have this:: + + S = "${WORKDIR}/git" + SETUPTOOLS_SETUP_PATH = "${S}/python/pythonmodule" + :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS` A list of recipe dependencies that should not be used to determine signatures of tasks from one recipe when they depend on tasks from From patchwork Thu Jan 13 15:38:42 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tim Orling X-Patchwork-Id: 2393 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id A8D20C433FE for ; Thu, 13 Jan 2022 15:39:05 +0000 (UTC) Received: from mail-pl1-f176.google.com (mail-pl1-f176.google.com [209.85.214.176]) by mx.groups.io with SMTP id smtpd.web10.10205.1642088345245951785 for ; Thu, 13 Jan 2022 07:39:05 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20210112 header.b=FTTFXBs7; spf=pass (domain: gmail.com, ip: 209.85.214.176, mailfrom: ticotimo@gmail.com) Received: by mail-pl1-f176.google.com with SMTP id a7so7703131plh.1 for ; Thu, 13 Jan 2022 07:39:05 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=5/Ji1TDUVEX9sUi0PqSvGVdeBkkfO1USqEHjZywpo+E=; b=FTTFXBs79liIi6xsHcNTn1f3PebANlkV7yvtvaYWs+zWQYw7Y+qIkTFQ1yKgnia+FZ GDKIC5Z4kIBohfa+0YIDd6HW/X0R78WeCWX0ErkrvJ482K1gHLrnYiR1OQyhwb6Y8bMM eo60O2HPRmG7DVTZY+uwpW0/qeT+dg0pqxlEiD4bEzTPrWCn9D3BOFGKXt4Mxy45OTC/ KiJ8XXasPBEq1FA0W33XwjhZHdbW7SHfQV2qwRRB+J4cv2hqHhVHIlFpt/JjA3MDw6xp +21X47cZuKpwjYTKP2CZtwbNsF4nSuheOiis8y2GK2DZgxYZqzW30hgNbyxd3E25KhI0 yJeQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=5/Ji1TDUVEX9sUi0PqSvGVdeBkkfO1USqEHjZywpo+E=; b=sABe4iXMwjhEfru0ICK9oPGSoaT2FLidwbztdu/3hY7zRaY3Dx0C2yZzaBGMKH90+y 7LbSINL6mXPSTFtm12HV82tulzwTSd1CfzEB+I8Y9yNabLL8GCy6+mDOuGkKukRn0JjL YJ5ECexzpCmi3NUq0A+dULmIrqi0lvrKuvkrbGL1dKOUN4fBiFxttAe+bHuRaC5KwuSC t/oY74QhODhErl4XEYYGxNYqp2G89rvQM8nGyufGWvo90Onar9bk8lLPqsVMgXABavIC jwXL55cEB4RfjdjWj1kxqRA7Kqla+OGGbb+Lib35mI5f5QlAZoTHUEifJhL8NstnOEVp i5mw== X-Gm-Message-State: AOAM530NUCJ7nsaXD4wmjn7bH1bD1qmvvAh7JGL5rBw6QkITu30pSRIn 6cJY4usV5ZRGWE9lp9j97UbnXmH5LCA= X-Google-Smtp-Source: ABdhPJxur0cEaoDFnFrwjyrZqjP2mpw9HewIbmqHn+q4AWpaJFHC/ifRi24UC7/teiEiaQOqtF8gwQ== X-Received: by 2002:a17:90a:f193:: with SMTP id bv19mr14845114pjb.157.1642088344435; Thu, 13 Jan 2022 07:39:04 -0800 (PST) Received: from nereus.hsd1.or.comcast.net ([2601:1c0:6000:1b20:bf73:e59:4f56:2dd4]) by smtp.gmail.com with ESMTPSA id q12sm3278507pfk.136.2022.01.13.07.39.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Jan 2022 07:39:04 -0800 (PST) From: Tim Orling X-Google-Original-From: Tim Orling To: docs@lists.yoctoproject.org Cc: Tim Orling Subject: [PATCH v2 2/3] ref-manual/variables.rst: add SETUPTOOLS_*_ARGS Date: Thu, 13 Jan 2022 07:38:42 -0800 Message-Id: <20220113153843.2544066-2-tim.orling@konsulko.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220113153843.2544066-1-tim.orling@konsulko.com> References: <20220113153843.2544066-1-tim.orling@konsulko.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 13 Jan 2022 15:39:05 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/2407 Add SETUPTOOLS_BUILD_ARGS variable which can be used to pass additional arguments to `setup.py build`. Add SETUPTOOLS_INSTALL_ARGS variable which can be used to pass additional arguments to `setup.py install`. [YOCTO #14610] Signed-off-by: Tim Orling --- Changes in v2: - drop "default" variable examples, as this is brittle and perhaps not providing that much value. documentation/ref-manual/variables.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 7c2f74a39..37231a3cd 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -6847,6 +6847,18 @@ system and gives an overview of their function and contents. EXTRA_IMAGE_FEATURES += "read-only-rootfs" + :term:`SETUPTOOLS_BUILD_ARGS` + When used by recipes that inherit the + :ref:`setuptools3 ` class, this variable can + be used to specify additional arguments to be passed to ``setup.py build`` + in the ``setuptools3_do_compile()`` task. + + :term:`SETUPTOOLS_INSTALL_ARGS` + When used by recipes that inherit the + :ref:`setuptools3 ` class, this variable can + be used to specify additional arguments to be passed to ``setup.py install`` + in the ``setuptools3_do_install()`` task. + :term:`SETUPTOOLS_SETUP_PATH` When used by recipes that inherit the :ref:`setuptools3 ` class, this variable should From patchwork Thu Jan 13 15:38:43 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tim Orling X-Patchwork-Id: 2394 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 94DA6C433F5 for ; Thu, 13 Jan 2022 15:39:08 +0000 (UTC) Received: from mail-pj1-f52.google.com (mail-pj1-f52.google.com [209.85.216.52]) by mx.groups.io with SMTP id smtpd.web08.10455.1642088347670346220 for ; Thu, 13 Jan 2022 07:39:07 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@gmail.com header.s=20210112 header.b=m4R0Qr7z; spf=pass (domain: gmail.com, ip: 209.85.216.52, mailfrom: ticotimo@gmail.com) Received: by mail-pj1-f52.google.com with SMTP id i8-20020a17090a138800b001b3936fb375so19283682pja.1 for ; Thu, 13 Jan 2022 07:39:07 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=3IOj4YbRcsx1gu+CMcTPcxDfVcLkIrlFnoCORelzh9Q=; b=m4R0Qr7zRt22gJBGGhfNEoJRcvu2mmWEaVKyeHkKirQdSwypo6QsXrI/n2zTRECrqL RFyyQV0BUHqCfBfpB1AiX2X1cY2C2BvlXh0JWcmq0SI5FtvakU+u0MTiZdDTVg+QcRL1 5OLawF/n+EFQ1NmtYzYTIE2p0q/wrYU7KT5M0hY40A/ZNJM9RDhPM0VrauNMBywXFUM9 Bf24/RrEMkS+n3kKCXCONGnrfNQmPwlT1zBmC3QtqZ+MMgOTo7yNm4HQUB5O2orqOMgt 76Ldu9j0JMHKxv5LYPIUhQ+BDso41pgu/2/P/8mMoRttsCcfdVmY0nn3+pQtEN0k5cki 0fHA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=3IOj4YbRcsx1gu+CMcTPcxDfVcLkIrlFnoCORelzh9Q=; b=cqbB5pxvjl4uzIuCIyP4bh59LqT1rBp9PxMJPodh1R0GycCc1+9N5fmx70BBGO4uRs PITU8DypHngy1ydIPMhNhbqcvrUpkaH7vvXFu4vH182bk/rhdXeMqCncqAg7HFUCsBii kPHmF1P5IHxKJXa14Szi57Pzy8ZPCuGRjjnwkOJ8CwM0uKj44L1fPkjRnR+uP0UxMUAD YGI+fIiCokmp/jXtvQJ0ED3Lpmf+NEUuDOBQYypL51/ShDXralYLQBnPoZIZlbOfOOcc gKvXKiGWxTvDK+6N+FdqhBAhGUzNK8bLycrX8ssj0J/QTLgHe1+t8jICnCvcYlLs3q0A AbVw== X-Gm-Message-State: AOAM531UW+cMIVd+xv5dugDOzSVX1GQkT9ReYZwyHpF6cDyfbWxy8rpe p1eBG777O2QXWhkO0R/1pAoCS4Koe1M= X-Google-Smtp-Source: ABdhPJzJuOEfj9isZuOxoLImiwZFTngniIQOdkDf9DDqS+1aCkf4VyDsv6G3oO17U8TuTD/rqOIzOg== X-Received: by 2002:a17:90a:c098:: with SMTP id o24mr5707859pjs.145.1642088346942; Thu, 13 Jan 2022 07:39:06 -0800 (PST) Received: from nereus.hsd1.or.comcast.net ([2601:1c0:6000:1b20:bf73:e59:4f56:2dd4]) by smtp.gmail.com with ESMTPSA id q12sm3278507pfk.136.2022.01.13.07.39.06 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 13 Jan 2022 07:39:06 -0800 (PST) From: Tim Orling X-Google-Original-From: Tim Orling To: docs@lists.yoctoproject.org Cc: Tim Orling Subject: [PATCH v2 3/3] ref-manual/classes.rst: add setuptools3-base Date: Thu, 13 Jan 2022 07:38:43 -0800 Message-Id: <20220113153843.2544066-3-tim.orling@konsulko.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220113153843.2544066-1-tim.orling@konsulko.com> References: <20220113153843.2544066-1-tim.orling@konsulko.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Thu, 13 Jan 2022 15:39:08 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/2408 Add setuptools3-base class Deprecate distutils3* classes. [YOCTO #14610] Signed-off-by: Tim Orling Reviewed-by: Michael Opdenacker --- Changes in v2: - fix whitespace errors - add ref-classes-setuptools3 links documentation/ref-manual/classes.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 99d9a7a3e..12a9fd83a 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -515,6 +515,14 @@ used. - Extensions that use ``distutils``-based build systems require the ``distutils`` class in their recipes. + .. note:: + + ``distutils`` has been deprecated in Python 3.10 and will be removed + in Python 3.12. For this reason the ``distutils3*`` classes are now + deprecated and will be removed from core in the near future. Instead, + use the ``setuptools3*`` classes. + + - Extensions that use build systems based on ``setuptools3`` require the :ref:`setuptools3 ` class in their recipes. @@ -2376,6 +2384,17 @@ The ``setuptools3`` class supports Python version 3.x extensions that use build systems based on ``setuptools``. If your recipe uses these build systems, the recipe needs to inherit the ``setuptools3`` class. +.. _ref-classes-setuptools3-base: + +``setuptools3-base.bbclass`` +============================ + +The ``setuptools3-base`` class provides a reusable base for other classes +that support building Python version 3.x extensions. If you need +functionality that is not provided by the :ref:`setuptools3