RFR: 8268549: Typo in file name in example for -Xlint:processing
Guoxiong Li
gli at openjdk.java.net
Fri Jun 11 16:19:48 UTC 2021
On Fri, 11 Jun 2021 15:29:08 GMT, Piotrek Żygieło <github.com+11896137+pzygielo at openjdk.org> wrote:
>> Presented class is public, hence it has to be defined in AnnoProc.java.
>
> Perhaps [this change in method name in example](https://github.com/pzygielo/jdk/compare/typo...pzygielo:method?expand=1) could be considered for this bug as well? It's in the same file. I can push additional commit to this branch if accepted.
@pzygielo Thanks for your contribution. The man documentations, like `*.1`, are generated from the original Markdown files by using some tools. So we can't directedly revise these `*.1` files. Some comments from another [example](https://github.com/openjdk/jdk/pull/1758#discussion_r544529498) are linked here for you.
> This change is somewhat problematic. The nroff man files are generated from Markdown files which are not (yet) open source. Don't ask: long story; we're working on it.
>
> The bottom line is that this change should really be made to the upstream Markdown file. Direct changes to this file are at risk of being overwritten at some point in the future.
Currently, in order to solve this issue, we can report it to the oracle employees and get their help to revise the original files.
Could @kevinrushforth or anyone else from oracle take a look?
I see that the `Assignee` of [this bug](https://bugs.openjdk.java.net/browse/JDK-8268549) is @jonathan-gibbons. Maybe he can give more information and help, too.
-------------
PR: https://git.openjdk.java.net/jdk/pull/3937
More information about the compiler-dev
mailing list