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

未关闭
#1,084 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
需要澄清
活跃度
停滞
技术栈
ruby
领域
documentation

调研方向

从随附的 reproducer 开始,使用 ri --dump 比较生成的 .ri 文件,重点关注 includes 部分。追踪同一个模块 include 为什么会出现一次或两次,然后验证重复生成是否会在受影响的 .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 分钟
30 天内合并 PR
13

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

ruby/rdoc 的其他 Issue

查看 ruby/rdoc 的全部 Issue

相似的 Issue

更多 Ruby Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。