Skip to content

[GLUTEN-9369][DOC] Fix commands in the Gluten C++ debugging developer doc#9368

Merged
PHILO-HE merged 7 commits intoapache:mainfrom
dmsuehir:dina/debug_cpp_doc
Apr 22, 2025
Merged

[GLUTEN-9369][DOC] Fix commands in the Gluten C++ debugging developer doc#9368
PHILO-HE merged 7 commits intoapache:mainfrom
dmsuehir:dina/debug_cpp_doc

Conversation

@dmsuehir
Copy link
Contributor

@dmsuehir dmsuehir commented Apr 18, 2025

What changes were proposed in this pull request?

This PR fixes commands in the developer documentation for "How to debug C++":

  • Without --build_examples=ON, I get an error "/gluten/cpp/build/velox/udf/examples/libmyudf.so does not exist"
  • Without -DskipTests, I get a testRoundTrip(org.apache.gluten.fs.OnHeapFileSystemTest) failure
  • The generated-native-benchmark folders in the docs are outdated. They were changed here, where you can see that the references to example_lineitem, example_orders, and example.json were removed.
  • generic_benchmark does not have default values for the json plan or input files, so they must be specified.

Fixes issue #9369

How was this patch tested?

Manually tested commands from the doc.

Signed-off-by: Dina Suehiro Jones <dina.s.jones@intel.com>
@github-actions github-actions bot added the DOCS label Apr 18, 2025
@github-actions
Copy link

Thanks for opening a pull request!

Could you open an issue for this pull request on Github Issues?

https://github.com/apache/incubator-gluten/issues

Then could you also rename commit message and pull request title in the following format?

[GLUTEN-${ISSUES_ID}][COMPONENT]feat/fix: ${detailed message}

See also:

@dmsuehir dmsuehir changed the title Update Gluten C++ debugging developer documentation [DOC] Update Gluten C++ debugging developer documentation Apr 18, 2025
@dmsuehir dmsuehir changed the title [DOC] Update Gluten C++ debugging developer documentation [GLUTEN-9369][DOC] Update Gluten C++ debugging developer documentation Apr 18, 2025
@github-actions
Copy link

#9369

@dmsuehir dmsuehir changed the title [GLUTEN-9369][DOC] Update Gluten C++ debugging developer documentation [GLUTEN-9369][DOC] Fix commands in the Gluten C++ debugging developer doc Apr 18, 2025
Copy link
Member

@PHILO-HE PHILO-HE left a comment

Choose a reason for hiding this comment

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

Thanks for your fix!

```
cd ${GLUTEN_HOME}
mvn clean package -Pspark-3.2 -Pbackends-velox -Pceleborn -Puniffle
mvn clean package -Pspark-3.2 -Pbackends-velox -Pceleborn -Puniffle -DskipTests
Copy link
Member

Choose a reason for hiding this comment

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

We can remove the above command, and just keep the below mvn test command.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

cd ${GLUTEN_HOME}
mvn clean package -Pspark-3.2 -Pbackends-velox -Pceleborn -Puniffle
mvn clean package -Pspark-3.2 -Pbackends-velox -Pceleborn -Puniffle -DskipTests
mvn test -Pspark-3.2 -Pbackends-velox -Pceleborn -pl backends-velox \
Copy link
Member

Choose a reason for hiding this comment

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

Please help remove -Pbackends-velox -Pceleborn as they are not required here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@PHILO-HE Thank you for the review. I was able to remove -Pceleborn, but if I remove -Pbackends-velox, I get the following error:

[ERROR] [ERROR] Could not find the selected project in the reactor: backends-velox @ 

Copy link
Member

Choose a reason for hiding this comment

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

@dmsuehir, sorry for my wrong comment. -Pbackends-velox must be kept. We can remove -Pceleborn -Puniffle.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, thanks. I pushed another update. Let me know if that looks ok.

Copy link
Member

@PHILO-HE PHILO-HE left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks for your fix!

@PHILO-HE PHILO-HE merged commit 231a9ac into apache:main Apr 22, 2025
4 checks passed
weiting-chen pushed a commit to weiting-chen/gluten that referenced this pull request Apr 26, 2025
PHILO-HE added a commit that referenced this pull request Apr 29, 2025
* [GLUTEN-9199][VL] Fix error when creating shuffle file: open with O_CREAT or O_TMPFILE in second argument needs 3 arguments (#9200)

* [DOC] Fix broken links in documents (#9320)

* [GLUTEN-9369][DOC] Fix commands in the Gluten C++ debugging developer doc (#9368)

* [VL][CI] Change to use JDK-17 for Spark 3.3/3.4/3.5 tests (#9209)

* [VL][CI] Bump to use ubuntu-22.04 runner (#9262)

---------

Co-authored-by: Hongze Zhang <hongze.zzz123@gmail.com>
Co-authored-by: PHILO-HE <philo@apache.org>
Co-authored-by: Dina Suehiro Jones <dina.s.jones@intel.com>
Co-authored-by: Yuan <yuanzhou@apache.org>
@dmsuehir dmsuehir deleted the dina/debug_cpp_doc branch April 29, 2025 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants