657
edits
m (Add Category:Octave Forge.) |
m (→Other info: check INDEX) |
||
(11 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
== Help reviewing Octave | == Help reviewing Octave Forge packages == | ||
We need help. Here is how: | We need help. Here is how: | ||
Line 19: | Line 19: | ||
<pre> | <pre> | ||
[ ] release candidate | == Repository == | ||
[ ] no compiler errors or | [ ] maintainer has specified a corresponding revision commit/changeset | ||
[ ] ran | [ ] 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> (use <code>oruntests</code> instead in Octave 6.0.0 or later) | |||
[ ] 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 in release candidate tarball == | |||
[ ] 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 | ||
[ ] 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 | ||
[ ] check licenses (<code>licensecheck -r</code> "plus some manual checks"). | |||
[ ] package files are readable/executable by all users (reasonably current maintainer Makefile should be doing this). | |||
[ ] version number in src/configure.ac (if present) matches DESCRIPTION and tarball name. | |||
[ ] any version numbers within the help or function body (e.g., banners) matches above. | |||
[ ] contains no hidden dot files, junk backup files, results of configure runs, etc (should be taken care of by maintainer Makefile). | |||
</pre> | </pre> | ||
Line 39: | Line 58: | ||
TODO: how does one check all functions are listed in INDEX? | TODO: how does one check all functions are listed in INDEX? | ||
: Carne Draug wrote a script to do this several years ago. It is in the [https://sourceforge.net/p/octave/code/HEAD/tree/trunk/octave-forge/admin/check_INDEX.pl old OF admin repository] [[User:KaKiLa|KaKiLa]] ([[User talk:KaKiLa|talk]]) 07:56, 20 November 2019 (PST) | |||
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). | ||
Line 60: | Line 81: | ||
[[Category:Octave Forge]] | [[Category:Octave Forge]] | ||
edits