[Rubygems-developers] [ rubygems-Bugs-28935 ] Failing rdoc generation doesnt fail the installation since 1.5

noreply at rubyforge.org noreply at rubyforge.org
Tue Mar 1 17:52:47 EST 2011


Bugs item #28935, was opened at 2011-02-17 11:16
You can respond by visiting: 
http://rubyforge.org/tracker/?func=detail&atid=575&aid=28935&group_id=126

Category: `gem install` command
Group: None
>Status: Open
Resolution: Accepted
Priority: 3
Submitted By: Marcus Rueckert (darix)
>Assigned to: Eric Hodel (drbrain)
Summary: Failing rdoc generation doesnt fail the installation since 1.5

Initial Comment:
it seems gem install returns 0, even though the rdoc generation failed. in 1.3.7 it still returned the a non zero return code. as shown here http://bit.ly/f8vfi7 e.g.

important part:
[[[
1 gem installed
Installing ri documentation for ci_reporter-1.6.4...
rdoc --ri --op /var/tmp/rubygem-ci_reporter-1.6.4-build/usr/lib64/ruby/gems/1.8/doc/ci_reporter-1.6.4/ri --main README.txt -SHN -f darkfish --quiet lib History.txt Manifest.txt README.txt LICENSE.txt --title ci_reporter-1.6.4 Documentation
Installing RDoc documentation for ci_reporter-1.6.4...
rdoc --op /var/tmp/rubygem-ci_reporter-1.6.4-build/usr/lib64/ruby/gems/1.8/doc/ci_reporter-1.6.4/rdoc --main README.txt -SHN -f darkfish --quiet lib History.txt Manifest.txt README.txt LICENSE.txt --title ci_reporter-1.6.4 Doc
Invalid output formatter

For help on options, try 'rdoc --help'

ERROR:  While generating documentation for ci_reporter-1.6.4
... MESSAGE:   exit
... RDOC args: --op /var/tmp/rubygem-ci_reporter-1.6.4-build/usr/lib64/ruby/gems/1.8/doc/ci_reporter-1.6.4/rdoc --main README.txt -SHN -f darkfish --quiet lib History.txt Manifest.txt README.txt LICENSE.txt --title ci_reporter-1.6.4 Documentation
(continuing with the rest of the installation)
]]]

the problem in the build was that the ruby version didnt ship the darkfish template, but the gemspec specifies 's.rdoc_options = ["--main", "README.txt", "-SHN", "-f", "darkfish"]'.



----------------------------------------------------------------------

>Comment By: Eric Hodel (drbrain)
Date: 2011-03-01 14:52

Message:
I could not reproduce the behavior of --quiet suppressing the exit code with ci_reporter and RDoc 1.0.1, 2.3.0, 2.5.11 or trunk rdoc.

I reverted the commit in RubyGems that add --quiet as it has no effect on the exit code.

Reopened this bug.

----------------------------------------------------------------------

Comment By: Ryan Davis (zenspider)
Date: 2011-02-23 16:49

Message:
DocManager was passing in --quiet which does a lot more than just "don't output stuff". I've removed that and forced the exit to be 1 if it borks.

----------------------------------------------------------------------

You can respond by visiting: 
http://rubyforge.org/tracker/?func=detail&atid=575&aid=28935&group_id=126


More information about the Rubygems-developers mailing list