langtools/make/netbeans/README
changeset 1873 658385834998
parent 10 06bc494ca11e
child 11864 116173ff7d77
equal deleted inserted replaced
1872:9820a8bee1e5 1873:658385834998
     1 Working on the "langtools" workspace using NetBeans.
     1 Using NetBeans to work on the langtools repository.
     2 
     2 
     3 This directory (make/netbeans) contains NetBeans projects that
     3 Netbeans 6.0 or later is recommended.
     4 allow you to work on the various tools using the NetBeans IDE.
       
     5 
     4 
     6 NetBeans 5.0 or later is required and sufficient to use these 
     5 The "langtools" project in this directory allows you to
     7 projects. This is different from other projects in OpenJDK, 
     6 edit, run, test and debug the tools in the OpenJDK langtools
     8 which requires version 6.0 or later.
     7 repository.
     9 
     8 
    10 The following projects are provided:
     9 The repository contains a number of tools:
       
    10     apt, javac, javadoc and its doclets, javah and javap.
    11 
    11 
    12 compiler: for working on the compiler, javac
    12 Build Properties.
    13 javadoc:  for working on the documentation tool, javadoc
       
    14 doclets:  for working on the standard doclets used by the 
       
    15  	  documentation tool, javadoc
       
    16 javah:    for working on the C header tool, javah
       
    17 javap:    for working on the disassembler, javap
       
    18 apt:      for working on the annotation processing tool, apt.
       
    19           Note that this is just provided for completeness;
       
    20           the tool has been superceded by new features in javac,
       
    21           and work on apt itself is discouraged.
       
    22 
    13 
    23 However, any tool can be worked on from any project; the only difference
    14 To build this repository, you must set some properties for Ant.
    24 between these projects is the behavior of the standard NetBeans actions,
    15 You can set these properties in a number of ways:
    25 so that "Build" in the compiler project will build the compiler, etc.
       
    26 
    16 
       
    17 - Set the properties in the Properties panel under Tool> Options> Ant.
       
    18   Properties set this way will apply globally to all the langtools 
       
    19   repositories you may be working on.
    27 
    20 
       
    21 - Create a file build.properties in the root directory of a
       
    22   langtools repository, and set the properties in that file.
       
    23   These properties will be specific to that repository.
    28 
    24 
       
    25 To build the repository, at a minimum you must set the "boot.java.home"
       
    26 property.  To run the tools, you must also set "target.java.home". To
       
    27 run the regression tests, you must set "jtreg.home".
       
    28 
       
    29 By default, the build and test targets will build and test all
       
    30 of these tools. The run and debug targets will prompt you for the
       
    31 name of a tool to execute.
       
    32 
       
    33 As an alternative, you can focus on a single tool.  When you do
       
    34 this, you will still see all the source code for all the tools,
       
    35 but the various Ant targets will now be focussed on the selected tool.
       
    36 To focus on a tool, bring up the context menu on the "langtools"
       
    37 project (i.e. right-click on the project) and select "Select Tool".
       
    38 This brings up a dialog which allows you to specify which tool you
       
    39 wish to work on, and the arguments to use if and when you run it.