Uploaded image for project: 'Code Tools'
  1. Code Tools
  2. CODETOOLS-7903338

Use more explicit notation for placeholders in jtreg documentation.

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: P4 P4
    • None
    • None
    • tools
    • None

      In jtreg documentation, we use placeholders when explaining certain commands. For example on page https://openjdk.org/jtreg/runtests.html, there is a command
      ```
      % jtreg -jdk:test-jdk test-or-folder...
      ```
      Where "test-jdk" and "test-or-folder" are placeholders - user should substitute them with actual path to a home directory of the JDK we test and path to the test file or directory containing test file(s). I have few remarks to this.
      - the placeholders, don't stand out from a regular text. Better to use more explicit style, for example <angle_brack_surrounded>. The documentation exists in the form of an HTML page. We should be able to use any CSS decorations we like.

      2. It's not clear to where you *can* and to where you *cannot* *or *should not*) point with "-jdk:test-jdk" argument. There are many I "java" and "javac" files in JDK build directory.

            Unassigned Unassigned
            ibereziuk Ivan Bereziuk
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: