jdk/makefiles/mkdemo/jvmti/README.txt
changeset 12317 9670c1610c53
equal deleted inserted replaced
12316:ba6b7a51e226 12317:9670c1610c53
       
     1 #
       
     2 # Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
       
     3 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
       
     4 #
       
     5 # This code is free software; you can redistribute it and/or modify it
       
     6 # under the terms of the GNU General Public License version 2 only, as
       
     7 # published by the Free Software Foundation.  Oracle designates this
       
     8 # particular file as subject to the "Classpath" exception as provided
       
     9 # by Oracle in the LICENSE file that accompanied this code.
       
    10 #
       
    11 # This code is distributed in the hope that it will be useful, but WITHOUT
       
    12 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
       
    13 # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
       
    14 # version 2 for more details (a copy is included in the LICENSE file that
       
    15 # accompanied this code).
       
    16 #
       
    17 # You should have received a copy of the GNU General Public License version
       
    18 # 2 along with this work; if not, write to the Free Software Foundation,
       
    19 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
       
    20 #
       
    21 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
       
    22 # or visit www.oracle.com if you need additional information or have any
       
    23 # questions.
       
    24 #
       
    25 
       
    26 Instructions on adding a jvmti demo agent.
       
    27 
       
    28 Basically you want to mimic the jvmti demo agent "mtrace".
       
    29 
       
    30 * Create and populate a source directory at src/share/demo/jvmti
       
    31   (Try and re-use code in agent_util area like src/share/demo/jvmti/mtrace)
       
    32   (This should include a small README.txt document on what this demo is)
       
    33 
       
    34 * Make sure the appropriate "demo" copyright notice is added to all the
       
    35   source files.
       
    36 
       
    37 * Edit src/share/demo/jvmti/index.html and add in reference to this demo.
       
    38 
       
    39 * Create make directory at make/mkdemo/jvmti
       
    40   (Mimic make/mkdemo/jvmti/mtrace/Makefile)
       
    41 
       
    42 * Edit make/mkdemo/jvmti/Makefile and add in the new demo
       
    43 
       
    44 * Create test directory at test/demo/jvmti, create at least one test
       
    45   (Use test/demo/jvmti/mtrace as a template)
       
    46 
       
    47 * Don't forget to check in all the new files
       
    48 
       
    49 * Build and create images (cd make && gnumake && gnumake images)
       
    50   (Do this on Solaris, Linux, and at least one Windows platform)
       
    51 
       
    52 * Verify that browsing build/*/j2sdk-images/demo/jvmti looks right
       
    53 
       
    54 * Run the tests: cd test/demo/jvmti && runregress .
       
    55   (Do this on Solaris, Linux, and at least one Windows platform)
       
    56 
       
    57 Contact: serviceability-dev@openjdk.java.net for more information or help.
       
    58