Reviewing Octave Forge packages: Difference between revisions

Jump to navigation Jump to search
(4 intermediate revisions by one other user not shown)
Line 19: Line 19:


<pre>
<pre>
[ ] release candidate installed on latest stable Octave release
== Repository ==
[ ] no compiler errors or serious warnings
[ ] maintainer has specified a corresponding revision commit/changeset
[ ] ran all tests using runtests (including tests in the src dir)
[ ] checkout code from Sourceforge, commit/changeset is present
== Compile and Install ==
[ ] release candidate installs on latest stable Octave release
[ ] no compiler errors or warnings
[ ] ran tests using <code>runtests /path/to/pkg</code>
[ ] ran all tests, including those in src (how??)
[ ] ran doctest on all functions (optional)
[ ] ran doctest on all functions (optional)
[ ] Above steps were run on Octave versions:
[ ] ran generate_package_html (if Makefile present try <code> make html </code>)
[ ] no makeinfo errors and warnings during HTML build
[ ] unpacked and spot-checked the generated HTML documentation
== Interaction with pkg ==
[ ] <code>pkg load foo</code> runs with errors or warnings
[ ] <code>pkg unload foo</code> runs with errors or warnings
[ ] <code>pkg uninstall foo</code> runs with errors or warnings
 
[ ] Above steps were run on Octave and OS versions:
     *  ________
     *  ________
     *  ________
     *  ________
== Package files ==
[ ] tested with minimum Octave version list in DESCRIPTION
[ ] tested with minimum Octave version list in DESCRIPTION
[ ] reasonable dependencies listed in DESCRIPTION
[ ] reasonable dependencies listed in DESCRIPTION
[ ] ran generate_package_html
[ ] no makeinfo errors and warnings during HTML build
[ ] unpacked and spot-checked the generated HTML documentation
[ ] NEWS file makes sense, version and date match
[ ] NEWS file makes sense, version and date match
[ ] All functions are listed in INDEX
[ ] All functions are listed in INDEX
Line 39: Line 51:
TODO:  how does one check all functions are listed in INDEX?
TODO:  how does one check all functions are listed in INDEX?


TODO: add something about testing multiple OSes, or at least listing what OS we tested...
TODO: document how to run "all tests including those in src"  Someday this should be just "pkg test foo".


TODO: would be good to provide more specific instructions for when the package as a Maintainer Makefile?  But we don't usually put the Maintainer Makefile in the .tar.gz package to do?  (At least Doctest and Symbolic don't).
TODO: would be good to provide more specific instructions for when the package as a Maintainer Makefile?  But we don't usually put the Maintainer Makefile in the .tar.gz package to do?  (At least Doctest and Symbolic don't).
657

edits

Navigation menu