Mercurial > hg > heapstats
changeset 133:936a1776ba30
Bug 2797: Sync docs and config between icedtea and github
Reviewed-by: yasuenag
GitHub: https://github.com/HeapStats/heapstats/pull/1
author | KUBOTA Yuji <kubota.yuji@gmail.com> |
---|---|
date | Fri, 22 Jan 2016 00:33:37 +0900 |
parents | b35a3db44df2 |
children | 55b5034ab722 |
files | .gitignore .hgignore .ignore CONTRIBUTING.md ChangeLog README |
diffstat | 6 files changed, 89 insertions(+), 37 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/.gitignore Fri Jan 22 00:33:37 2016 +0900 @@ -0,0 +1,1 @@ +.ignore \ No newline at end of file
--- a/.hgignore Mon Jan 18 21:29:47 2016 +0900 +++ b/.hgignore Fri Jan 22 00:33:37 2016 +0900 @@ -1,33 +1,1 @@ -/target/ - -syntax: regexp -# Ignore all {.classpath,.project,.settings/*} files except for folders in -# eclipse -# -# Using negative lookahead expression -^(?!eclipse).*\.(settings|project|classpath) - -syntax: glob -target/* -bin/* -*~ -*.versionsBackup -.deps/ -.dirstamp -agent/.cproject -agent/src/.deps/* -config.log -config.status -agent/heapstats.conf -autom4te.cache/ -agent/attacher/dist/*.jar -agent/attacher/heapstats-attacher -*.o -*.lo -*.Po -*.la -*.so -*.so.* -*.lai -*.class -Makefile +.ignore \ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/.ignore Fri Jan 22 00:33:37 2016 +0900 @@ -0,0 +1,38 @@ +target/ + +syntax: regexp +# Ignore all {.classpath,.project,.settings/*} files except for folders in +# eclipse +# +# Using negative lookahead expression +^(?!eclipse).*\.(settings|project|classpath) + +syntax: glob +target/* +bin/* +*~ +*.versionsBackup +.deps/ +.dirstamp +agent/.cproject +agent/src/.deps/* +config.log +config.status +agent/heapstats.conf +autom4te.cache/ +agent/attacher/dist/*.jar +agent/attacher/heapstats-attacher +analyzer/cli/heapstats-cli +*.o +*.lo +*.Po +*.la +*.so +*.so.* +*.lai +*.class +Makefile + +# SCM +.hg +.git
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/CONTRIBUTING.md Fri Jan 22 00:33:37 2016 +0900 @@ -0,0 +1,26 @@ +# Contributing guidelines + +We gladly accept new feature to this project. Please read the guidelines for reporting issues and submitting pull requests below. + +### Reporting issues + +- Please make clear in the subject what the issue is about. +- Include the version and vendor of Java Virtual Machine you are using. + - HeapStats agent depends on HotSpot VM, e.g., OpenJDK and Oracle JDK. If you uses other JVM, we may not fix the issue because the codes are not opened. But, pull request(s) which support other JVM are very welcome! + +***NOTE***: HeapStats project uses [bugzilla](http://icedtea.classpath.org/bugzilla/) mainly. If you have a time, please [create a new bug](http://icedtea.classpath.org/bugzilla/enter_bug.cgi?product=HeapStats) for bugzilla. + +### Pull request guidelines + +1. [Fork it](http://github.com/HeapStats/heapstats/fork) and clone your new repo +2. Create a branch (`git checkout -b my_good_feature`) +3. Commit your changes (`git add my/good/file.cpp; git commit -m "Added my good feature"`) +4. Push your changes to your fork (`git push origin my_good_feature`) +5. Open a [Pull Request](https://github.com/HeapStats/heapstats/pulls) + +The important cautions: + +- Your commit message(s) will be modified by maintainer to follow [icedtea format](http://icedtea.classpath.org/hg/heapstats/log). + - Do NOT worry, we ***NEVER*** remove your contributions. Just add small fixes. +- Do not update the ChangeLog. +
--- a/ChangeLog Mon Jan 18 21:29:47 2016 +0900 +++ b/ChangeLog Fri Jan 22 00:33:37 2016 +0900 @@ -1,3 +1,7 @@ +2016-01-22 KUBOTA Yuji <kubota.yuji@lab.ntt.co.jp> + + * Bug 2797: Sync docs and config between icedtea and github + 2016-01-18 Yasumasa Suenaga <yasuenag@gmail.com> * Bug 2793: MIB object type name fix
--- a/README Mon Jan 18 21:29:47 2016 +0900 +++ b/README Fri Jan 22 00:33:37 2016 +0900 @@ -5,16 +5,23 @@ This tool is composed of three programs: * Agent - * HeapStats JVMTI agent. + * HeapStats JVMTI agent for gathering JavaVM runtime information continuously. * Analyzer - * HeapStats GUI analyzer. + * HeapStats JavaFX GUI analyzer for analysis by various graphs. * CLI * HeapStats commandline analyzer. ## Agent ## -You can attach HeapStats agent as below: +Agent gathers various JavaVM runtime information such as the below. + + * The amount of instances and total size per live object + * The reference relationship of objects on Java Heap + * Thread condition + * and more. More detailed is [here](http://icedtea.classpath.org/wiki/HeapStats/information_to_be_collected). + +You can attach HeapStats agent by any way of the following: * -agentlib:heapstats[=conf] * If libheapstats.so is located at LD_LIBRARY_PATH, you can pass -agentlib option to java. @@ -67,8 +74,16 @@ If you want to see details, please run heapstats-cli with -help . +## Documents and Binaries ## + +More detailed documents and released binaries are hosted at icedtea community: http://icedtea.classpath.org/wiki/HeapStats + +## Contributing ## + +Contribution are most welcome! HeapStats is an open source project under the GNU General Public License, version 2. +See [CONTRIBUTING.md](https://github.com/HeapStats/heapstats/blob/master/CONTRIBUTING.md) for details. ## License ## - GNU General Public License, version 2 + [GNU General Public License, version 2](https://github.com/HeapStats/heapstats/blob/master/COPYING)