Skip to content

MINOR: [Docs][C++] Clarify ARROW_TEST_DATA requirement for tests - #48789

Open
meher745 wants to merge 3 commits into
apache:mainfrom
meher745:doc/clarify-cpp-test-data
Open

MINOR: [Docs][C++] Clarify ARROW_TEST_DATA requirement for tests#48789
meher745 wants to merge 3 commits into
apache:mainfrom
meher745:doc/clarify-cpp-test-data

Conversation

@meher745

@meher745 meher745 commented Jan 8, 2026

Copy link
Copy Markdown
Contributor

Rationale for this change

While setting up the C++ build on macOS, I encountered an IOError during testing because ARROW_TEST_DATA and PARQUET_TEST_DATA were not set. The current documentation lacks a clear warning that these exports are mandatory for a successful test pass.

What changes are included in this PR?

I added a .. note:: block to building.rst clarifying the need to initialize submodules and export absolute paths for test data folders.

Are these changes tested?

Yes, I built the documentation locally using Sphinx (make html) to verify the formatting renders correctly.

Are there any user-facing changes?

Yes, this updates the developer-facing documentation for C++ building.

@raulcd raulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! @meher745 this is great. A small nit, should this bit go specifically one paragraph earlier (line 316)?
Before line 316 we discuss about building the unit tests so it's much more related. People reading about building tests might skip this paragraph as we have a "non-related" paragraph about linux distribution issues in the middle. cc @AlenkaF

@raulcd raulcd changed the title MINOR: [docs][C++] Clarify ARROW_TEST_DATA requirement for tests MINOR: [Docs][C++] Clarify ARROW_TEST_DATA requirement for tests Jan 8, 2026
@meher745

meher745 commented Jan 8, 2026

Copy link
Copy Markdown
Contributor Author

Hi @raulcd ! I've updated the PR and moved the note to line 316 as suggested. Thanks for the quick review.

Comment thread docs/source/developers/cpp/building.rst Outdated
Comment thread docs/source/developers/cpp/building.rst
@raulcd

raulcd commented Jan 9, 2026

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

github-actions Bot commented Jan 9, 2026

Copy link
Copy Markdown

Revision: bb12d58

Submitted crossbow builds: ursacomputing/crossbow @ actions-4b2930f0e9

Task Status
preview-docs GitHub Actions

Comment thread docs/source/developers/cpp/building.rst Outdated
@github-actions github-actions Bot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels Jan 9, 2026
@raulcd

raulcd commented Jan 9, 2026

Copy link
Copy Markdown
Member

Also, not related to your PR but if you could rebase main we will be able to get the docs CI passing as there was an issue that was causing both the Docs checks and the preview-docs to fail that has already been solved there.

@github-actions github-actions Bot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Jan 9, 2026
@meher745
meher745 force-pushed the doc/clarify-cpp-test-data branch from e603312 to 442145c Compare January 9, 2026 09:26
@meher745
meher745 force-pushed the doc/clarify-cpp-test-data branch from 442145c to 7d44834 Compare January 9, 2026 09:28
@raulcd

raulcd commented Jan 9, 2026

Copy link
Copy Markdown
Member

@github-actions crossbow submit preview-docs

@github-actions

github-actions Bot commented Jan 9, 2026

Copy link
Copy Markdown

Revision: 7d44834

Submitted crossbow builds: ursacomputing/crossbow @ actions-eef1314075

Task Status
preview-docs GitHub Actions

@raulcd raulcd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@raulcd
raulcd requested review from AlenkaF and HyukjinKwon January 9, 2026 10:48
@github-actions github-actions Bot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Jan 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants