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

Dependency rdoc missing for installation of gollum gem #1809

Closed
salexan2001 opened this issue Mar 11, 2022 · 5 comments
Closed

Dependency rdoc missing for installation of gollum gem #1809

salexan2001 opened this issue Mar 11, 2022 · 5 comments
Assignees

Comments

@salexan2001
Copy link

Describe the bug

  • I installed gollum using "gem install gollum".
  • Afterwards I started gollum and received the following error message:
$ gollum
<internal:/usr/lib/ruby/3.0.0/rubygems/core_ext/kernel_require.rb>:85:in `require': cannot load such file -- rdoc (LoadError)
	from <internal:/usr/lib/ruby/3.0.0/rubygems/core_ext/kernel_require.rb>:85:in `require'

Installing rdoc using: "gem install rdoc" fixed the problem and let gollum start without errors.

To Reproduce
Already described in bug description.

Expected behavior
I expected "gem install gollum" to fetch all dependencies, including rdoc. I checked the issue tracker and README.md for a note on manual installation of rdoc, but it seems like the dependency is just missing.

Environment Info

$ gollum --versions
Gollum 5.2.3
Running on: x86_64-linux with Ruby version 3.0.3
Using:
rugged 1.1.1
gollum-rugged_adapter 1.1.2
gollum-lib 5.1.3
Markdown rendering gem: kramdown
Other renderering gems:
none

I am running an up-to-date archlinux as OS.

@benjaminwil
Copy link
Member

Thanks for reporting. I don't think that rdoc should be a dependency, so I will investigate why that might be and then resolve the issue.

@benjaminwil benjaminwil self-assigned this Apr 5, 2022
@dometto
Copy link
Member

dometto commented May 2, 2022

Problems with rdoc on arch have been reported before: #1342

My hunch is arch just does not require the ruby-rdoc package as part of a standard ruby installation, whereas most on most other environments rdoc is at least de facto treated and installed as part of the ruby standard lib. I wonder if it hurts just adding rdoc to the Gemfile.

@benjaminwil
Copy link
Member

Ah I see. No, that would not hurt. Perhaps I will add it in the gemspec along with a comment about why we're explicitly adding it as a dependency.

benjaminwil added a commit that referenced this issue May 5, 2022
We've had some reports (#1342, #1809) of `rdoc` not being installed
in some environments, causing Gollum to error in unpleasant ways.

This isn't an issue that's unique to Gollum, and I don't think `rdoc`
should actually be a hard dependency of this project.  But since we can
side-step the issue by requiring `rdoc`, something that most users who
install Gollum via RubyGems would already have installed, I don't think
this is a horrible solution.
benjaminwil added a commit that referenced this issue May 5, 2022
We've had some reports (#1342, #1809) of `rdoc` not being installed
in some environments, causing Gollum to error in unpleasant ways.

This isn't an issue that's unique to Gollum, and I don't think `rdoc`
should actually be a hard dependency of this project.  But since we can
side-step the issue by requiring `rdoc`, something that most users who
install Gollum via RubyGems would already have installed, I don't think
this is a horrible solution.
@benjaminwil
Copy link
Member

benjaminwil commented May 5, 2022

This issue will be resolved in the next released version of the gem.

@dometto
Copy link
Member

dometto commented May 26, 2022

Released in v5.3.0.

@dometto dometto closed this as completed May 26, 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

3 participants