Skip to content

Commit ed4e46a

Browse files
committed
Build plain uber JAR file instead of executable binary
No need to bring extra confusion by suggesting two different ways to start the program.
1 parent d29a9d4 commit ed4e46a

File tree

2 files changed

+10
-18
lines changed

2 files changed

+10
-18
lines changed

README.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -46,26 +46,18 @@ you can analyze the results using SQL.
4646

4747
### Examples
4848

49-
`hbase-packet-inspector` is an executable JAR file, but you can directly run
50-
it once you set the executable flag.
49+
Each version of HPI is distributed as an executable JAR file.
5150

5251
```sh
53-
# Setting the executable flag
54-
chmod +x hbase-packet-inspector
55-
./hbase-packet-inspector --help
52+
# With JVM options
53+
java -Xmx2g -jar hbase-packet-inspector-0.2.0.jar --help
5654

5755
# Reading from tcpdump output
5856
sudo tcpdump -s 0 -c 100000 -nn -w dump.pcap port 16020 or port 60020
59-
./hbase-packet-inspector dump.pcap
57+
java -jar hbase-packet-inspector-0.2.0.jar dump.pcap
6058

6159
# Capturing live stream of packets; continues until you press enter
62-
sudo ./hbase-packet-inspector
63-
```
64-
65-
Alternatively, you can start it with java command to pass extra JVM options.
66-
67-
```sh
68-
java -Xmx2g -jar hbase-packet-inspector --help
60+
sudo java -jar hbase-packet-inspector-0.2.0.jar
6961
```
7062

7163
### Kafka
@@ -176,8 +168,9 @@ sent to Kafka as JSON record.
176168
## Build
177169

178170
```sh
179-
# Requires leiningen
180-
lein bin
171+
# Build executable uber JAR file using Leiningen
172+
# -> target/hbase-packet-inspector-<VERSION>.jar
173+
lein uberjar
181174
```
182175

183176
## Development

project.clj

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,8 @@
2020
[cheshire "5.8.0"]
2121
[com.cemerick/url "0.1.1"]
2222
[junegunn/grouper "0.1.1"]]
23-
:plugins [[lein-bin "0.3.5"]
24-
[lein-cloverage "1.0.9"]]
25-
:bin {:bin-path "target"}
23+
:plugins [[lein-cloverage "1.0.9"]]
2624
:main hbase-packet-inspector.core
2725
:target-path "target/%s"
26+
:uberjar-name "../hbase-packet-inspector-%s.jar"
2827
:profiles {:uberjar {:aot :all}})

0 commit comments

Comments
 (0)