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 May 26, 2019
1 parent 844824a commit 5a47e23
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 0 deletions.
24 changes: 24 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,30 @@ GNU Bison NEWS

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

*** Diagnostics for stylistic issues: -Wuseless-action

A new warning category is introduced: 'style'. Currently it 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]
| 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]

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

* Noteworthy changes in release 3.4.1 (2019-05-22) [stable]

Expand Down
35 changes: 35 additions & 0 deletions doc/bison.texi
Original file line number Diff line number Diff line change
Expand Up @@ -10490,6 +10490,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/getargs.c
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,7 @@ Warning categories include:\n\
'empty-rule' empty rules without %empty\n\
'midrule-values' unset or unused midrule values\n\
'precedence' useless precedence and associativity\n\
'useless-action' useless explicit actions\n\
'yacc' incompatibilities with POSIX Yacc\n\
'other' all other warnings (enabled by default)\n\
'all' all the warnings except 'yacc'\n\
Expand Down

0 comments on commit 5a47e23

Please sign in to comment.