Skip to content

Commit df465f0

Browse files
authored
Explain the produced Jars to avoid missuses
I spent some hours to understand that I was trying to execute the wrong Jar: I was wondering for hours what was wrong in the building process about produced `build/libs/sbe-all-1.7.0.jar` without `META-INF/MANIFEST.MF`. I think I am not alone because it was also the issue aeron-io#324 Instead of creating a new issue, I propose in this commit to provide some documentation in the README.md about produced Jars, and a warning to prevent using the wrong Jars.
1 parent 7eb8767 commit df465f0

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,18 @@ Run the Java examples
8383

8484
Distribution
8585
------------
86-
Jars for the executable, source, and javadoc for the various modules can be found in
86+
Jars for the executable, source, and javadoc for the various modules can be found in the following directories:
8787

88-
<module>/build/libs
88+
sbe-benchmarks/build/libs
89+
sbe-samples/build/libs
90+
sbe-tool/build/libs
91+
sbe-all/build/libs
92+
93+
An example to execute a Jar from command line:
94+
95+
java -Dsbe.generate.ir=true -Dsbe.target.language=Cpp -Dsbe.target.namespace=sbe -Dsbe.output.dir=include/gen -Dsbe.errorLog=yes -jar sbe-tool/build/libs/sbe-tool-1.7.0-all.jar my_sbe_input.xml
96+
97+
Note: The Jars in directory `build/libs` do not contain `META-INF/MANIFEST.MF` and the error *"no main manifest attribute"* will occur when trying to execute it.
8998

9099
C++ Build using CMake
91100
---------------------

0 commit comments

Comments
 (0)