#7121: Document targets for make, especially doc ones, better
---------------------------------+------------------------
Reporter: kcrisman | Owner: tbd
Type: enhancement | Status: new
Priority: minor | Milestone: sage-6.4
Component: documentation | Resolution:
Keywords: | Merged in:
Authors: | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Commit:
Dependencies: | Stopgaps:
---------------------------------+------------------------
Changes (by kcrisman):
* priority: major => minor
Old description:
> On slow machines (or even fast ones), building all the documentation for
> a build which will not be used for general purposes takes a looooong
> time. But even
> [http://www.sagemath.org/doc/installation/documentation.html the install
> guide part about documentation] doesn't mention `make build` to avoid
> this.
>
> This ticket is to improve the install guide so that this, and perhaps all
> make targets, are documented, like all env variables now are.
New description:
On slow machines (or even fast ones), building all the documentation for a
build which will not be used for general purposes takes a looooong time.
But even [http://www.sagemath.org/doc/installation/documentation.html the
install guide part about documentation] doesn't mention `make build` to
avoid this.
This ticket is to improve the install guide so that things are documented
more fully. See [http://www.sagemath.org/doc/installation/source.html
?#section-make here] for current make targets documented.
* Install guide for documentation should mention `make doc` and `make
build` and `make doc-clean`.
* Make targets section should include `make clean`, `make install`, `make
logs`, `make doc-clean`, `make -k` for ignoring errors, and others not
there from [http://git.sagemath.org/sage.git/tree/Makefile the Makefile] -
and if some of those shouldn't be documented, that's okay, but just to say
why on this ticket
* Same section should have a link to the `make ssl` section
* Be sure to mention in that section `make -jNUM` (it's elsewhere but not
there)` and link to how to set `MAKE` to have that standard
It would also be good to have more links from the developer guide to the
installation guide, for instance about this.
--
Comment:
Okay, the [http://www.sagemath.org/doc/installation/source.html?#section-
make installation guide] is a lot better now. Updating description for
some things I see us being able to do now.
--
Ticket URL: <http://trac.sagemath.org/ticket/7121#comment:7>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
