This is an automated email from the ASF dual-hosted git repository.
lidavidm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-cookbook.git
The following commit(s) were added to refs/heads/main by this push:
new ca3b5a2 [Java] Clarifying dependencies to build Java cookbook (#193)
ca3b5a2 is described below
commit ca3b5a2276bc5fc5196e2cf38e80a9ddc7ec10c8
Author: Todd Farmer <[email protected]>
AuthorDate: Tue May 24 12:57:16 2022 -0600
[Java] Clarifying dependencies to build Java cookbook (#193)
---
java/CONTRIBUTING.rst | 29 ++++++++++++++++++++++-------
1 file changed, 22 insertions(+), 7 deletions(-)
diff --git a/java/CONTRIBUTING.rst b/java/CONTRIBUTING.rst
index e5c58e9..29fd4bc 100644
--- a/java/CONTRIBUTING.rst
+++ b/java/CONTRIBUTING.rst
@@ -1,13 +1,21 @@
Building the Java Cookbook
=========================
-
The Java cookbook uses the Sphinx documentation system.
-Running ``make java`` from the cookbook root directory (the one where
-the ``README.rst`` exists) will install all necessary dependencies
-and will compile the cookbook to HTML.
+Dependencies
+-------------------------
+The following are required to successfully build the Java cookbook:
+
+Python
+^^^^^^^^^^^^^^^^^^^^^^^^^
+The cookbook build tooling depends upon Python, and the ability to
+install needed packages via pip, to build the Java cookbook. The
+dependency packages managed via pip by build scripts are found at
+`requirements.txt <requirements.txt>`_.
-For java cookbook we are running these with Java Shell tool -
+Java Shell
+^^^^^^^^^^^^^^^^^^^^^^^^^
+For Java cookbook we are running these with Java Shell tool -
`JShell
<https://docs.oracle.com/en/java/javase/11/jshell/introduction-jshell.html>`_
.. code-block:: bash
@@ -21,6 +29,13 @@ For java cookbook we are running these with Java Shell tool -
> jshell --version
jshell 11.0.14
+
+Build Process
+-------------------------
+Run ``make java`` from the cookbook root directory (the one where
+the ``README.rst`` exists) to install all necessary dependencies
+and compile the cookbook to HTML.
+
You will see the compiled result inside the ``build/java`` directory.
Testing Java Recipes
@@ -29,8 +44,8 @@ Testing Java Recipes
All recipes in the cookbook must be tested. The cookbook uses
``javadoctest`` to verify the recipes.
-Running ``make javatest`` from the cookbook root directory
-will verify that the code for all the recipes runs correctly
+Run ``make javatest`` from the cookbook root directory
+to verify that the code for all the recipes runs correctly
and provides the expected output.
Adding Java Recipes
