Opened 8 years ago

Last modified 5 years ago

#11237 new enhancement

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

Reported by: drkirkby Owned by: mvngu
Priority: major Milestone: sage-6.4
Component: documentation Keywords:
Cc: jdemeyer, kcrisman, jhpalmieri, kini Merged in:
Authors: Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description (last modified by drkirkby)

#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 (10)

comment:1 Changed 8 years ago by drkirkby

  • Description modified (diff)

comment:2 follow-up: Changed 8 years ago by 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.

comment:3 in reply to: ↑ 2 Changed 8 years ago by drkirkby

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 7 years ago by kini

  • Cc kini added

comment:5 Changed 7 years ago by kini

Apparently m4 needs to be added as a dependency.

comment:6 Changed 7 years ago by jdemeyer

And libcrypt also.

comment:7 Changed 6 years ago by jdemeyer

  • Milestone changed from sage-5.11 to sage-5.12

comment:8 Changed 6 years ago by vbraun_spam

  • Milestone changed from sage-6.1 to sage-6.2

comment:9 Changed 5 years ago by vbraun_spam

  • Milestone changed from sage-6.2 to sage-6.3

comment:10 Changed 5 years ago by vbraun_spam

  • Milestone changed from sage-6.3 to sage-6.4
Note: See TracTickets for help on using tickets.