Output of doc data tool #1448
Output of doc data tool #1448
Conversation
Still needs addition of previous material.
| - option: "-javabootclasspath" | ||
| schema: | ||
| type: "Path" | ||
| arg: "path" | ||
| default: "/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/resources.jar:/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/rt.jar:/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/sunrsasign.jar:/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/jsse.jar:/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/jce.jar:/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/charsets.jar:/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/jfr.jar:/usr/lib/jvm/java-8-openjdk-amd64/jre/classes" | ||
| default: "" |
There was a problem hiding this comment.
These are run-specific, I think that's why I added the note on the main page.
| description: "Enable optimizer warnings: `_` for all, `-opt-warnings:help` to list choices." | ||
| - option: "-optimise" | ||
| description: "Enable optimizer warnings" | ||
| - option: "-optimize" |
There was a problem hiding this comment.
This is a clear improvement.
| schema: | ||
| type: "Boolean" | ||
| description: "Retains pre 2.10 behavior of less aggressive truncation of least upper bounds." | ||
| description: "Former graveyard for language-forking extensions." |
There was a problem hiding this comment.
Does this mean deprecated options aren't currently distinguished?
This had a special note before. Probably the tool should inject notes, modified default values, etc.
| default: "255" | ||
| min: "72" | ||
| max: "255" | ||
| description: "Maximum filename length for generated classes" |
There was a problem hiding this comment.
I think this was removed without replacement (fixed at 255). Maybe it would be nice to document that somehow.
| @@ -460,25 +503,8 @@ | |||
| schema: | |||
| type: "String" | |||
| arg: "path" | |||
| default: "misc/scala-devel/plugins" | |||
| default: "" | |||
There was a problem hiding this comment.
Another default to fix.
| - choice: "compact" | ||
| - choice: "format" | ||
| - choice: "text+format" | ||
| description: "How to print trees when -Vprint is enabled. ([text],compact,format,text+format)" |
There was a problem hiding this comment.
This was an example of not a simple rename. Document it.
|
A paragraph at the top about the new prefixes, and common use cases for warnings and mild debugging that everyone should know. And maybe optimizer. |
|
I assume this hasn't been merged yet because we're waiting for you to respond to your own review feedback :-) Shall we go ahead and merge as-is, or are you planning further changes? |
|
I'll try to contribute improvements in a follow-up PR. I think this at least shows the options? Anyone still on 2.12 is probably no longer fiddling with their options. |
Run under 2.13, but with local paths elided from output.
More work is needed on the tool side to restore useful text and be convenient to run.
Fixes: #1444