Red Hat Bugzilla – Bug 455164
Review-Request: NaturalDocs - Documentation generator for multiple programming languages
Last modified: 2008-12-28 16:42:16 EST
Natural Docs is an open-source documentation generator for multiple
programming languages. You document your code in a natural syntax that
reads like plain English. Natural Docs then scans your code and builds
high-quality HTML documentation from it.
I'll go ahead and review this... look for a full review soon.
OK - Package meets naming and packaging guidelines
OK - Spec file matches base package name.
OK - Spec has consistant macro usage.
OK - Meets Packaging Guidelines.
OK - License (GPLv2+)
OK - License field in spec matches
OK - License file included in package
OK - Spec in American English
OK - Spec is legible.
OK - Sources match upstream md5sum:
OK - BuildRequires correct
OK - Package has %defattr and permissions on files is good.
OK - Package has a correct %clean section.
OK - Package has correct buildroot
OK - Package is code or permissible content.
OK - Packages %doc files don't affect runtime.
OK - Package has rm -rf RPM_BUILD_ROOT at top of %install
OK - Package compiles and builds on at least one arch.
OK - Package has no duplicate files in %files.
OK - Package doesn't own any directories other packages own.
OK - Package owns all the directories it creates.
OK - No rpmlint output.
OK - final provides and requires are sane.
OK - Should build in mock.
OK - Should build on all supported archs
OK - Should have dist tag
OK - Should package latest version
1. It looks pretty clear that the package is GPLv2+, but some of the files just say
"the GPL". You might ping upstream about that and suggest they mention that it's v2 or
2. Might use 'install -p' to preserve the timestamp on the script.
3. SourceUrl is not right... looks like they use naturaldocs instead of NaturalDocs
None of those are blockers, so this package is APPROVED, provided you
fix those up on import.
> 1. It looks pretty clear that the package is GPLv2+, but some of the files just
> "the GPL". You might ping upstream about that and suggest they mention that
> it's v2 or
> 2. Might use 'install -p' to preserve the timestamp on the script.
> 3. SourceUrl is not right... looks like they use naturaldocs instead of
> in there.
> None of those are blockers, so this package is APPROVED, provided you
> fix those up on import.
All three are reasonable and I will surely address them. Thanks for the review!
New Package CVS Request
Package Name: NaturalDocs
Short Description: Documentation generator for multiple programming languages
Branches: F-9 F-10 EL-5
Imported and built. Thanks Kevin!