Red Hat Bugzilla – Bug 468155
Review Request: robodoc - Extract documentation from source code
Last modified: 2008-12-06 23:28:30 EST
Spec URL: http://monnerat.fedorapeople.org/robodoc.spec
SRPM URL: http://monnerat.fedorapeople.org/robodoc-4.99.36-1.fc8.src.rpm
ROBODoc is a documentation tool (based on the AutoDocs program written
a long time ago by Commodore). It extracts specially formated comment
headers from the source file and puts them in a separate file. ROBODoc
thus allows you to include the program documentation in the source
code and avoid having to maintain two separate documents.
ROBODoc can format the documentation in HTML, ASCII, AmigaGuide,
LaTeX, or RTF format. It is even possible to include parts of the
source code with function names that point their the documentation. It
also can create index tables for all your variables, classes,
The best feature of ROBODoc is that it works with many languages:
Assembler, C, Perl, LISP, Occam, Tcl/Tk, Pascal, Fortran, shell
scripts, and COBOL, basically any language that supports
rpmlint is silent.
koji scratch build: http://koji.fedoraproject.org/koji/taskinfo?taskID=897383
OK source files match upstream:
OK package meets naming and versioning guidelines.
OK specfile is properly named, is cleanly written and uses macros consistently.
OK summary is OK.
OK description is OK.
OK dist tag is present.
OK build root is OK.
OK license field matches the actual license.
OK license is open source-compatible.
OK license text included in package.
OK BuildRequires are proper.
OK compiler flags are appropriate.
OK %clean is present.
OK package builds in mock (rawhide, x86_64).
OK package installs properly.
OK debuginfo package looks complete.
OK rpmlint is silent.
OK final provides and requires are sane:
robodoc = 4.99.36-1.fc10
robodoc(x86-64) = 4.99.36-1.fc10
OK %check is not present; no test suite upstream. I was able to run program from the command line and generate a doc file.
OK no shared libraries are added to the regular linker search paths.
OK owns the directories it creates.
OK doesn't own any directories it shouldn't.
OK no duplicates in %files.
OK file permissions are appropriate.
OK code, not content.
OK documentation is small, so no -doc subpackage is necessary.
OK %docs are not necessary for the proper functioning of the package.
OK no headers.
OK no pkgconfig files.
OK no static libraries.
OK no libtool .la files.
Please consider preserving the timestamp of the modified file (ChangeLog).
A simple call to 'touch -r' will do.
Many thanks for the review, Lucian. Will apply your suggestion.
New Package CVS Request
Package Name: robodoc
Short Description: Extract documentation from source code
Branches: F-9 F-10
Consider also using the standard sourceforge url in Source:
robodoc-4.99.36-2.fc10 has been submitted as an update for Fedora 10.
robodoc-4.99.36-2.fc9 has been submitted as an update for Fedora 9.
Thanks for CVS Kevin.
Source URL was a typo :-( Applied your suggestion. Thanks.
robodoc-4.99.36-2.fc9 has been pushed to the Fedora 9 stable repository. If problems still persist, please make note of it in this bug report.
robodoc-4.99.36-2.fc10 has been pushed to the Fedora 10 stable repository. If problems still persist, please make note of it in this bug report.