Lokasi ngalangkungan proxy:   [ UP ]  
[Ngawartoskeun bug]   [Panyetelan cookie]                
Skip to content

Typos in The Core JDK Tools tutorial - Intro and Javac pages ( https://dev.java/learn/jvm/tools/core/intro/ and https://dev.java/learn/jvm/tools/core/javac/ ) #241

@willy-b

Description

@willy-b

Hello dev.java team!

Just reporting a few typos that may be of interest to fix on The Core JDK Tools tutorial - Intro and Javac pages ( https://dev.java/learn/jvm/tools/core/intro/ and https://dev.java/learn/jvm/tools/core/javac/ ).
This should be a relatively quick ticket (not covering a large tutorial with many small issues reported, just a couple of items).


On the latest version of https://dev.java/learn/jvm/tools/core/intro/ (archived as is at https://web.archive.org/web/20260506193624/https://dev.java/learn/jvm/tools/core/intro/?cache=false ),

  • In the sentence

    You can visit the following page to read all the tutorials related to the [OpenJDK tools].

    "[OpenJDK Tools]" looks like it was intended to be a hyperlink. I have not observed these tutorials elsewhere using such bracketed names for emphasis or any other purpose so it seems unintentional that "OpenJDK tools" is square bracketed here.


On the latest version of https://dev.java/learn/jvm/tools/core/javac/ ( https://web.archive.org/web/20260506194506/https://dev.java/learn/jvm/tools/core/javac/ ),

  • It might be useful to hyperlink the list of sections where javac options are described as all but one of them have linkable sidebar visible headings

    The different sets of javac options are described in the following sections:

    • Standard Options
    • Cross-Compilation Options for javac
    • Extra Options
  • The "Standard Options" heading is a bolded heading like "Cross-compilation" and "Extra Options" but does NOT show in the sidebar, unlike the others

  • The description of the -source/--source argument is JDK 16 specific, when it should not be:

    -source release Specifies the version of source code accepted. The following values for release are allowed:
    -source 15 The compiler accepts code with features introduced in Java SE 15.
    -source 16 The default value. The compiler accepts code with features introduced in Java SE 16.

    Instead of saying "16 The default value" or any of the above, it would be better to write something like:

    --source <release>, -source <release>
    Provide source compatibility with the specified Java SE release.
    Supported releases: [check your version of the JDK, usually any version >= 8 and <= the version of the JDK installed]

  • In the sentence

    By default, for releases prior to JDK 9, classes were compiled against the bootstrap classes of the platform that shipped with thejavac command.

    "thejavac command" should be "the javac command" (missing a space).


Thanks very much!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions