Skip to content

Silence doc warnings during 'gem install net-http'#194

Closed
0x1eef wants to merge 1 commit intoruby:masterfrom
0x1eef:docs/patch
Closed

Silence doc warnings during 'gem install net-http'#194
0x1eef wants to merge 1 commit intoruby:masterfrom
0x1eef:docs/patch

Conversation

@0x1eef
Copy link
Copy Markdown
Contributor

@0x1eef 0x1eef commented Nov 21, 2024

Fix #193

Reproduction steps:
gem build net-http.gemspec
mv net-http-0.5.0.gem ${HOME}
cd ${HOME}
gem install net-http-0.5.0.gem

@0x1eef
Silence doc warnings during 'gem install net-http'
58e13db 
Fix #193

Reproduction steps:
gem build net-http.gemspec
mv net-http-0.5.0.gem ${HOME}
cd ${HOME}
gem install net-http-0.5.0.gem
@0x1eef
Copy link
Copy Markdown
Contributor Author

0x1eef commented Jan 7, 2025

@hsbt Hello! Is this pull request useful or no ? This repository has 15 pull requests, some have no comments, and some are years old. I'd rather not maintain such a pull request, and if there's no intention of merging it, I'd rather close. I don't mean to be rude with this message.

deivid-rodriguez
deivid-rodriguez reviewed Jan 7, 2025
View reviewed changes
Copy link
Copy Markdown

@deivid-rodriguez deivid-rodriguez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can reproduce this with gem build && gem install net-http-0.6.0.gem --document and this PR fixes it 👍.

@deivid-rodriguez
Copy link
Copy Markdown

deivid-rodriguez commented Jan 7, 2025

@hsbt I'm not an rdoc expert but I think this PR is correct and can be merged 👍.

@hsbt
Copy link
Copy Markdown
Member

hsbt commented Jan 8, 2025

I'm not sure that works on ruby/ruby repository. Please wait my confirmation that or verify with ruby/ruby repo.

@rhenium
Copy link
Copy Markdown
Member

rhenium commented Jan 8, 2025 •
edited
Loading

I believe this is a regression in RDoc. A relative path from the root directory works with Ruby 3.1.6 and RubyGems/RDoc bundled with it, but not with later versions.

@rhenium rhenium mentioned this pull request Jan 8, 2025
Merged
@rhenium
Copy link
Copy Markdown
Member

rhenium commented Jan 8, 2025

I submitted ruby/rdoc#1274 to include the gem root directory in the search paths again.

I think an even easier workaround for net-http is to explicitly specify the path in rdoc_options in the gemspec.

st0012 pushed a commit to ruby/rdoc that referenced this pull request Jan 8, 2025
@rhenium
Finalize RDoc::Options before calling RDoc::RDoc#parse_files (#1274)
d62da8c 
Commit 6cf6e16, which went to v6.5.0, changed `RDoc::Options#parse`
to not call `#finish` in it. While the commit adjusted other call sites,
it missed `lib/rdoc/rubygems_hook.rb`.

`RDoc::Options#finish` prepares the include paths for `:include:`
directives. This has to be done before starting to parse sources.

I think this should fix ruby/net-http#193 +
ruby/net-http#194.
matzbot pushed a commit to ruby/ruby that referenced this pull request Jan 8, 2025
@rhenium @matzbot
[ruby/rdoc] Finalize RDoc::Options before calling
e728170 
RDoc::RDoc#parse_files
(ruby/rdoc#1274)

Commit ruby/rdoc@6cf6e1647b97, which went to v6.5.0, changed `RDoc::Options#parse`
to not call `#finish` in it. While the commit adjusted other call sites,
it missed `lib/rdoc/rubygems_hook.rb`.

`RDoc::Options#finish` prepares the include paths for `:include:`
directives. This has to be done before starting to parse sources.

I think this should fix ruby/net-http#193 +
ruby/net-http#194.

ruby/rdoc@d62da8ca09
@0x1eef
Copy link
Copy Markdown
Contributor Author

0x1eef commented Jan 8, 2025

Thanks! Closing.

@0x1eef 0x1eef closed this Jan 8, 2025
@0x1eef 0x1eef deleted the docs/patch branch January 8, 2025 17:27
@0x1eef
Copy link
Copy Markdown
Contributor Author

0x1eef commented Jan 8, 2025 •
edited
Loading

I think an even easier workaround for net-http is to explicitly specify the path in rdoc_options in the gemspec.

How would that work ? With --root - right ? The path varies based on the computer. For example, if I build on my machine, the path would not be the same on someone else's machine. Maybe it does not matter anymore, since eventually your fix will make this not matter anymore.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@deivid-rodriguez deivid-rodriguez deivid-rodriguez left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

'gem install net-http' generates warnings

4 participants

@0x1eef @deivid-rodriguez @hsbt @rhenium