rdoc non-determinism: module includes can be added once or twice to generated .ri

Open
#1,084 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
ruby
Domain
documentation

Research direction

Start with the attached reproducer and compare the generated .ri files using ri --dump, focusing on the includes section. Trace why the same module include appears once or twice, then verify that repeated generation produces identical include lists in the affected .ri files.

Written by the indexing model from the issue text.

Description

bug

We're observing a sporadically occurring non-determinism in generated .ri files:

[ak@localhost ruby-repro]$ ri --dump=./oe-reproducible-20211214-gj4vndgo/packages-excluded/reproducibleA/tmp/deploy/rpm/core2_64/usr/share/ri/3.0.0/system/Gem/DefaultUserInteraction/cdesc-DefaultUserInteraction.ri
[module Gem::DefaultUserInteraction: 
  includes:
  #<RDoc::Include:0x384 Gem::DefaultUserInteraction.rdoc::include Gem::Text>
  
  constants:

....


[ak@localhost ruby-repro]$ ri --dump=./oe-reproducible-20211214-gj4vndgo/packages-excluded/reproducibleB/tmp/deploy/rpm/core2_64/usr/share/ri/3.0.0/system/Gem/DefaultUserInteraction/cdesc-DefaultUserInteraction.ri
[module Gem::DefaultUserInteraction: 
  includes:
  #<RDoc::Include:0x384 Gem::DefaultUserInteraction.rdoc::include Gem::Text>,
  #<RDoc::Include:0x398 Gem::DefaultUserInteraction.rdoc::include Gem::Text>
  
  constants:

This occurs in random .ri files, but the pattern seems same: the difference is always in the includes, and how many times a specific one gets listed.
issue-18456-attachments.zip

Dominant language
Ruby
Stars
930
Forks
472
Avg merge
2d 8h
Merged PRs (30d)
12

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ruby/rdoc

All issues in ruby/rdoc

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.