New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 3 commits into
base: master
from

Conversation

Projects
None yet
4 participants
@mwichmann
Contributor

mwichmann commented Dec 2, 2018

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

This comment has been minimized.

@bdbaddog

bdbaddog Dec 2, 2018

Contributor

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

@@ -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:

This comment has been minimized.

@bdbaddog

bdbaddog Dec 2, 2018

Contributor

That'll work on windows..

This comment has been minimized.

@bdbaddog

bdbaddog Dec 2, 2018

Contributor

oh I see. never mind.

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

This comment has been minimized.

@bdbaddog

bdbaddog Dec 2, 2018

Contributor

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

<para>
For Linux systems, Python is

This comment has been minimized.

@bdbaddog

bdbaddog Dec 2, 2018

Contributor

This would be true about macos and maybe *BSD ?

This comment has been minimized.

@bdbaddog

bdbaddog Dec 12, 2018

Contributor

I'd delete this paragraph as well.

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

This comment has been minimized.

@bdbaddog

bdbaddog Dec 2, 2018

Contributor

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

This comment has been minimized.

@mwichmann

mwichmann Dec 2, 2018

Contributor

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.

This comment has been minimized.

@garyo

garyo Dec 12, 2018

Contributor

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

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

This comment has been minimized.

@bdbaddog

bdbaddog Dec 2, 2018

Contributor

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

This comment has been minimized.

@mwichmann

mwichmann Dec 2, 2018

Contributor

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

A few more wording tweaks on scons/python install
Signed-off-by: Mats Wichmann <mats@linux.com>
@coveralls

This comment has been minimized.

coveralls commented Dec 2, 2018

Coverage Status

Coverage increased (+1.4%) to 81.666% when pulling 5aa556f on mwichmann:doc-install-update into 55eb6f5 on SCons:master.

PR #3249 typo fix
Signed-off-by: Mats Wichmann <mats@linux.com>

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

@mwichmann

This comment has been minimized.

Contributor

mwichmann commented Dec 11, 2018

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

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

This comment has been minimized.

@bdbaddog

bdbaddog Dec 12, 2018

Contributor

I'd delete this whole paragraph.

-->
<para>

This comment has been minimized.

@bdbaddog

bdbaddog Dec 12, 2018

Contributor

Delete this paragraph

@bdbaddog

This comment has been minimized.

Contributor

bdbaddog commented Dec 12, 2018

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

This comment has been minimized.

Contributor

mwichmann commented Dec 12, 2018

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

This comment has been minimized.

Contributor

bdbaddog commented Dec 12, 2018

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.. ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment