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.

Sign up for GitHub

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

Jump to bottom

Drop rdoc's version requirement #704

Merged
merged 1 commit into from
Aug 31, 2023
Merged

Drop rdoc's version requirement #704

merged 1 commit into from
Aug 31, 2023

Conversation

st0012
Copy link
Member

@st0012 st0012 commented Aug 31, 2023

  1. The newer versions of rdoc requires pysch 4.0+, which could break apps using Ruby 3.0 or 2.7. Minor Version of IRB introducing undisclosed psych breaking changes  #703 has more detailed explanation on this.
  2. We actually don't use any version-specific rdoc APIs. So having a version requirement is not necessary atm.

Closes #703

@st0012
Drop rdoc's version requirement
49139b7 
1. The newer versions of rdoc requires pysch 4.0+, which could break apps
   using Ruby 3.0 or 2.7. #703 has more detailed explanation on this.
2. We actually don't use any version-specific rdoc APIs. So having a version
    requirement is not necessary atm.
@st0012 st0012 added the bug Something isn't working label Aug 31, 2023
@st0012 st0012 requested a review from a team August 31, 2023 15:06
@st0012 st0012 self-assigned this Aug 31, 2023
@tompng tompng merged commit 3e6ba78 into master Aug 31, 2023
47 checks passed
@tompng tompng deleted the loosen-rdoc-version branch August 31, 2023 15:44
matzbot pushed a commit to ruby/ruby that referenced this pull request Aug 31, 2023
@st0012 @matzbot
[ruby/irb] Drop rdoc's version requirement
3678734 
(ruby/irb#704)

1. The newer versions of rdoc requires pysch 4.0+, which could break apps
   using Ruby 3.0 or 2.7. #703 has more detailed explanation on this.
2. We actually don't use any version-specific rdoc APIs. So having a version
    requirement is not necessary atm.

ruby/irb@3e6ba78c42
@tnir
Copy link

tnir commented Sep 7, 2023

Thanks! 💞

@st0012 st0012 mentioned this pull request Sep 8, 2023
Merged
alpaca-tc added a commit to alpaca-tc/irb that referenced this pull request Mar 8, 2024
@alpaca-tc
rdoc version lock is required
aebf608 
Some features of irb do not work properly when using the old rdoc.
I have compared several major versions and found that it works as intended from 4.0.0.

This problem occurs when there is a Gemfile.lock is installed with the old rdoc.
I don't know why this Gemfile.lock installs an older rdoc than the ruby bundled rdoc,
but specifying the version in the gemspec will at least prevent the problem.

NOTE: ruby#704 problem does not occur with this change.

The following is test code.

```
 ### Usage: ruby __FILE__.rb
 # # input RDoc and Tab
 # >> RDoc<Tab>
 #
 ### Expect: Display document of RDoc
 ### Actual: <internal:marshal>:34:in `load': instance of RDoc::Constant needs to have method `marshal_load' (TypeError)
require "bundler/inline"

gemfile(true) do
  source "https://rubygems.org"

  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
  gem 'irb'
  # gem 'rdoc', '~> 4.0.0'
  gem 'rdoc', '~> 3.12.0'
end

require 'rdoc'
require 'irb'

IRB.start
```
@alpaca-tc alpaca-tc mentioned this pull request Mar 8, 2024
Merged
st0012 pushed a commit that referenced this pull request Mar 8, 2024
@alpaca-tc
rdoc version lock is required (#897)
1a1fbba 
Some features of irb do not work properly when using the old rdoc.
I have compared several major versions and found that it works as intended from 4.0.0.

This problem occurs when there is a Gemfile.lock is installed with the old rdoc.
I don't know why this Gemfile.lock installs an older rdoc than the ruby bundled rdoc,
but specifying the version in the gemspec will at least prevent the problem.

NOTE: #704 problem does not occur with this change.

The following is test code.

```
 ### Usage: ruby __FILE__.rb
 # # input RDoc and Tab
 # >> RDoc<Tab>
 #
 ### Expect: Display document of RDoc
 ### Actual: <internal:marshal>:34:in `load': instance of RDoc::Constant needs to have method `marshal_load' (TypeError)
require "bundler/inline"

gemfile(true) do
  source "https://rubygems.org"

  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
  gem 'irb'
  # gem 'rdoc', '~> 4.0.0'
  gem 'rdoc', '~> 3.12.0'
end

require 'rdoc'
require 'irb'

IRB.start
```
matzbot pushed a commit to ruby/ruby that referenced this pull request Mar 8, 2024
@alpaca-tc @matzbot
[ruby/irb] rdoc version lock is required
e8f796e 
(ruby/irb#897)

Some features of irb do not work properly when using the old rdoc.
I have compared several major versions and found that it works as intended from 4.0.0.

This problem occurs when there is a Gemfile.lock is installed with the old rdoc.
I don't know why this Gemfile.lock installs an older rdoc than the ruby bundled rdoc,
but specifying the version in the gemspec will at least prevent the problem.

NOTE: ruby/irb#704 problem does not occur with this change.

The following is test code.

```
 ### Usage: ruby __FILE__.rb
 # # input RDoc and Tab
 # >> RDoc<Tab>
 #
 ### Expect: Display document of RDoc
 ### Actual: <internal:marshal>:34:in `load': instance of RDoc::Constant needs to have method `marshal_load' (TypeError)
require "bundler/inline"

gemfile(true) do
  source "https://rubygems.org"

  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
  gem 'irb'
  # gem 'rdoc', '~> 4.0.0'
  gem 'rdoc', '~> 3.12.0'
end

require 'rdoc'
require 'irb'

IRB.start
```

ruby/irb@1a1fbba020
artur-intech pushed a commit to artur-intech/ruby that referenced this pull request Apr 26, 2024
@alpaca-tc @artur-intech
[ruby/irb] rdoc version lock is required
2408c70 
(ruby/irb#897)

Some features of irb do not work properly when using the old rdoc.
I have compared several major versions and found that it works as intended from 4.0.0.

This problem occurs when there is a Gemfile.lock is installed with the old rdoc.
I don't know why this Gemfile.lock installs an older rdoc than the ruby bundled rdoc,
but specifying the version in the gemspec will at least prevent the problem.

NOTE: ruby/irb#704 problem does not occur with this change.

The following is test code.

```
 ### Usage: ruby __FILE__.rb
 # # input RDoc and Tab
 # >> RDoc<Tab>
 #
 ### Expect: Display document of RDoc
 ### Actual: <internal:marshal>:34:in `load': instance of RDoc::Constant needs to have method `marshal_load' (TypeError)
require "bundler/inline"

gemfile(true) do
  source "https://rubygems.org"

  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
  gem 'irb'
  # gem 'rdoc', '~> 4.0.0'
  gem 'rdoc', '~> 3.12.0'
end

require 'rdoc'
require 'irb'

IRB.start
```

ruby/irb@1a1fbba020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tompng tompng tompng approved these changes

Assignees

@st0012 st0012

Labels
bug Something isn't working
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Minor Version of IRB introducing undisclosed psych breaking changes
3 participants
@st0012 @tnir @tompng