svn commit: r1484446 - /tomcat/trunk/res/ide-support/netbeans/README

[kk...@apache.org]

Author: kkolinko
Date: Mon May 20 12:35:24 2013
New Revision: 1484446

URL: http://svn.apache.org/r1484446
Log:
Correct product names

Modified:
    tomcat/trunk/res/ide-support/netbeans/README

Modified: tomcat/trunk/res/ide-support/netbeans/README
URL: http://svn.apache.org/viewvc/tomcat/trunk/res/ide-support/netbeans/README?rev=1484446&r1=1484445&r2=1484446&view=diff
==============================================================================
--- tomcat/trunk/res/ide-support/netbeans/README (original)
+++ tomcat/trunk/res/ide-support/netbeans/README Mon May 20 12:35:24 2013
@@ -16,93 +16,94 @@
 ================================================================================
 
 
-       Building and Debugging Tomcat under NetBeans
+       Building and Debugging Apache Tomcat under NetBeans
 
 
-Unlike other IDE's, netbeans is a pure java swing application. It uses ant
-to build its projects, and works directly with the class files and jars
-created by the standard ant build.xml files. This strength is also its
-weakness when working with complex projects such as tomcat that already
-have their own build.xml files, but which do not use the netbeans templates.
+Unlike other IDE's, NetBeans is a pure java swing application. It uses
+Apache Ant to build its projects, and works directly with the class files
+and jars created by the standard Apache Ant build.xml files. This strength
+is also its weakness when working with complex projects such as Tomcat that
+already have their own build.xml files, but which do not use the NetBeans
+templates.
 
-Any of complex ant project can still be managed under netbeans by
+Any of complex Ant project can still be managed under NetBeans by
 defining it to be something called a Free-Form Project. However, because
-the build.xml does not conform to all the netbeans naming and structural
+the build.xml does not conform to all the NetBeans naming and structural
 conventions, a certain amount of manual customisation is required to
 achieve a useful level of integration.
 
 
-1. Netbeans can open a tomcat source tree as a Free-Form Project, which
-   will allow you to edit, build, and debug tomcat and its unit tests
-   within the workbench. Even with netbeans 7.1, integration of a project
-   as complex as tomcat requires significant configuration. The
+1. NetBeans can open a Tomcat source tree as a Free-Form Project, which
+   will allow you to edit, build, and debug Tomcat and its unit tests
+   within the workbench. Even with NetBeans 7.1, integration of a project
+   as complex as Tomcat requires significant configuration. The
    configuration involves dealing with several quirky aspects of the way
-   netbeans manages this kind of project. Before you try to open tomcat
-   as a netbeans project, you are strongly recommended to successfully
-   build and run the tests using ant from a command prompt!
-   (see BUILDING.txt in the tomcat source root directory).
+   NetBeans manages this kind of project. Before you try to open Tomcat
+   as a NetBeans project, you are strongly recommended to successfully
+   build and run the tests using Apache Ant from a command prompt!
+   (see BUILDING.txt in the Tomcat source root directory).
 
-2. Once tomcat has been built, you can install the default netbeans
+2. Once Tomcat has been built, you can install the default NetBeans
    project configuration by running the following build target:
 
           ant ide-netbeans
 
-   This uses the tomcat build.xml to create a new directory called
-   nbproject (this name is reserved by netbeans). The nbproject directory
+   This uses the Tomcat build.xml to create a new directory called
+   nbproject (this name is reserved by NetBeans). The nbproject directory
    will then be primed with a self-consistent set of default definitions
-   sufficient to open tomcat as a Free-Form Project under netbeans.
+   sufficient to open Tomcat as a Free-Form Project under NetBeans.
 
-   Note: if you ever open the Project Properties from the netbeans context
+   Note: if you ever open the Project Properties from the NetBeans context
    menu, even without making any changes, there is a significant risk
-   that netbeans will modify one or more of these files. You can
-   restore the tomcat default files at any time by running this target:
+   that NetBeans will modify one or more of these files. You can
+   restore the Tomcat default files at any time by running this target:
 
           ant ide-netbeans-replace
 
    Only the default files will be overwritten, so any other content
-   such as your own local files, and the netbeans private directory,
+   such as your own local files, and the NetBeans private directory,
    will not be affected.
 
-3. Netbeans needs to know where to find the directory where you keep the
-   tomcat dependencies jars. If you have successfully built tomcat from
+3. NetBeans needs to know where to find the directory where you keep the
+   Tomcat dependencies jars. If you have successfully built Tomcat from
    a command prompt, you will probably have assigned the base.path
    property in your build.properties file.
 
-   Warning: The tomcat netbeans support will detect and use this property.
-            However, if you have left it to default, you MUST still define
-            this path in the nb-tomcat-project.properties file!
+   Warning: The support for Tomcat in NetBeans will detect and use this
+            property. However, if you have left it to default, you MUST
+            still define this path in the nb-tomcat-project.properties file!
 
-   Note: The current tomcat netbeans support does not include the
+   Note: The current support for Tomcat in NetBeans does not include the
          components in the modules directory (e.g. tomcate-lite).
 
-4. Start netbeans... once it has initialised and scanned your other open
+4. Start NetBeans... once it has initialised and scanned your other open
    projects, just open an existing project and select the location of
-   tomcat. Netbeans will recognise it as a Free-Form project, then read and
+   Tomcat. NetBeans will recognise it as a Free-Form project, then read and
    validate the nbproject/project.xml file. This file defines how to relate
-   targets in build.xml to netbeans project-related actions. It also tells
-   netbeans what classpaths to use for validation and code completion of
+   targets in build.xml to NetBeans project-related actions. It also tells
+   NetBeans what classpaths to use for validation and code completion of
    the various source directories.
 
    Warning: do not be tempted to casually click the properties menu item
-            for the tomcat project. Netbeans might change the contents
-            of these files. (The netbeans New Project wizard also
+            for the Tomcat project. NetBeans might change the contents
+            of these files. (The NetBeans New Project wizard also
             automatically creates a Free-Form project.xml which carries
             this same warning).
 
-   Note: the tomcat project should open successfully and, after the source
+   Note: the Tomcat project should open successfully and, after the source
          packages have been scanned, they should not be flagged with any
          syntax errors (except in some of the jsp bug unit tests).
 
-5. Verify your work by running the netbeans project Clean action. It
+5. Verify your work by running the NetBeans project Clean action. It
    should complete successfully. Next, run the Build action (which calls
-   the tomcat deploy build target) and confirm that it successfully
-   compiles the tomcat source files and creates the jars.
+   the Tomcat deploy build target) and confirm that it successfully
+   compiles the Tomcat source files and creates the jars.
 
 6. Next, navigate down to one of the test files and select the compile
    action. This will compile only your chosen file, although the compiler
    will find there is nothing to do unless you have deliberately changed it.
 
-   Note: if you have changed any of the tomcat source files, they will be
+   Note: if you have changed any of the Tomcat source files, they will be
    recompiled first. However, any changes to test files will not be compiled
    unless you select those file and explicitly compile them. If you have any
    doubts about dependencies between unit test classes, you can use the
@@ -110,12 +111,12 @@ achieve a useful level of integration.
    will be detected and compiled.
 
 7. You can run an individual unit test class by selecting it and choosing
-   the "run selected file" netbeans action. As the test runs, netbeans
+   the "run selected file" NetBeans action. As the test runs, NetBeans
    should open a unit test results pane that shows you the progress and
    final outcome of the test (Note: this feature does not currently work).
 
 8. Next, open the source of the unit test that ran successfully in step 7.
-   Set a breakpoint in one of the test cases, then request netbeans to
+   Set a breakpoint in one of the test cases, then request NetBeans to
    debug that class. The class will start running, and then will stop as
    it hits your breakpoint. You should be able to display variables, then
    navigate the call stack to open the source files of each method. You
@@ -124,19 +125,19 @@ achieve a useful level of integration.
    jUnit test result panel as in step 7 (Note: this feature does not
    currently work).
 
-9. You can also use your tomcat netbeans Free-Form project to debug an
-   external tomcat instance that is executing on the same, or a different
+9. You can also use your Tomcat NetBeans Free-Form project to debug an
+   external Tomcat instance that is executing on the same, or a different
    machine. (Obviously, the external instance must be running the same
    version of the source code!)
 
-   The external tomcat instance must be started with its jvm enabled for
+   The external Tomcat instance must be started with its jvm enabled for
    debugging by adding extra arguments to JAVA_OPTS, e.g.
    -Xdebug -Xrunjdwp:transport=dt_socket,address=8000,server=y,suspend=n
 
-   To debug the external tomcat instance under netbeans, select the
+   To debug the external Tomcat instance under NetBeans, select the
    "attach debugger" choice from the debug menu. Accept the default
    JPDA debugger with the SocketAttach connector and the dt_socket
-   transport. Specify the hostname and port where the tomcat jvm is
-   listening. Your netbeans workbench should then connect to the external
-   tomcat and display the running threads. You can now set breakpoints and
+   transport. Specify the hostname and port where the Tomcat jvm is
+   listening. Your NetBeans workbench should then connect to the external
+   Tomcat and display the running threads. You can now set breakpoints and
    begin debugging.



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org