(commons-crypto) branch master updated: Docco [skip ci]

[se...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-crypto.git


The following commit(s) were added to refs/heads/master by this push:
     new 96d82eec Docco [skip ci]
96d82eec is described below

commit 96d82eecb439c1af77f9219e5b35e9280bbfdf36
Author: Sebb <se...@apache.org>
AuthorDate: Sun Nov 19 12:54:16 2023 +0000

    Docco [skip ci]
---
 pom.xml | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/pom.xml b/pom.xml
index 2e2cbf75..1982bc26 100644
--- a/pom.xml
+++ b/pom.xml
@@ -74,6 +74,28 @@ The following provides more details on the included cryptographic software:
 
   </description>
 
+<!--
+  Notes on testing:
+
+  mvn -q exec:java -Dexec.mainClass=org.apache.commons.crypto.Crypto
+    - run a basic JNI test
+    -Djni.library.path=override default JNI library path (system dependent)
+    -Djni.library.name=override default JNI library name (libcrypto)
+
+  mvn -q exec:java -Dexec.mainClass=org.apache.commons.crypto.jna.OpenSslJna
+    - run a basic JNA test
+    -Djna.library.path=override default JNA library path (system dependent)
+    -Dcommons.crypto.OpenSslNativeJna=override default library name
+
+  Running examples (these are under the test tree, so need test scope):
+  mvn -q -Dexec.classpathScope=test -Dexec.mainClass=org.apache.commons.crypto.examples.CLASSNAME
+    where CLASSNAME is CipherByteArrayExample, CipherByteBufferExample, RandomExample, StreamExample
+  
+  Additional options
+  -Djna.debug_load - debug JNA loading
+  -Dcommons.crypto.debug - add some Commons Crypto debugging
+-->
+
   <inceptionYear>2016</inceptionYear>
   <url>https://commons.apache.org/proper/commons-crypto/</url>