RFR: 8340133: Add concise usage message to the java executable [v3]
Maurizio Cimadamore
mcimadamore at openjdk.org
Fri Oct 25 11:15:12 UTC 2024
On Wed, 16 Oct 2024 17:38:17 GMT, Eirik Bjørsnøs <eirbjo at openjdk.org> wrote:
> The file separator is a secondary concern and could be moved to the end of the sentence:
>
> ```
> Where key java options include:
> --class-path <class path>
> a list of directories and JAR archives to search for class files, separated by ":"
> --module-path <module path>
> a list of directories and JAR archives to search for modules, separated by ":"
> ```
I agree with this comment. I also have another observation - it is not super obvious that "a list of directiories ..." is a description for what a <class path> or <module path> is. You kind of guess that being the case (what else can it be?) but something like:
--class-path <class path>
where <class path> is a list of directories and JAR archives to search for class files, separated by ":"
Seems more crystal clear?
(Btw, the reason I like moving `:` at the end is that you want users to quickly graps what <class path> is - and this trick does that: "a class path is a list of directories and jars" - whether they're `:` or `#!?` separated, that's a second-order concern at this point (as we're still defining the term).
-------------
PR Comment: https://git.openjdk.org/jdk/pull/21411#issuecomment-2437510741
More information about the core-libs-dev
mailing list