driver: suggest the closest warning for an unknown -W name

Aberta
  • Algo errado?
#189 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
72/100
Tipo de issue
Funcionalidade
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
c
Domínio
cli, compilers

Direção de pesquisa

Read the unknown warning handling in src/driver/main.c around lines 7625 and 7729, then inspect warning enumeration in src/driver/diag.c and edit_distance() in src/sema/sema.c. Start with tests/golden/driver-wp.sh to see the current output. Add close and distant typo cases; done means the three specified misspellings suggest unused-variable, distant names get no suggestion, and the tests pass.

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

Descrição

enhancement good first issue

Context. A misspelled warning is reported, but EmbCC does not say what was probably meant:

$ ./embcc -Wunused-vairable -c t.c
embcc: warning: -Wunused-vairable is not a warning EmbCC has, so it turns nothing on (--help-warnings lists them)

It should add did you mean -Wunused-variable?.

Where.

  • src/driver/main.c, around line 7729, where a -W or -Wno- name is looked up. Near line 7625 there is a second message of the same kind, for -Werror=NAME ("names no warning EmbCC has"); give it the suggestion too.
  • src/driver/diag.c, line 1068: diag_warning_count() and diag_warning_name(i) list every warning name.
  • src/sema/sema.c, line 2108: edit_distance(). It is static; share it with the driver instead of copying it. Another good first issue moves the same function, for --target=; whichever lands first, the other reuses it.
  • Tests: tests/golden/driver-wp.sh checks the current message.

Steps.

  1. For an unknown name, find the closest diag_warning_name(i). Suggest it only if it is within max(2, len / 3) edits.
  2. Add the suggestion to the warning, keeping the existing wording, so scripts that grep for it still match.
  3. Add cases to the test: one with a close typo, and one with a name far from every warning.

Done when -Wunused-vairable, -Wno-unused-vairable and -Werror=unused-vairable all suggest unused-variable, a far-off name suggests nothing, and the tests pass.

Before you start: the contributor's guide has the rules. A new test counts only after it has failed against the code before your change, and a commit subject reads area: summary. Questions are welcome in the comments or in Discussions.

Linguagem predominante
C
Estrelas
1
Forks
2
Merge médio
20h 55min
PRs com merge (30d)
73

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 EmbLinkOs/EmbCC

Todas as issues de EmbLinkOs/EmbCC

Issues semelhantes

Mais issues de C

Receba novas issues na sua caixa de entrada

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