Update docs about installing scons3 (issue #3037) #3249

mwichmann · 2018-12-02T03:56:09Z

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 mats@linux.com

Contributor Checklist:

This is a doc-only change, no code/tests; did not add this to CHANGES.txt.

I have created a new test or updated the unit tests to cover the new/changed functionality.
I have updated master/src/CHANGES.txt directory (and read the README.txt in that directory)
I have updated the appropriate documentation

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 <mats@linux.com>

bdbaddog · 2018-12-02T04:07:07Z

doc/man/scons.xml

@@ -429,7 +429,7 @@ try to access a list member that
 does not exist.</para>

 <para><command>scons</command>
-requires Python version 2.7 or later.
+requires Python 2.7 or a Python 3 version of 3.5 or higher.


I'd say Python 3.5 or higher instead of "A python 3..."

bdbaddog · 2018-12-02T04:07:48Z

doc/user/build-install.xml

@@ -102,27 +101,25 @@
    or
    <userinput>python --version</userinput>
    at your system's command-line prompt.
-
+    For Linux/Unix/MacOS/BSD type systems this looks like:


That'll work on windows..

oh I see. never mind.

bdbaddog · 2018-12-02T04:09:01Z

doc/user/build-install.xml

    </para>

    <para>
-
-    The standard location for information
+    Downloading and installing Python differs a bit depending


I'd omit this addition. The definitive guide to isntall is python.org..

bdbaddog · 2018-12-02T04:09:54Z

doc/user/build-install.xml


+    <para>
+    For Linux systems, Python is


This would be true about macos and maybe *BSD ?

I'd delete this paragraph as well.

bdbaddog · 2018-12-02T04:10:59Z

doc/user/build-install.xml

-      </mediaobject>
-      </screenshot>
+    <screen>
+% <userinput>python -m pip install scons</userinput>


wouldn't it be pip install.. instead of python -m pip ..

No, the current recommendation is to always do python -m pip instead of pip. On some platforms (notably Windows, natch), pip may not be in the search path. And for the increasing number of cases where there is more than one Python, using python -m means we're installing in the place that makes sense for that Python (real, virtualenv, whatever), rather than installing in the place that is decided by finding pip in the search path.

Agreed -- python -mpip is now preferred over pip.

bdbaddog · 2018-12-02T04:11:58Z

doc/user/build-install.xml

-    </section>
+    <para>
+    &SCons; comes pre-packaged for installation on many Linux systems.
+    Check your package installation system, such as yum, dnf, zypper,


maybe don't list them all, but say your system's default (or your preferred) package manager..

okay, I've made a second stab at this.

Signed-off-by: Mats Wichmann <mats@linux.com>

coveralls · 2018-12-02T21:20:36Z

Coverage increased (+1.1%) to 81.355% when pulling 99aa546 on mwichmann:doc-install-update into 55eb6f5 on SCons:master.

Signed-off-by: Mats Wichmann <mats@linux.com>

mwichmann · 2018-12-11T17:00:20Z

Any further comments after the revisions? Or is this good to go?

bdbaddog · 2018-12-12T00:07:03Z

doc/user/build-install.xml

    </para>

    <para>
+    MacOS comes with a version of Python, but it is somewhat old


I'd delete this whole paragraph.

bdbaddog · 2018-12-12T00:13:47Z

doc/user/build-install.xml


-      -->
+    <para>


Delete this paragraph

bdbaddog · 2018-12-12T00:15:29Z

Updated. Basically I don't want to give advice on how to install python or about virtualenv that's not unique to SCons.
So we can just point users at python.org and handle only the scons specific tutoriall.

mwichmann · 2018-12-12T15:01:42Z

Updated. Basically I don't want to give advice on how to install python or about virtualenv that's not unique to SCons.
So we can just point users at python.org and handle only the scons specific tutoriall.

Sure, I won't argue with this. I'm on the back end of this - as a python.org webmaster we get a whole bunch of questions sent there by people who can't figure out how to get their install working, and that is with there being no place that says "email webmaster@python.org if your installation doesn't work right" so we're getting only a fraction of those, meaning I know python.org does no job at all of explaining this in a way people find, AND that tends to make me overdescriptive to compensate. I'll just rip it all out.

bdbaddog · 2018-12-12T16:14:29Z

Historically SCons has not seen many questions about where to get and how to install python. If that were to change then providing that info locally would certainly make sense.
But as supporting SCons itself is yielding sufficient workload.. ;)

Signed-off-by: Mats Wichmann <mats@linux.com>

Update docs about installing scons3

cc5e2c9

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 <mats@linux.com>

bdbaddog reviewed Dec 2, 2018

View reviewed changes

A few more wording tweaks on scons/python install

e0c0047

Signed-off-by: Mats Wichmann <mats@linux.com>

PR SCons#3249 typo fix

5aa556f

Signed-off-by: Mats Wichmann <mats@linux.com>

mwichmann mentioned this pull request Dec 9, 2018

scons install doc doesn't mention pip install #3037

Closed

mwichmann changed the title ~~Update docs about installing scons3~~ Update docs about installing scons3 (issue #3037) Dec 9, 2018

mwichmann mentioned this pull request Dec 9, 2018

Update website and docs to remove reference to windows .exe installer #3115

Closed

bdbaddog reviewed Dec 12, 2018

View reviewed changes

doc/user/build-install.xml

-->

<para>

Copy link

Contributor

bdbaddog Dec 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete this paragraph

More requested changes to install doc (PR SCons#3249)

99aa546

Signed-off-by: Mats Wichmann <mats@linux.com>

bdbaddog merged commit 4daeb49 into SCons:master Dec 17, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update docs about installing scons3 (issue #3037) #3249

Update docs about installing scons3 (issue #3037) #3249

mwichmann commented Dec 2, 2018

bdbaddog Dec 2, 2018

bdbaddog Dec 2, 2018

bdbaddog Dec 2, 2018

bdbaddog Dec 2, 2018

bdbaddog Dec 2, 2018

bdbaddog Dec 12, 2018

bdbaddog Dec 2, 2018

mwichmann Dec 2, 2018

garyo Dec 12, 2018

bdbaddog Dec 2, 2018

mwichmann Dec 2, 2018

coveralls commented Dec 2, 2018 •

edited

Loading

mwichmann commented Dec 11, 2018

bdbaddog Dec 12, 2018

bdbaddog Dec 12, 2018

bdbaddog commented Dec 12, 2018

mwichmann commented Dec 12, 2018

bdbaddog commented Dec 12, 2018

Update docs about installing scons3 (issue #3037) #3249

Update docs about installing scons3 (issue #3037) #3249

Conversation

mwichmann commented Dec 2, 2018

Contributor Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Dec 2, 2018 • edited Loading

mwichmann commented Dec 11, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bdbaddog commented Dec 12, 2018

mwichmann commented Dec 12, 2018

bdbaddog commented Dec 12, 2018

coveralls commented Dec 2, 2018 •

edited

Loading