Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Installation] Sinatra gem install hangs at ri documentation #1578

Closed
rubyFeedback opened this issue Nov 14, 2019 · 4 comments
Closed

[Installation] Sinatra gem install hangs at ri documentation #1578

rubyFeedback opened this issue Nov 14, 2019 · 4 comments

Comments

@rubyFeedback
Copy link

Whenever I try to install the sinatra gem, the first install hangs during:

"Installing ri documentation for sinatra-2.0.7"

I manually interrupt it, then do it again, and then it works.

I have no idea what causes it, but all the other gems and their ri
documentation do not have this issue.

I believe that there must be something special for sinatra documentation
done that causes this behaviour since I do not see it at any other gem.

It may be difficult to find out, but I am just reporting here to let you guys
know anyway.

@horaciob
Copy link
Contributor

horaciob commented Nov 15, 2019

Hi there looks like *.md files are the problem

Now Sinatra it's doing this:

hbranciforte@bcnl-hbranciforte:ruby/sinatra ‹handle_null_byte_when_serving_static_files*›$ rdoc  --line-numbers --inline-source --title Sinatra --main README.rdoc --encoding=UTF-8
option --inline-source is deprecated: source code is now always inlined
Parsing sources...
100% [255/255]  test/yajl_test.rb

Generating Darkfish format into /Users/hbranciforte/labs/ruby/sinatra/doc...

  Files:      255

  Classes:    120 ( 89 undocumented)
  Modules:     61 ( 36 undocumented)
  Constants:   41 ( 40 undocumented)
  Attributes:  33 ( 29 undocumented)
  Methods:    718 (576 undocumented)

  Total:      973 (770 undocumented)
   20.86% documented

  Elapsed: 297.0s

and it takes 5 minutes to generate

if you try this

rdoc  --line-numbers --inline-source --title Sinatra --main README.rdoc --encoding=UTF-8 --exclude=.*\.md

Excluding *.md files it will takes only 3 seconds.

I will try to figure out how to speedup, but I would ask if we need to add or we can exclude them on the gemspec

@ty-shaikh
Copy link

Temporary fix could be to use: gem install sinatra --no-ri --no-rdoc or gem install sinatra --no-document if Ruby is newer than version 2.5

@aaronelliotross
Copy link

+1 this bit me too

@epergo
Copy link
Member

epergo commented Nov 23, 2021

This was already fixed in #1671 however new version of Sinatra including the change is yet to be released so you will only notice the improvement if you use master.

@jkowens jkowens closed this as completed Feb 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants