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

オープン
#1,084 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
35/100
issue の種類
バグ
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
ruby
領域
documentation

調査の方向性

添付された reproducer から始め、ri --dump を使って生成された .ri ファイルを比較し、includes セクションに注目します。同じモジュールの include が 1 回または 2 回現れる理由を追跡し、その後、生成を繰り返しても影響を受ける .ri ファイル内の include リストが同一になることを確認します。

索引モデルが issue の本文から書いたものです。

説明

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

主要言語
Ruby
スター
928
フォーク
471
平均マージ
2日 4分
マージ済み PR(30日)
13

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ruby/rdoc のほかの issue

ruby/rdoc の issue をすべて見る

似ている issue

Ruby の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。