From cc5e2c91974da09c48010bdab47c47be1e8bfb52 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Sat, 1 Dec 2018 20:51:19 -0700 Subject: Update docs about installing scons3 Installing via pip now preferred; no more native-type packages (rpm, msi). Python 3 is supported - seemed one more place was missed that said it had to be Py2. Signed-off-by: Mats Wichmann --- doc/man/scons.xml | 2 +- doc/user/build-install.xml | 289 ++++++++------------------------------------- 2 files changed, 52 insertions(+), 239 deletions(-) diff --git a/doc/man/scons.xml b/doc/man/scons.xml index 9b48f69..9991bf2 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -429,7 +429,7 @@ try to access a list member that does not exist. scons -requires Python version 2.7 or later. +requires Python 2.7 or a Python 3 version of 3.5 or higher. There should be no other dependencies or requirements to run scons. diff --git a/doc/user/build-install.xml b/doc/user/build-install.xml index b3814e7..f45a617 100644 --- a/doc/user/build-install.xml +++ b/doc/user/build-install.xml @@ -90,9 +90,8 @@ Installing Python - Because &SCons; is written in Python, - you must obviously have Python installed on your system + you need to have Python installed on your system to use &SCons;. Before you try to install Python, you should check to see if Python is already @@ -102,27 +101,25 @@ or python --version at your system's command-line prompt. - + For Linux/Unix/MacOS/BSD type systems this looks like: $ python -V -Python 2.5.1 +Python 3.7.1 - - And on a Windows system with Python installed: - + In a cmd shell or PowerShell on a Windows system + (note PoweShell needs it spelled "python.exe" rather than "python"): C:\>python -V -Python 2.5.1 +Python 3.7.1 - If Python is not installed on your system, you will see an error message stating something like "command not found" @@ -132,254 +129,71 @@ Python 2.5.1 (on Windows). In that case, you need to install Python before you can install &SCons;. - - - The standard location for information + Downloading and installing Python differs a bit depending + on the system you are using. The standard location for information about downloading and installing Python is http://www.python.org/download/. - See that page for information about - how to download and install Python on your system. + See that page and associated links to get started. + + + For Linux systems, Python is + almost certainly available as a supported package, possibly + installed by default; this is often preferred to installing + by other means. Many such systems have separate packages for + Python 2 and Python 3. It is also possible to install the source + and build it; some software such as pyenv can + automate this and allow multiple Python versions to be present + on the system if that is of interest. + On MacOS, the python.org packages work well, but many + people prefer to install using other methods such as MacPorts + or Homebrew. + - &SCons; will work with any 2.x version of Python from 2.7 on; - 3.0 and later are not yet supported. + + &SCons; will work with Python 2.7.x or with Python 3.5 or later. If you need to install Python and have a choice, - we recommend using the most recent 2.x Python version available. + we recommend using the most recent Python version available. Newer Pythons have significant improvements that help speed up the performance of &SCons;. -
- Installing &SCons; From Pre-Built Packages + Installing &SCons; - - &SCons; comes pre-packaged for installation on a number of systems, - including Linux and Windows systems. - You do not need to read this entire section, - you should need to read only the section - appropriate to the type of system you're running on. - + The canoncial way to install &SCons; is from the Python Package + Index (PyPi): -
- Installing &SCons; on Red Hat (and Other RPM-based) Linux Systems - - - - &SCons; comes in RPM (Red Hat Package Manager) format, - pre-built and ready to install on Red Hat Linux, - Fedora, - or any other Linux distribution that uses RPM. - Your distribution may - already have an &SCons; RPM built specifically for it; - many do, including SUSE, Mandrake and Fedora. - You can check for the availability of an &SCons; RPM - on your distribution's download servers, - or by consulting an RPM search site like - http://www.rpmfind.net/ or - http://rpm.pbone.net/. - - - - - - If your distribution supports installation via - yum, - you should be able to install &SCons; by running: - - - - -# yum install scons - - - - - If your Linux distribution does not already have - a specific &SCons; RPM file, - you can download and install from the - generic RPM provided by the &SCons; project. - This will install the - SCons script(s) in /usr/bin, - and the SCons library modules in - /usr/lib/scons. - - - - - - To install from the command line, simply download the - appropriate .rpm file, - and then run: - - - - -# rpm -Uvh scons-&buildversion;-1.noarch.rpm - - - - - Or, you can use a graphical RPM package manager. - See your package manager application's documentation - for specific instructions about - how to use it to install a downloaded RPM. - - - -
- -
- Installing &SCons; on Debian Linux Systems - - - - Debian Linux systems use a different package management - format that also makes it very easy to install &SCons;. - - - - - - If your system is connected to the Internet, - you can install the latest official Debian package - by running: - - - - -# apt-get install scons - - - - -
- -
- Installing &SCons; on Windows Systems - - - - &SCons; provides a Windows installer - that makes installation extremely easy. - Download the scons-&buildversion;.win32.exe - file from the &SCons; download page at - http://scons.org/pages/download.html. - Then all you need to do is execute the file - (usually by clicking on its icon in Windows Explorer). - These will take you through a small - sequence of windows that will install - &SCons; on your system. - - - - - - - - + + In some situations it may be preferable to install add-on packages + like &SCons; in a virtualenv; that is a discussion beyond the scope of + this document, but there are numerous Internet resources on the topic. + The same command would be used, just with the virtualenv activated. + -
+ + &SCons; comes pre-packaged for installation on many Linux systems. + Check your package installation system, such as yum, dnf, zypper, + apt-get, aptitude, etc. to see if there is an scons package available. + Many people prefer to install distribution-native packages if available, + as they provide a central point of management and updating. + Some distributions have two &SCons; packages available, one which + uses Python 2 and one which uses Python 3. +
@@ -387,11 +201,10 @@ Python 2.5.1 Building and Installing &SCons; on Any System - If a pre-built &SCons; package is not available for your system, + and installing using pip is not suitable, then you can still easily build and install &SCons; using the native Python distutils package. - @@ -429,11 +242,11 @@ Python 2.5.1 install the &scons; script in the python which is used to run the setup.py's scripts directory (/usr/local/bin or - C:\Python25\Scripts), + C:\Python27\Scripts), and will install the &SCons; build engine in the corresponding library directory for the python used (/usr/local/lib/scons or - C:\Python25\scons). + C:\Python27\scons). Because these are system directories, you may need root (on Linux or UNIX) or Administrator (on Windows) privileges to install &SCons; like this. @@ -489,7 +302,7 @@ Python 2.5.1 in the /usr/lib/scons-&buildversion; or - C:\Python25\scons-&buildversion; + C:\Python27\scons-&buildversion; directory, for example. -- cgit v0.12 From e0c0047fbc8d083384caeba21cc64ec17fa58a3e Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Sun, 2 Dec 2018 13:05:49 -0700 Subject: A few more wording tweaks on scons/python install Signed-off-by: Mats Wichmann --- doc/man/scons.xml | 2 +- doc/user/build-install.xml | 31 ++++++++++++++++++------------- 2 files changed, 19 insertions(+), 14 deletions(-) diff --git a/doc/man/scons.xml b/doc/man/scons.xml index 9991bf2..c374fca 100644 --- a/doc/man/scons.xml +++ b/doc/man/scons.xml @@ -429,7 +429,7 @@ try to access a list member that does not exist. scons -requires Python 2.7 or a Python 3 version of 3.5 or higher. +requires either Python 2.7 or Python 3.5 or higher. There should be no other dependencies or requirements to run scons. diff --git a/doc/user/build-install.xml b/doc/user/build-install.xml index f45a617..7c29344 100644 --- a/doc/user/build-install.xml +++ b/doc/user/build-install.xml @@ -132,8 +132,7 @@ Python 3.7.1 - Downloading and installing Python differs a bit depending - on the system you are using. The standard location for information + The standard location for information about downloading and installing Python is http://www.python.org/download/. See that page and associated links to get started. @@ -143,15 +142,18 @@ Python 3.7.1 For Linux systems, Python is almost certainly available as a supported package, possibly installed by default; this is often preferred to installing - by other means. Many such systems have separate packages for - Python 2 and Python 3. It is also possible to install the source - and build it; some software such as pyenv can - automate this and allow multiple Python versions to be present - on the system if that is of interest. + by other means, and is easier than installing from source code. + Many such systems have separate packages for + Python 2 and Python 3. Building from source may still be a + useful option if you need a version that is not offered by + the distribution you are using. - On MacOS, the python.org packages work well, but many + MacOS comes with a version of Python, but it is somewhat old + and has been known to have some problems - it works well + for the system software that uses it, however. The python.org + packages work well for installing a "better" Python, while some people prefer to install using other methods such as MacPorts or Homebrew. @@ -186,13 +188,16 @@ Python 3.7.1 - &SCons; comes pre-packaged for installation on many Linux systems. - Check your package installation system, such as yum, dnf, zypper, - apt-get, aptitude, etc. to see if there is an scons package available. + &SCons; comes pre-packaged for installation on many Linux systems + Check your package installation system + to see if there is an &SCons; package available. Many people prefer to install distribution-native packages if available, - as they provide a central point of management and updating. + as they provide a central point for management and updating. Some distributions have two &SCons; packages available, one which - uses Python 2 and one which uses Python 3. + uses Python 2 and one which uses Python 3. If you need a specific + version of &SCons; that is different from the package available, + pip has a version option or you can follow + the instructions in the next section. -- cgit v0.12 From 5aa556f11891345e545d7babb20a00ca6625bf59 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Mon, 3 Dec 2018 13:02:49 -0700 Subject: PR #3249 typo fix Signed-off-by: Mats Wichmann --- doc/user/build-install.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user/build-install.xml b/doc/user/build-install.xml index 7c29344..aa3d7af 100644 --- a/doc/user/build-install.xml +++ b/doc/user/build-install.xml @@ -172,7 +172,7 @@ Python 3.7.1 Installing &SCons; - The canoncial way to install &SCons; is from the Python Package + The canonical way to install &SCons; is from the Python Package Index (PyPi): -- cgit v0.12 From 99aa546debed935defa445a53281e24fa607795e Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Mon, 17 Dec 2018 08:29:19 -0700 Subject: More requested changes to install doc (PR #3249) Signed-off-by: Mats Wichmann --- doc/user/build-install.xml | 24 +++++++----------------- 1 file changed, 7 insertions(+), 17 deletions(-) diff --git a/doc/user/build-install.xml b/doc/user/build-install.xml index aa3d7af..fbb14e5 100644 --- a/doc/user/build-install.xml +++ b/doc/user/build-install.xml @@ -150,15 +150,6 @@ Python 3.7.1 - MacOS comes with a version of Python, but it is somewhat old - and has been known to have some problems - it works well - for the system software that uses it, however. The python.org - packages work well for installing a "better" Python, while some - people prefer to install using other methods such as MacPorts - or Homebrew. - - - &SCons; will work with Python 2.7.x or with Python 3.5 or later. If you need to install Python and have a choice, we recommend using the most recent Python version available. @@ -181,12 +172,15 @@ Python 3.7.1 - In some situations it may be preferable to install add-on packages - like &SCons; in a virtualenv; that is a discussion beyond the scope of - this document, but there are numerous Internet resources on the topic. - The same command would be used, just with the virtualenv activated. + If you prefer not to install to the Python system location, + or do not have privileges to do so, you can add a flag to + install to a location specific to your own account: + +% python -m pip install --user scons + + &SCons; comes pre-packaged for installation on many Linux systems Check your package installation system @@ -213,17 +207,14 @@ Python 3.7.1 - The first step is to download either the scons-&buildversion;.tar.gz or scons-&buildversion;.zip, which are available from the SCons download page at http://www.scons.org/download.html. - - Unpack the archive you downloaded, using a utility like tar on Linux or UNIX, @@ -233,7 +224,6 @@ Python 3.7.1 usually in your local directory. Then change your working directory to that directory and install &SCons; by executing the following commands: - -- cgit v0.12