Skip to content

Commit

Permalink
doc: document -Wuseless-action
Browse files Browse the repository at this point in the history
* doc/bison.texi, src/getargs.c, NEWS: here.
  • Loading branch information
akimd committed Jul 7, 2020
1 parent f7022e0 commit 7eca845
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 0 deletions.
28 changes: 28 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,34 @@ GNU Bison NEWS

* Noteworthy changes in release ?.? (????-??-??) [?]

** New features

*** New warning flag: -Wuseless-action

A new warning category is introduced: 'useless-action', which reports
useless explicit actions. For instance on the following grammar:

%type <int> "number" expr term
%%
expr: expr "+" term { $$ = $1 + $3; }
| term { $$ = $1; }
term: "(" expr ")" { $$ = $2; }
| "number" { $$ = $1; }

bison diagnoses:

$ bison -Wuseless-action foo.y
foo.y:4.21-32: warning: useless explicit action [-Wuseless-action]
4 | | term { $$ = $1; }
| ^~~~~~~~~~~~
foo.y:6.21-32: warning: useless explicit action [-Wuseless-action]
6 | | "number" { $$ = $1; }
| ^~~~~~~~~~~~
foo.y: warning: fix-its can be applied. Rerun with option '--update'. [-Wother]

Running 'bison -Wuseless-action --update foo.y' would remove these
actions.


* Noteworthy changes in release 3.6.90 (2020-07-04) [beta]

Expand Down
35 changes: 35 additions & 0 deletions doc/bison.texi
Original file line number Diff line number Diff line change
Expand Up @@ -11360,6 +11360,41 @@ One would get the exact same parser with the following directives instead:
@end group
@end example

@item useless-action
Useless explicit actions (@samp{@{ $$ = $1; @}}) are reported. For instance
on the following grammar:

@example
@group
$ @kbd{cat foo.y}
%type <int> "number" expr term
%%
expr: expr "+" term @{ $$ = $1 + $3; @}
| term @{ $$ = $1; @}
term: "(" expr ")" @{ $$ = $2; @}
| "number" @{ $$ = $1; @}
@end group
@end example

@noindent
@command{bison} diagnoses:

@example
$ @kbd{bison -Wuseless-action foo.y}
foo.y:4.21-32: warning: useless explicit action [-Wuseless-action]
| term @{ $$ = $1; @}
^~~~~~~~~~~~
foo.y:6.21-32: warning: useless explicit action [-Wuseless-action]
| "number" @{ $$ = $1; @}
^~~~~~~~~~~~
foo.y: warning: fix-its can be applied. Rerun with option '--update'. [-Wother]
@end example

Running @kbd{bison -Wuseless-action --update foo.y} would remove these actions.

Actions with named references (e.g., @samp{@{ $expr = $term; @}}) are not
reported. To disable the warning locally, write @samp{@{ $$ = ($1); @}}.

@item yacc
Incompatibilities with POSIX Yacc.

Expand Down
1 change: 1 addition & 0 deletions src/complain.c
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ static const argmatch_warning_arg argmatch_warning_args[] =
{ "none", Wnone },
{ "other", Wother },
{ "precedence", Wprecedence },
{ "useless-action", Wuseless_action },
{ "yacc", Wyacc },
{ NULL, Wnone }
};
Expand Down

0 comments on commit 7eca845

Please sign in to comment.