MINOR: [Docs] Update docs to point to separate Java codebase #45134

ParthChonkar · 2024-12-31T07:48:42Z

Rationale for this change

Post #44945 the Java implementation lives in it's own repo. Update docs
to point there.

What changes are included in this PR?

Updates to a few locations that reference old Java impl location.

Are these changes tested?

Rendered the Sphinx ones locally to check.

Are there any user-facing changes?

No

ParthChonkar · 2024-12-31T07:56:38Z

These changes are pretty trivial + are mainly for docs that aren't specifically related to java.

Though one remaining issue is that the following pages/sub-pages

still live in this repo which I assume isn't desired 🤔 .

docs/source/developers/guide/step_by_step/arrow_codebase.rst

docs/source/developers/java/building.rst

kou · 2024-12-31T12:51:57Z

@github-actions crossbow submit preview-docs

github-actions · 2024-12-31T12:54:10Z

Revision: 1a0d899

Submitted crossbow builds: ursacomputing/crossbow @ actions-c3413aeb10

Task	Status
preview-docs

kou · 2025-01-01T02:53:46Z

Could you also update cd arrow/java too in http://crossbow.voltrondata.com/pr_docs/45134/developers/java/building.html ?

ParthChonkar · 2025-01-02T00:43:48Z

@github-actions crossbow submit preview-docs

github-actions · 2025-01-02T00:44:22Z

Only contributors can submit requests to this bot. Please ask someone from the community for help with getting the first commit in.
The Archery job run can be found at: https://github.com/apache/arrow/actions/runs/12575895325

ParthChonkar · 2025-01-02T00:53:09Z

docs/source/developers/java/building.rst

@@ -144,7 +144,7 @@ Maven

  .. code-block::

-      $ cd arrow/java
+      $ cd arrow-java
      $ mvn generate-resources -Pgenerate-libs-jni-windows -N


Building JNI libs with maven is broken until the pom.xml file is updated in arrow-java to avoid passing -S java to cmake among other problems.

Should we wait for apache/arrow-java#449 ?

Yup, I'll wait on apache/arrow-java#449.

Will this order work?

GH-13: Set up JNI build (dataset, etc.) arrow-java#449 lands

I'll try to verify each build path and update the docs on this PR -> merge it into apache/arrow

~~[Docs] Migrate java development and usage docs from apache/arrow arrow-java#472~~ [Doc] Generate Java documentation arrow-java#455 (I can try to cherry-pick the commits in the docs in a similar way that was done for the source code)

Remove java docs from apache/arrow

Yes. Let's use the order.

ParthChonkar · 2025-01-02T00:55:13Z

docs/source/developers/java/building.rst

@@ -293,7 +300,7 @@ Archery

 .. code-block:: text

-    $ cd arrow
+    $ cd arrow-java


Bit unfamiliar with archery, but I couldn't find any directives/targets for java-jni-manylinux-2014 in any of the dockerfiles between both repos.

We can use docker compose instead of Archery.
apache/arrow-java uses docker compose directly instead of via Archery.

Ah I see, after apache/arrow-java#449 I can replace the archery sections with docker compose

ParthChonkar · 2025-01-02T00:56:17Z

Could you also update cd arrow/java too in http://crossbow.voltrondata.com/pr_docs/45134/developers/java/building.html ?

Updated + tweaked the build instructions for the JNI libraries. I commented on this review a few more problems in the "building Java" docs. Some need source fixes to be done in arrow-java - could these updates be made once the java documentation has moved to apache/arrow-java maybe?

kou · 2025-01-02T02:10:06Z

@github-actions crossbow submit preview-docs

github-actions · 2025-01-02T02:12:21Z

Revision: 197369e

Submitted crossbow builds: ursacomputing/crossbow @ actions-88de21002f

Task	Status
preview-docs

ParthChonkar · 2025-01-28T21:50:05Z

Apologies was a bit delayed here. I see that building.rst has been moved to arrow-java in https://github.com/apache/arrow-java/pull/553/files.

A significant portion of that file needs to be updated - even with the existing changes I have in this PR.

Given the above, could I leave building.rst out of this PR? The other two updates are for files that will remain in this repo.
I believe it'll make more sense to update the java/building.rst documentation iteratively in arrow-java.

kou · 2025-01-29T03:03:58Z

Yes, please.

Co-authored-by: Sutou Kouhei <[email protected]>

ParthChonkar · 2025-01-30T02:02:35Z

Reverted building.rst changes

kou · 2025-01-30T05:05:23Z

@github-actions crossbow submit preview-docs

github-actions · 2025-01-30T05:07:37Z

Revision: 26a6cf8

Submitted crossbow builds: ursacomputing/crossbow @ actions-ba09884753

Task	Status
preview-docs

kou

+1

http://crossbow.voltrondata.com/pr_docs/45134/developers/guide/step_by_step/arrow_codebase.html

conbench-apache-arrow · 2025-01-30T14:38:50Z

After merging your PR, Conbench analyzed the 4 benchmarking runs that have been run so far on merge-commit aaa88e9.

There were 8 benchmark results with an error:

Commit Run on arm64-t4g-2xlarge-linux at 2025-01-30 09:04:52Z
- tpch (R) with engine=arrow, format=native, language=R, memory_map=False, query_id=TPCH-03, scale_factor=1
- tpch (R) with engine=arrow, format=parquet, language=R, memory_map=False, query_id=TPCH-03, scale_factor=1
and 6 more (see the report linked below)

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about 5 possible false positives for unstable benchmarks that are known to sometimes produce them.

…45134) ### Rationale for this change Post apache#44945 the Java implementation lives in it's own repo. Update docs to point there. ### What changes are included in this PR? Updates to a few locations that reference old Java impl location. ### Are these changes tested? Rendered the Sphinx ones locally to check. ### Are there any user-facing changes? No Lead-authored-by: parthchonkar <[email protected]> Co-authored-by: Parth Chonkar <[email protected]> Co-authored-by: Sutou Kouhei <[email protected]> Signed-off-by: Sutou Kouhei <[email protected]>

github-actions bot added Component: Documentation awaiting review Awaiting review labels Dec 31, 2024

kou reviewed Dec 31, 2024

View reviewed changes

docs/source/developers/guide/step_by_step/arrow_codebase.rst Outdated Show resolved Hide resolved

docs/source/developers/java/building.rst Outdated Show resolved Hide resolved

kou changed the title ~~MINOR: [Docs] Update docs to point to separate java codebase~~ MINOR: [Docs] Update docs to point to separate Java codebase Dec 31, 2024

github-actions bot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels Dec 31, 2024

github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Dec 31, 2024

ParthChonkar mentioned this pull request Dec 31, 2024

[Docs] Migrate java development and usage docs from apache/arrow apache/arrow-java#472

Closed

github-actions bot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Jan 1, 2025

github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 2, 2025

ParthChonkar commented Jan 2, 2025

View reviewed changes

github-actions bot added awaiting changes Awaiting changes and removed awaiting change review Awaiting change review labels Jan 2, 2025

ParthChonkar mentioned this pull request Jan 3, 2025

[Doc] Generate Java documentation apache/arrow-java#455

Open

ParthChonkar and others added 2 commits January 29, 2025 20:57

[Docs] Update docs to point to separate java codebase

e62d31c

Apply suggestions from code review

25520bd

Co-authored-by: Sutou Kouhei <[email protected]>

ParthChonkar added 2 commits January 29, 2025 20:57

Adress review comments + tweak build instructions

7a258bd

Checkout building.rst back to main

26a6cf8

ParthChonkar force-pushed the update-doc-java branch from 197369e to 26a6cf8 Compare January 30, 2025 01:59

github-actions bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 30, 2025

kou approved these changes Jan 30, 2025

View reviewed changes

kou merged commit aaa88e9 into apache:main Jan 30, 2025
7 checks passed

github-actions bot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Jan 30, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MINOR: [Docs] Update docs to point to separate Java codebase #45134

MINOR: [Docs] Update docs to point to separate Java codebase #45134

ParthChonkar commented Dec 31, 2024 •

edited by kou

Loading

ParthChonkar commented Dec 31, 2024 •

edited

Loading

kou commented Dec 31, 2024

github-actions bot commented Dec 31, 2024

kou commented Jan 1, 2025

ParthChonkar commented Jan 2, 2025

github-actions bot commented Jan 2, 2025

ParthChonkar Jan 2, 2025

kou Jan 2, 2025

ParthChonkar Jan 2, 2025 •

edited

Loading

kou Jan 2, 2025

ParthChonkar Jan 2, 2025

kou Jan 2, 2025

ParthChonkar Jan 2, 2025

ParthChonkar commented Jan 2, 2025

kou commented Jan 2, 2025

github-actions bot commented Jan 2, 2025

ParthChonkar commented Jan 28, 2025 •

edited

Loading

kou commented Jan 29, 2025

ParthChonkar commented Jan 30, 2025

kou commented Jan 30, 2025

github-actions bot commented Jan 30, 2025

kou left a comment

conbench-apache-arrow bot commented Jan 30, 2025

MINOR: [Docs] Update docs to point to separate Java codebase #45134

MINOR: [Docs] Update docs to point to separate Java codebase #45134

Conversation

ParthChonkar commented Dec 31, 2024 • edited by kou Loading

Rationale for this change

What changes are included in this PR?

Are these changes tested?

Are there any user-facing changes?

ParthChonkar commented Dec 31, 2024 • edited Loading

kou commented Dec 31, 2024

github-actions bot commented Dec 31, 2024

kou commented Jan 1, 2025

ParthChonkar commented Jan 2, 2025

github-actions bot commented Jan 2, 2025

ParthChonkar Jan 2, 2025

Choose a reason for hiding this comment

kou Jan 2, 2025

Choose a reason for hiding this comment

ParthChonkar Jan 2, 2025 • edited Loading

Choose a reason for hiding this comment

kou Jan 2, 2025

Choose a reason for hiding this comment

ParthChonkar Jan 2, 2025

Choose a reason for hiding this comment

kou Jan 2, 2025

Choose a reason for hiding this comment

ParthChonkar Jan 2, 2025

Choose a reason for hiding this comment

ParthChonkar commented Jan 2, 2025

kou commented Jan 2, 2025

github-actions bot commented Jan 2, 2025

ParthChonkar commented Jan 28, 2025 • edited Loading

kou commented Jan 29, 2025

ParthChonkar commented Jan 30, 2025

kou commented Jan 30, 2025

github-actions bot commented Jan 30, 2025

kou left a comment

Choose a reason for hiding this comment

conbench-apache-arrow bot commented Jan 30, 2025

ParthChonkar commented Dec 31, 2024 •

edited by kou

Loading

ParthChonkar commented Dec 31, 2024 •

edited

Loading

ParthChonkar Jan 2, 2025 •

edited

Loading

ParthChonkar commented Jan 28, 2025 •

edited

Loading