Page MenuHomeFreeBSD

math/R: Revert documentation changes
ClosedPublic

Authored by jrm on Nov 3 2016, 4:38 AM.

Details

Summary

math/R: Revert documentation changes

In an attempt to simplify the handling of documentation for users, changes
were made in the last commit. When the documentation knob was off,
(almost) no HTML, PDF, etc. files or their sources were installed, and when
the knob was on, all these files were installed. Because some of these
documentation files depended on some very large TeX ports, despite the
usual convention, the knob was turned off by default. Unfortunately, this
caused problems for a few R-dependent ports, because they copy
documentation files from math/R when they are installed.

Diff Detail

Repository
rP FreeBSD ports repository
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

jrm updated this revision to Diff 21963.Nov 3 2016, 4:38 AM
jrm retitled this revision from to math/R: Revert documentation changes.
jrm updated this object.
jrm added reviewers: swills, AMDmi3.
mat added a comment.Nov 3 2016, 8:10 AM

If other ports *need* the documentation to be installed, then it should not be optional here.

Now that I said that, I have a feeling the correct solution is to fix the other ports to not copy R's documentation when installing.

jrm added inline comments.Nov 3 2016, 11:49 AM
math/R/Makefile
147–153 ↗(On Diff #21963)

This was the part that made those files optional. It's been removed, so they are again installed regardless what the knob is set to. That being said, it does seems strange to copy files from another port. The offending ports are finance/R-cran-timeSeries, finance/R-cran-tseries, math/R-cran-car, and textproc/R-cran-R2HTML. To prevent the error

Warning in file.copy(file.path(R.home("doc"), "html", "R.css"), outman) :
  problem copying /usr/local/share/doc/R/html/R.css to /wrkdirs/usr/ports/finance/R-cran-timeSeries/work/stage/usr/local/lib/R/library/timeSeries/html/R.css: No such file or directory`

they can break the convention of installing documentation by default by using --no-docs and --no-html, although this might be unexpected given these lines in cran.mk.

.if defined(NOPORTDOCS)
R_POSTCMD_INSTALL_OPTIONS+=	--no-docs --no-html
.endif
swills accepted this revision.Nov 3 2016, 1:50 PM
swills edited edge metadata.

Approved

This revision is now accepted and ready to land.Nov 3 2016, 1:50 PM
This revision was automatically updated to reflect the committed changes.
mat added inline comments.Nov 3 2016, 2:05 PM
math/R/Makefile
147–153 ↗(On Diff #21963)

Mmm, ok, but then, do not make the DOCS option install all of texlive, keep the ALLDOCS option.

The idea is that the DOCS option is lightweight, if it brings texlive, it is not any more and it should not be used for it.

jrm added a comment.Nov 3 2016, 2:12 PM

But then we would circle back to the original issue of having multiple knobs for documentation (aside from INFO). The only consolation is that it's a build dependency.

mat added a comment.Nov 3 2016, 3:02 PM
In D8429#175486, @jrm wrote:

But then we would circle back to the original issue of having multiple knobs for documentation (aside from INFO). The only consolation is that it's a build dependency.

Yes, multiple knobs is good, DOCS for the lightweight one, and <WHATEVERYOUWANT> for the one nobody will ever use :-)