From: Alan W. I. <Ala...@gm...> - 2018-07-27 20:12:05
|
On 2018-07-26 14:15+0100 Phil Rosenberg wrote: > I have just made the commits with the RGB interpolation. As far as I > can tell the code all works fine, however I have had some problems > with the documentation. > > It seems that prior to this commit the documentation build has become > broken - at least for Cygwin. Would somebody be able to check it out > on a Linux computer as I no longer have access to one. The cause of this issie is likely some Cygwin package which you forgot to install. On my new Debian Buster system, I am also starting from scratch with installation of documentation-related packages so I will take you through what I had to install to get the the documentation build to work. For -DBUILD_DOC=ON the first set of documentation-related warnings (from the cmake command output) were as follows: -- WARNING: db2x_texixml not found -- WARNING: db2x_xsltproc not found -- WARNING: Not building info documentation - required programs are missing -- WARNING: dblatex not found so not building print documentation In your case, you should find the relevant packages containing those files using <https://cygwin.com/cgi-bin2/package-grep.cgi>, but in my case I used apt-file to do the same job. I then iterated the configuration (starting from an empty build directory), and all the above warnings were gone, but for that second iteration I got this new warning from the cmake output: -- WARNING: xelatex not found so not building print documentation After installing the relevant package, the third iteration had no further warnings concerning building the documentation. I then validated the documentation (without your commmit being applied, yet) using make validate and all was well. I then built all forms of the docbook-generated documentation using make build_docbook_documentation and that completed without any obvious errors. I then tried the same thing with the latest master branch (including your commmits), and got the same good validate and build results. However, I haven't looked at your documentation rewordings, yet in the final info, man, html, and print results because I am busy with something else. But I strongly urge you to do that following the same generic steps as above so you can review the effect of your changes on the resulting documentation and to demonstrate that the documentation build works on Cygwin (if all relevant packages are installed). Of course, if you run into any trouble with the above steps, please give me at least the CMakeCache.txt file and cmake and make output files, and we can figure out together why the documentation build works on Linux, but no longer works on Cygwin. > Also Alan, would you like this change listed in the README.release? If > so where exactly? Yes, please. I assume you will want to insert a paragraph concerning your change in a new section 2.8 of "Improvements relative to the previous release". Also, since you changed the semantics of the two functions (although not their API) for the RGB case you should probably specifically warn the users of this forthcoming release about that semantics change by adding a one-sentence new section 1.10 in "OFFICIAL NOTICES FOR USERS" that refers to your new section 2.8 for the details. Alan __________________________ Alan W. Irwin Programming affiliations with the FreeEOS equation-of-state implementation for stellar interiors (freeeos.sf.net); the Time Ephemerides project (timeephem.sf.net); PLplot scientific plotting software package (plplot.sf.net); the libLASi project (unifont.org/lasi); the Loads of Linux Links project (loll.sf.net); and the Linux Brochure Project (lbproject.sf.net). __________________________ Linux-powered Science __________________________ |