Error-prone: Compiler flag to ignore generated code is undocumented

Created on 22 Sep 2016 · 12Comments · Source: google/error-prone

The compiler flag -XepDisableWarningsInGeneratedCode isn't in the official documentation

The release instructions doesn't specify how one adds documentation for command line flags. It seems to be a manual process.

Source

vprithvi

👍11

Most helpful comment

Very useful flag that isn't documented at all. I'd love to see this rectified.

JamesMcMahon on 7 Nov 2016

👍4

All 12 comments

Cool, didn't know about this flag. Cursory inspection indicates that generated code is identified by the presence of the @Generated annotation. I've just tested this; works well. I can now re-enable a bug pattern to which some of our wsimport/xjc-generated code does not comply. Nice :)

Stephan202 on 23 Sep 2016

Very useful flag that isn't documented at all. I'd love to see this rectified.

JamesMcMahon on 7 Nov 2016

👍4

Even with this flag I'm still getting warnings regarding Dagger's generated code.

stanmots on 14 Apr 2017

I am also seeing issues with Databinding.

jaredsburrows on 26 Apr 2017

This has been added in https://github.com/google/error-prone/commit/9f9f23adeb9dfaa3e1f877d9be8b56d9c824194d a few days ago.

tbroyer on 2 Jun 2017

@tbroyer Hows does it work? Are we forced to write a custom patch?

jaredsburrows on 2 Jun 2017

@jaredsburrows Not sure I understand your question, but -XepDisableWarningsInGeneratedCode will disable/remove/ignore warnings (not errors!) in code annotated with @Generated: https://github.com/google/error-prone/issues/329#issuecomment-117318164

tbroyer on 3 Jun 2017

You said in your previous comment:

This has been added in 9f9f23a a few days ago.

The -XepDisableWarningsInGeneratedCode argument has been in error prone for some time right? https://github.com/google/error-prone/blame/master/check_api/src/main/java/com/google/errorprone/ErrorProneOptions.java#L56

jaredsburrows on 3 Jun 2017

This issue is about the flag's documentation. http://errorprone.info/docs/flags
The flag itself has been added in 2.0.6.

tbroyer on 3 Jun 2017

just encountered this due in part to the immutables library, and I too am noticing there is not a corresponding flag to ignore ERROR which I have some of, because I set MissingOverride and Var to error so that they fail the test, of course I don't care if generated code does this. could open a new bug to add that flag.

my current workaround is to ignore the directory, even thought eh classes are appropriately annotated with @Generated

tasks.withType(JavaCompile) {
    options.compilerArgs += [
        '-XepExcludedPaths:.*/build/classes/.*',
        '-Xep:MissingOverride:ERROR',
        '-Xep:Var:ERROR',
    ]
}