Hiro Asari created JRUBY-6379:
---------------------------------
Summary: rdoc, ri, rdoc-data and 'generate-ri-cache' ant task
Key: JRUBY-6379
URL: https://jira.codehaus.org/browse/JRUBY-6379
Project: JRuby
Issue Type: Task
Components: Documentation
Affects Versions: JRuby 1.6.5
Reporter: Hiro Asari
Assignee: Hiro Asari
Fix For: JRuby 1.7
We have a few problems concerning the {{rdoc}}, {{ri}} documentation.
# {{dist}} target installs {{rdoc}} and {{ri}} into bin. The scripts rely on
RubyGems to provide the respective gems, but we do not distribute them. Thus,
for the binary package we get:
{noformat}
[system] jruby-1.7.0.dev $ ./bin/jruby -S ri String
Gem::LoadError: Could not find rdoc (>= 0) amongst [rake-0.9.2.2]
to_specs at
/Users/asari/Downloads/jruby-1.7.0.dev/lib/ruby/shared/rubygems/dependency.rb:247
to_spec at
/Users/asari/Downloads/jruby-1.7.0.dev/lib/ruby/shared/rubygems/dependency.rb:256
gem at
/Users/asari/Downloads/jruby-1.7.0.dev/lib/ruby/shared/rubygems.rb:1202
(root) at /Users/asari/Downloads/jruby-1.7.0.dev/bin/ri:18
{noformat}
# When you install {{rdoc}}, you get the following message (in both 1.8 and 1.9
modes):
{noformat}
[system] jruby-1.7.0.dev $ ./bin/jruby --1.9 -S gem install rdoc
Fetching: json-1.6.5-java.gem (100%)
Fetching: rdoc-3.12.gem (100%)
Depending on your version of ruby, you may need to install ruby rdoc/ri data:
<= 1.8.6 : unsupported
= 1.8.7 : gem install rdoc-data; rdoc-data --install
= 1.9.1 : gem install rdoc-data; rdoc-data --install
>= 1.9.2 : nothing to do! Yay!
Successfully installed json-1.6.5-java
Successfully installed rdoc-3.12
2 gems installed
{noformat}
It is not clear what the user is supposed to do for JRuby. The answer is that
you need to install {{rdoc-data}}, and run the indicated command. If the
marginal storage is negligible, it might be best to distribute these gems
({{rdoc}} and {{rdoc-data}}) and run {{rdoc-data --install}} beforehand for the
{{dist}} target to avoid this potential confusion.
# Right now, {{generate-ri-cache}} ant task is commented out in {{build.xml}}.
This task fails because of the issues described above.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://jira.codehaus.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe from this list, please visit:
http://xircles.codehaus.org/manage_email
