Opened 8 years ago

Closed 8 years ago

#15816 closed defect (fixed)

improve documentation for reviewers

Reported by: rws Owned by:
Priority: major Milestone: sage-duplicate/invalid/wontfix
Component: documentation Keywords: toolchain, beginner
Cc: Merged in:
Authors: Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by rws)

In order to notmake this error:

$ ./sage -dev checkout --ticket 15482
...
$ make
...
Attempting to download package mpc-1.0.2
(builds mpc, ppl...) 

you should give more information in the docs on what commands a potential reviewer will need, i.e. sage -b, tools to analyze coverage etc.

The place where to put it: http://sagemath.org/doc/developer/walk_through.html#reviewing

Change History (10)

comment:1 Changed 8 years ago by rws

  • Description modified (diff)
  • Summary changed from binary package rebuilds toolchain after harmless ticket checkout/make to binary package rebuilds packages after harmless ticket checkout/make

comment:2 Changed 8 years ago by rws

  • Description modified (diff)

comment:3 Changed 8 years ago by rws

Appears to be normal upgrading of packages. Can you please clarify this to users, and a bit more visibly perhaps?

comment:4 in reply to: ↑ description Changed 8 years ago by jdemeyer

  • Component changed from build to documentation

Replying to rws:

How can I avoid this?

You could try simply ./sage -b instead of make to rebuild only the Sage library. However, there is no guarantee that this will work.

It's supposed to be a complete binary...

It is, but it can obviously not contain stuff from tickets that have not been merged yet.

Alternatively, give more information in the docs on what the user has to expect with the binary distribution.

The same as with the source distribution, if you change package versions, those new versions will need to be built.

Where do you think we should add this documentation? Here perhaps?

comment:5 Changed 8 years ago by rws

I had looked in the dev manual and here: http://sagemath.org/doc/developer/walk_through.html#reviewing it says:

You can now test the ticket; you’ll probably want to call make or sage -b first to rebuild Sage with the changes.

I think you should go into detail what builds with the one and the other, or give a link to a page with all commands one might need when looking at more than one ticket.

comment:6 Changed 8 years ago by rws

  • Description modified (diff)
  • Keywords beginner added; binary make removed
  • Summary changed from binary package rebuilds packages after harmless ticket checkout/make to improve documentation for reviewers

Adapted the ticket title/description and set beginner task. Sorry for the noise.

comment:7 Changed 8 years ago by vbraun_spam

  • Milestone changed from sage-6.2 to sage-6.3

comment:8 Changed 8 years ago by rws

  • Milestone changed from sage-6.3 to sage-duplicate/invalid/wontfix
  • Status changed from new to needs_review

This is well enough covered in the dev manuals so ticket invalid.

comment:9 Changed 8 years ago by rws

  • Status changed from needs_review to positive_review

comment:10 Changed 8 years ago by vbraun

  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.