Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8336041

Doccheck: the jfr command doesn't show the correct command-line options

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P3 P3
    • 24
    • 23
    • hotspot
    • jfr
    • b27

      In an attempt to make our documentation HTML5 compliant, we want to clean up all the warnings reported by tidy against our documentation.

      if you look at
       https://docs.oracle.com/en/java/javase/22/docs/specs/man/jfr.html and look for "jfr configure subcommand", you will see
      "The syntax is:

      jfr configure [--interactive] [--verbose] [--input ] [--output ] [option=value]* [event-setting=value]*"

      when it actually is " `jfr configure` \[--interactive\] \[--verbose\]
                     \[--input <files>\] [--output <file>\]
                     \[option=value\]* \[event-setting=value\]*"

      This is because the `<` is not correctly escaped in "<files>" for example and should be "&lt;file>"

      The tidy tool reported a few more problems in the jfr.html man page

      ---- begin processing ./specs/man/jfr.html
      ./specs/man/jfr.html:228:1: Error: <files> is not recognized!
      ./specs/man/jfr.html:228:1: Warning: discarding unexpected <files>
      ./specs/man/jfr.html:228:20: Error: <file> is not recognized!
      ./specs/man/jfr.html:228:20: Warning: discarding unexpected <file>
      ./specs/man/jfr.html:274:44: Error: <filter> is not recognized!
      ./specs/man/jfr.html:274:44: Warning: discarding unexpected <filter>
      ./specs/man/jfr.html:274:64: Error: <filter> is not recognized!
      ./specs/man/jfr.html:274:64: Warning: discarding unexpected <filter>
      ./specs/man/jfr.html:275:2: Error: <file> is not recognized!
      ./specs/man/jfr.html:275:2: Warning: discarding unexpected <file>

            nbenalla Nizar Benalla
            nbenalla Nizar Benalla
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Created:
              Updated:
              Resolved: