Opened 10 years ago

Last modified 10 years ago

#14465 closed enhancement

Clean source.rst and include instructions for Cygwin — at Version 13

Reported by: Jean-Pierre Flori Owned by: Minh Van Nguyen
Priority: major Milestone: sage-5.9
Component: documentation Keywords:
Cc: Leif Leonhardy, Julien Puydt, Jeroen Demeyer Merged in:
Authors: Jean-Pierre Flori Reviewers: Karl-Dieter Crisman
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: #14031 Stopgaps:

Status badges

Change History (15)

Changed 10 years ago by Jean-Pierre Flori

Attachment: source.patch added

comment:1 Changed 10 years ago by Jean-Pierre Flori

Description: modified (diff)
Status: newneeds_review

comment:2 Changed 10 years ago by Karl-Dieter Crisman

Dependencies: #14031
Reviewers: Karl-Dieter Crisman

I like this! Comments:

  • Small note; we don't necessarily need Xcode, but just the command line tools, which is FREE but which still does require a (free) Apple Developer account.
  • Also, we do supply sage -i openssl for exactly the reason that we want Sage to be self-contained, so your removal of this command is not helpful, even though I understand where you are going. On Mac, for instance, sage -i openssl will probably be easier for a lot of people. At least in line 259 ff. I think that it is misleading to have a link to a huge set of instructions and then add these things, which then look very important.
  • This apparently depends on #14031.
  • It would be really helpful to include a link or even just mention MAKE="make -jNUM" at the initial mention of make.

I would prefer that at least a couple people review this, just to make sure that something didn't go missing during the conversion. But overall a nice improvement and it applies, builds doc, looks good and complete, etc.

comment:3 in reply to:  2 ; Changed 10 years ago by Jean-Pierre Flori

Replying to kcrisman:

I like this! Comments:

  • Small note; we don't necessarily need Xcode, but just the command line tools, which is FREE but which still does require a (free) Apple Developer account.

Ok, I'll try to add this though I never actually use a Mac.

  • Also, we do supply sage -i openssl for exactly the reason that we want Sage to be self-contained, so your removal of this command is not helpful, even though I understand where you are going. On Mac, for instance, sage -i openssl will probably be easier for a lot of people. At least in line 259 ff. I think that it is misleading to have a link to a huge set of instructions and then add these things, which then look very important.

It's still in the installing the notebook with ssl support part. And in the prereq part i mention that Sage ships all the needed stuff (alhtough you need an internet connection, what the "to download separatly" should suggest, any better phrasing welcome, I'm no native english speaker so excuse my french). Of course I could mention that you can run ./sage -i openssl in the prereq part, but the whole point of this section is to suggest to install system wide openssl (which on Linux/Solaris/Cygwin?/FreeBSD should be quite default, at least for ssh users)

  • This apparently depends on #14031.

Correct!

  • It would be really helpful to include a link or even just mention MAKE="make -jNUM" at the initial mention of make.

Ok, I'll add that, makes sense with the usual current hardware.

I would prefer that at least a couple people review this, just to make sure that something didn't go missing during the conversion. But overall a nice improvement and it applies, builds doc, looks good and complete, etc.

comment:4 in reply to:  3 Changed 10 years ago by Jean-Pierre Flori

Replying to jpflori:

Replying to kcrisman:

I like this! Comments:

  • Small note; we don't necessarily need Xcode, but just the command line tools, which is FREE but which still does require a (free) Apple Developer account.

Could you provide more info about the current situation? The only online ressource I could find is https://developer.apple.com/xcode/. I also registered for an Apple dev account, but apart from Java stuff and old versions of Xcode there is not much to download on the website. I guess that only actual Mac owners can download Xcode from the "Mac App Store". It seems to be free now though. Is there still a separate "Command line tools" download? On the Xcode page it is mentioned as an optional download for Xcode.

comment:5 Changed 10 years ago by Jean-Pierre Flori

Additional question: as it seems the "command line" part is now an optional dowload to perform from Xcode, is Xcode by itself sufficient? Or should the user download Xcode and then use it to download the "command line tools" part which is the only required part?

I'll post that question on Sage's devel.

comment:6 Changed 10 years ago by Leif Leonhardy

Cc: Leif Leonhardy added

comment:7 Changed 10 years ago by Leif Leonhardy

Cc: jpuydt added

There is no such thing as x64... ;-) (s/x64/x86_64/)


There is no mention of ARM (afaics from the patch at least).

comment:8 Changed 10 years ago by Leif Leonhardy

Cc: Julien Puydt added; jpuydt removed

Oooops.

comment:9 Changed 10 years ago by Julien Puydt

A GNU/Linux/ARM is just a GNU/Linux so there isn't anything special to document about it. Especially if it's already documented that you need a good amount of RAM to build.

comment:10 Changed 10 years ago by Leif Leonhardy

Hmmm, what Sage version do I need to apply the patch... %-/

(Unfortunately, also feels like 90% of the patch was reST source reformatting.)

comment:11 in reply to:  10 Changed 10 years ago by Jean-Pierre Flori

Replying to leif:

Hmmm, what Sage version do I need to apply the patch... %-/

I'd say 5.9.beta5, doesn't it work?

(Unfortunately, also feels like 90% of the patch was reST source reformatting.)

Yes, lot of reformatting, but including subtle changes here and there... Sorry about that.

comment:12 in reply to:  7 Changed 10 years ago by Jean-Pierre Flori

Replying to leif:

There is no such thing as x64... ;-) (s/x64/x86_64/)

Oops.


There is no mention of ARM (afaics from the patch at least).

Is it officially supported? :)

Changed 10 years ago by Jean-Pierre Flori

Attachment: source.2.patch added

comment:13 Changed 10 years ago by Jean-Pierre Flori

Description: modified (diff)

Updated patch.

Note: See TracTickets for help on using tickets.