Opened 12 years ago

Closed 15 months ago

#11237 closed enhancement (invalid)

Improve the clarity of the "Install from Source Code" section of the "Sage Installation Guide"

Reported by: David Kirkby Owned by: Minh Van Nguyen
Priority: major Milestone: sage-duplicate/invalid/wontfix
Component: documentation Keywords:
Cc: Jeroen Demeyer, Karl-Dieter Crisman, John Palmieri, Keshav Kini Merged in:
Authors: Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by David Kirkby)

#11159 corrected a large number of errors in the section on installing Sage from source code. It possibly introduced the odd error too, though I think #11159 was a significant improvement. (I might be a little biased in that opinion, as I wrote most of it!)

However, in my own opinion, the whole section could be written a bit more clearly. One obvious step is to separate the sections about building Sage on different platforms, as the mix of information on OS X, Linux and Solaris is a bit confusing. I would suggest different sections for:

  • Linux
  • OS X
  • Solaris/OpenSolaris
  • Cygwin (unsupported, but some hints for those trying)
  • AIX (unsupported, but some hints for those trying)
  • HP-UX (unsupported, but some hints for those trying)

The last two would be very short, but would help someone trying on those platforms.

Also, the preferred commands for installing necessary software on the a number of different Linux distributions. I think we should cover the common ones in a bit more detail.

The commands to be typed at the Sage prompt are prefixed with:

sage:

but those to be typed at the shell command line are not prefixed with anything, and could perhaps best be prefixed with:

$

Those that need root access should start with:

# 

Any comments on any of these points, or generally how to improve the Install from Source Code section of the Sage Installation Guide would be useful.

Dave

Change History (13)

comment:1 Changed 12 years ago by David Kirkby

Description: modified (diff)

comment:2 Changed 12 years ago by John Palmieri

I like the idea of having different sections for different platforms. If merging #11232 means that a suitable version of "patch" needs to be preinstalled on Cygwin, we should mention that in the Cygwin section here.

comment:3 in reply to:  2 Changed 12 years ago by David Kirkby

Replying to jhpalmieri:

I like the idea of having different sections for different platforms. If merging #11232 means that a suitable version of "patch" needs to be preinstalled on Cygwin, we should mention that in the Cygwin section here.

Have you any other suggestions on how this section could be improved?

Dave

comment:4 Changed 11 years ago by Keshav Kini

Cc: Keshav Kini added

comment:5 Changed 11 years ago by Keshav Kini

Apparently m4 needs to be added as a dependency.

comment:6 Changed 11 years ago by Jeroen Demeyer

And libcrypt also.

comment:7 Changed 9 years ago by Jeroen Demeyer

Milestone: sage-5.11sage-5.12

comment:8 Changed 9 years ago by For batch modifications

Milestone: sage-6.1sage-6.2

comment:9 Changed 9 years ago by For batch modifications

Milestone: sage-6.2sage-6.3

comment:10 Changed 8 years ago by For batch modifications

Milestone: sage-6.3sage-6.4

comment:11 Changed 15 months ago by Matthias Köppe

Milestone: sage-6.4sage-duplicate/invalid/wontfix
Status: newneeds_review

outdated, should close

comment:12 Changed 15 months ago by John Palmieri

Status: needs_reviewpositive_review

comment:13 Changed 15 months ago by Matthias Köppe

Resolution: invalid
Status: positive_reviewclosed
Note: See TracTickets for help on using tickets.