make/jdk/netbeans/jconsole/README
author erikj
Tue, 12 Sep 2017 19:03:39 +0200
changeset 47216 71c04702a3d5
parent 2 jdk/make/netbeans/jconsole/README@90ce3da70b43
permissions -rw-r--r--
8187443: Forest Consolidation: Move files to unified layout Reviewed-by: darcy, ihse
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
Working on JConsole Using the NetBeans IDE
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
This JConsole NetBeans project allows a developer interested in making changes
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
to and/or fixing bugs in the jconsole tool to modify, build, run and test
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
jconsole in a standalone manner as well as generating the javadoc for the
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
JConsole plugin API.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
README FIRST
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
  make/netbeans/README to get started with NetBeans IDE and OpenJDK, and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
  working with the OpenJDK NetBeans projects.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
WORKING WITH JCONSOLE
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
JConsole doesn't contain native code. It's a pure java tool. You don't need to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
have all the Java SE sources to work on JConsole but just the following subset:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
            make/netbeans/ 
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
            src/share/classes/com/sun/tools/jconsole/
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
            src/share/classes/sun/tools/jconsole/
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
            test/TEST.ROOT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
            test/sun/tools/jconsole/
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
The set of actions supported by this project are:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
* Build Project:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
  - Compiles JConsole's source files and puts the class files under
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
    build/${platform}-${arch}/classes.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
  - Generates JConsole's jar file under dist/lib/jconsole.jar
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
    This new jar file could be used to patch an existing JDK installation
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
    by replacing the jar file at <jdk-home>/lib/jconsole.jar, then calling
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
    <jdk-home>/bin/jconsole will make use of the new jar file.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
* Generate Javadoc for Project
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
  - Generates the javadoc for the JConsole Plugin API source files,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
    i.e. the ones under src/share/classes/com/sun/tools/jconsole.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
  - The javadoc is generated under build/${platform}-${arch}/javadoc/jconsole.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
* Test Project
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
  - Runs the JConsole jtreg unit tests located under test/sun/tools/jconsole.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
  - The test results are written under
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
        build/${platform}-${arch}/jtreg/jconsole
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
    and the HTML test report can be found at
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
        build/${platform}-${arch}/jtreg/jconsole/JTreport/report.html
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
* Run Project
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
  - Runs the newly built JConsole tool.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
* Clean Project
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
  - Cleans the files created by this projet under build and dist.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
IMPORTANT NOTE
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
  Please make sure to follow carefully the governance rules documented at
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
  http://openjdk.dev.java.net/