From: "Paul Eggleton" <paul.eggleton@linux.microsoft.com>
To: docs@lists.yoctoproject.org
Subject: [PATCH 02/13] Use variables for minimum host versions and bump Python to 3.6
Date: Tue, 13 Apr 2021 17:19:43 -0700 [thread overview]
Message-ID: <3f22dfaa1b2a535f1cb153e1f465bd69cfe3cfbb.1618358456.git.paul.eggleton@linux.microsoft.com> (raw)
In-Reply-To: <cover.1618358456.git.paul.eggleton@linux.microsoft.com>
From: Paul Eggleton <paul.eggleton@microsoft.com>
Minimum Git, tar, Python and gcc versions are specified in quite a few
different places. Let's add some variables for these so there's no
chance of missing one if they're updated in future. Additionally, for
hardknott the minimum Python version is 3.6 so set that as the value for
Python.
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
---
documentation/brief-yoctoprojectqs/index.rst | 8 ++++----
documentation/dev-manual/start.rst | 8 ++++----
documentation/poky.yaml | 4 ++++
documentation/ref-manual/faq.rst | 2 +-
documentation/ref-manual/system-requirements.rst | 8 ++++----
5 files changed, 17 insertions(+), 13 deletions(-)
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index 7bba47e..974ae5e 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -60,10 +60,10 @@ following requirements:
-
- - Git 1.8.3.1 or greater
- - tar 1.28 or greater
- - Python 3.5.0 or greater.
- - gcc 5.0 or greater.
+ - Git &MIN_GIT_VERSION; or greater
+ - tar &MIN_TAR_VERSION; or greater
+ - Python &MIN_PYTHON_VERSION; or greater.
+ - gcc &MIN_GCC_VERSION; or greater.
If your build host does not meet any of these three listed version
requirements, you can take steps to prepare the system so that you
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst
index 3903618..84abf4c 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -314,13 +314,13 @@ Project Build Host:
should be able to run on any modern distribution that has the
following versions for Git, tar, Python and gcc.
- - Git 1.8.3.1 or greater
+ - Git &MIN_GIT_VERSION; or greater
- - tar 1.28 or greater
+ - tar &MIN_TAR_VERSION; or greater
- - Python 3.5.0 or greater.
+ - Python &MIN_PYTHON_VERSION; or greater.
- - gcc 5.0 or greater.
+ - gcc &MIN_GCC_VERSION; or greater.
If your build host does not meet any of these three listed version
requirements, you can take steps to prepare the system so that you
diff --git a/documentation/poky.yaml b/documentation/poky.yaml
index e0cf0b3..8ccb359 100644
--- a/documentation/poky.yaml
+++ b/documentation/poky.yaml
@@ -40,3 +40,7 @@ CENTOS8_HOST_PACKAGES_ESSENTIAL : "-y epel-release
python3-GitPython python3-jinja2 python3-pexpect xz which SDL-devel xterm \
rpcgen mesa-libGL-devel"
PIP3_HOST_PACKAGES_DOC : "$ sudo pip3 install sphinx sphinx_rtd_theme pyyaml"
+MIN_PYTHON_VERSION : "3.6.0"
+MIN_TAR_VERSION : "1.28"
+MIN_GIT_VERSION : "1.8.3.1"
+MIN_GCC_VERSION : "5.0"
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index 3b65588..64fdfdf 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -16,7 +16,7 @@ first before being pulled back into Poky. This practice benefits both
projects immediately.
**Q:** My development system does not meet the required Git, tar, and
-Python versions. In particular, I do not have Python 3.5.0 or greater.
+Python versions. In particular, I do not have Python &MIN_PYTHON_VERSION; or greater.
Can I still use the Yocto Project?
**A:** You can get the required tools on your host development system a
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 6edfa1a..dc619ce 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -256,11 +256,11 @@ Required Git, tar, Python and gcc Versions
In order to use the build system, your host development system must meet
the following version requirements for Git, tar, and Python:
-- Git 1.8.3.1 or greater
+- Git &MIN_GIT_VERSION; or greater
-- tar 1.28 or greater
+- tar &MIN_TAR_VERSION; or greater
-- Python 3.5.0 or greater
+- Python &MIN_PYTHON_VERSION; or greater
If your host development system does not meet all these requirements,
you can resolve this by installing a ``buildtools`` tarball that
@@ -270,7 +270,7 @@ a pre-built tarball or use BitBake to build the tarball.
In addition, your host development system must meet the following
version requirement for gcc:
-- gcc 5.0 or greater
+- gcc &MIN_GCC_VERSION; or greater
If your host development system does not meet this requirement, you can
resolve this by installing a ``buildtools-extended`` tarball that
--
1.8.3.1
next prev parent reply other threads:[~2021-04-14 0:19 UTC|newest]
Thread overview: 40+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-14 0:19 [PATCH 00/13] Documentation updates for 3.3 Paul Eggleton
2021-04-14 0:19 ` [PATCH 01/13] ref-manual: add METADATA_REVISION and METADATA_BRANCH Paul Eggleton
2021-04-14 7:59 ` [docs] " Quentin Schulz
2021-04-14 0:19 ` Paul Eggleton [this message]
2021-04-14 0:19 ` [PATCH 03/13] ref-manual: update/fix text for SDK_VERSION Paul Eggleton
2021-04-14 0:19 ` [PATCH 04/13] overview-manual: fix git command line Paul Eggleton
2021-04-14 0:19 ` [PATCH 05/13] ref-manual: and SDK_CUSTOM_TEMPLATECONF to glossary Paul Eggleton
2021-04-14 8:03 ` [docs] " Quentin Schulz
2021-04-14 0:19 ` [PATCH 06/13] ref-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION entry Paul Eggleton
2021-04-14 8:10 ` [docs] " Quentin Schulz
2021-04-14 8:17 ` Nicolas Dechesne
2021-04-14 0:19 ` [PATCH 07/13] ref-manual: add python3targetconfig class and remove python 2 references Paul Eggleton
2021-04-14 0:19 ` [PATCH 08/13] ref-manual: add passwd-expire to EXTRA_USERS_PARAMS Paul Eggleton
2021-04-14 8:13 ` [docs] " Quentin Schulz
2021-04-14 8:19 ` Nicolas Dechesne
2021-04-14 8:36 ` Robert P. J. Day
2021-04-15 14:18 ` Michael Opdenacker
2021-04-14 0:19 ` [PATCH 09/13] ref-manual: add FIT_KERNEL_COMP_ALG* Paul Eggleton
2021-04-14 8:16 ` [docs] " Quentin Schulz
2021-04-14 8:35 ` Robert P. J. Day
2021-04-14 8:41 ` Quentin Schulz
2021-04-14 8:43 ` Robert P. J. Day
2021-04-15 10:07 ` Paul Eggleton
2021-04-14 0:19 ` [PATCH 10/13] ref-manual: fix reference to build-essential Paul Eggleton
2021-04-14 8:17 ` [docs] " Quentin Schulz
2021-04-14 8:21 ` Nicolas Dechesne
2021-04-14 0:19 ` [PATCH 11/13] ref-manual: tweak buildtools section Paul Eggleton
2021-04-14 0:19 ` [PATCH 12/13] ref-manual: add migration section for 3.3 release Paul Eggleton
2021-04-14 8:26 ` [docs] " Quentin Schulz
2021-04-15 9:52 ` Paul Eggleton
2021-04-15 9:59 ` Quentin Schulz
2021-04-15 10:25 ` Nicolas Dechesne
2021-04-15 14:07 ` Quentin Schulz
2021-04-15 17:32 ` Nicolas Dechesne
2021-04-15 14:14 ` Michael Opdenacker
2021-04-14 0:19 ` [PATCH 13/13] ref-manual: migration guide: add release codenames Paul Eggleton
2021-04-14 8:28 ` [docs] " Quentin Schulz
2021-04-15 13:54 ` [docs] [PATCH 00/13] Documentation updates for 3.3 Michael Opdenacker
2021-04-15 14:00 ` Quentin Schulz
2021-04-15 14:05 ` Michael Opdenacker
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=3f22dfaa1b2a535f1cb153e1f465bd69cfe3cfbb.1618358456.git.paul.eggleton@linux.microsoft.com \
--to=paul.eggleton@linux.microsoft.com \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox