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

Aberta
  • Algo errado?
#1,084 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
35/100
Tipo de issue
Bug
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
ruby
Domínio
documentation

Direção de pesquisa

Comece com o reproducer anexado e compare os arquivos .ri gerados usando ri --dump, concentrando-se na seção includes. Rastreie por que o mesmo include de módulo aparece uma ou duas vezes e, em seguida, verifique se gerações repetidas produzem listas de includes idênticas nos arquivos .ri afetados.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
Ruby
Estrelas
928
Forks
471
Merge médio
2d 4min
PRs com merge (30d)
13

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de ruby/rdoc

Todas as issues de ruby/rdoc

Issues semelhantes

Mais issues de Ruby

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.