Skip to content

Commit 56b93cd

Browse files
authored
Fixes #4 by enhancing documentation (#15)
1 parent bb44355 commit 56b93cd

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.adoc

+17-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= OpenJDK proposals
1+
= OpenJDK split package scanner
22
Patrick Reinhart <https://github.com/reinhapa[@reinhapa]>
33
:project-full-path: reinhapa/jsplitpkgscan
44
:github-branch: master
@@ -8,7 +8,14 @@ Patrick Reinhart <https://github.com/reinhapa[@reinhapa]>
88
image:https://img.shields.io/badge/license-GPL2+CPE-blue.svg["GNU General Public License, version 2,
99
with the Classpath Exception", link="https://github.com/{project-full-path}/blob/{github-branch}/LICENSE"]
1010

11-
This project contains a proposal for a split package scanner tool http://openjdk.java.net[OpenJDK].
11+
This project contains a proposal for http://openjdk.java.net[OpenJDK] split package scanner addition.
12+
13+
The diving force starting this tool was the lack of tooling to prepare existing class path based modules
14+
for later migration to modules. For split packages with the current JDK, they will be shown by the `jdeps`
15+
tool as of today, but not class path based modules so far.
16+
17+
The `jsplitpgkscan` utility will search for split packages within all given `.jar` files and the modules
18+
known to the JDK itself and report them.
1219

1320
== Build and run
1421
To build the tool you need to have a actual _JDK_ build (OpenJDK or Oracle) that you can get from
@@ -29,13 +36,20 @@ java -p build/libs -m jsplitpkg
2936
----
3037

3138
== Create DOT graphic
32-
To get a PNG graphic for any .DOT file output you could use:
39+
To get a PNG graphic for any .DOT file output for directed graphs you could use:
3340

3441
[source, bash]
3542
----
3643
dot -Tpng summary.dot -O -Gratio=0.5
3744
----
3845

46+
If your experience problems due undirected graphs you could also use this command:
47+
48+
[source, bash]
49+
----
50+
twopi -Tpng summary.dot -O -Gratio=0.5 -Goverlap=false
51+
----
52+
3953
== Contribute
4054
Contributions are always welcome.
4155

0 commit comments

Comments
 (0)