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

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

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

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
72/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
c
領域
cli, compilers

調査の方向性

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.

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

説明

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.

主要言語
C
スター
1
フォーク
2
平均マージ
20時間 55分
マージ済み PR(30日)
73

環境構築

はじめの一歩

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

EmbLinkOs/EmbCC のほかの issue

EmbLinkOs/EmbCC の issue をすべて見る

似ている issue

C の issue をもっと見る

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

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