[Bug 668820] Review Request: rubygem-rdoc - RDoc produces HTML and command-line documentation for Ruby projects

[bugzilla at redhat.com]

Please do not reply directly to this email. All additional
comments should be made in the comments box of this bug.


https://bugzilla.redhat.com/show_bug.cgi?id=668820

Vít Ondruch <vondruch at redhat.com> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
         AssignedTo|nobody at fedoraproject.org    |vondruch at redhat.com

--- Comment #19 from Vít Ondruch <vondruch at redhat.com> 2011-07-15 10:51:22 EDT ---
(In reply to comment #18)
> > * Documentation
> >   - Please do not disable documentation generation, since ruby forces
> >     installation of ruby-rdoc, therefore rdoc should be available prior the gem
> >     installation
> >   - Please consider to provide the documentation in -doc subpackage
> > 
> 
> Its seems there is an issue w/ parsing the rubygem-rdoc documentation w/
> ruby-rdoc. Whenever I re-enable the --rdoc, I get the following parse error:
> 
> Generating HTML...
> ERROR:  While generating documentation for rdoc-3.8
> ... MESSAGE:   Unhandled special: Special: type=17, text="<!-- -->"
> ... RDOC args: --op
> /home/mmorsi/rpmbuild/BUILD/rubygem-rdoc-3.8/usr/lib/ruby/gems/1.8/doc/rdoc-3.8/rdoc
> --main README.txt lib History.txt LICENSE.txt Manifest.txt README.txt RI.txt
> Rakefile --title rdoc-3.8 Documentation
> 
> 
> Grepping the source, it seems the offending line is in History.txt. Since from
> the rpm spec's perspective installing History.txt and parsing it w/ rdoc is an
> atomic operation, I've disabled the rdoc generation for the time being.
> 
> Added a documentation subpackage, and re-enabled ri generation.
> 
Interesting, it seems to me like bug in RubyGems. I have replaced the gem
install with following command:

GEM_HOME="%{_builddir}/%{name}-%{version}%{gemdir}" gem install --local \
            -V --force %{SOURCE0}

Which works without any issues and the result should be identical to use of
"--install-dir" command line flag.


> (In reply to comment #8)
> > P.S. It is interesting that in Ruby, there were left bundled RDoc, which is
> > against Fedora policy anyway. Of course it is not the only one library bundled
> > in Ruby.
> 
> True but you have to recall that rdoc was originally part of the Ruby package
> then got forked off into the gem. At some point it wouldn't surprise me if it
> was dropped from ruby internally all together (though this would make it harder
> for rdoc support in rubygems and what not).

I didn't know that the RDoc was forked out of Ruby. Interesting. There was
discussion that since RubyGems are integrated into R1.9, some parts of stdlib
should be moved away from core to gems, but unfortunately, it went in nothing
:/

So I have some more nits:

* There should be used %global instead of %define
  -
http://fedoraproject.org/wiki/Packaging:Guidelines#.25global_preferred_over_.25define

* Some files are listed twice:
  warning: File listed twice: /usr/lib/ruby/gems/1.8/gems/rdoc-3.8/History.txt
  warning: File listed twice: /usr/lib/ruby/gems/1.8/gems/rdoc-3.8/LICENSE.txt
  warning: File listed twice: /usr/lib/ruby/gems/1.8/gems/rdoc-3.8/Manifest.txt
  warning: File listed twice: /usr/lib/ruby/gems/1.8/gems/rdoc-3.8/README.txt
  warning: File listed twice: /usr/lib/ruby/gems/1.8/gems/rdoc-3.8/RI.txt
  warning: File listed twice: /usr/lib/ruby/gems/1.8/gems/rdoc-3.8/Rakefile
  - Except the LICENSE.txt, I would move them in to -doc subpackage.
  - May be you just forgot the %dir directive in front of 
    "%{gemdir}/gems/%{gemname}-%{version}/" line? Btw this could be replaced
    shorter %{geminstdir} macro

* rpmlint complains about "macro-in-comment"
  - Please remove the macros from comments.
  - Also, the "--bindir .%{_bindir}" flag for gem installation might help
    to avoid later messing with the bin directory.

I have no other objections at this point. If you fix these issues and nobody
else has objections, I will approve this package at Monday.

-- 
Configure bugmail: https://bugzilla.redhat.com/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are on the CC list for the bug.