You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "llama90 (via GitHub)" <gi...@apache.org> on 2024/01/02 16:15:47 UTC

[PR] GH-39427: [GLib] Update script and documentation [arrow]

llama90 opened a new pull request, #39428:
URL: https://github.com/apache/arrow/pull/39428

   <!--
   Thanks for opening a pull request!
   If this is your first pull request you can find detailed information on how 
   to contribute here:
     * [New Contributor's Guide](https://arrow.apache.org/docs/dev/developers/guide/step_by_step/pr_lifecycle.html#reviews-and-merge-of-the-pull-request)
     * [Contributing Overview](https://arrow.apache.org/docs/dev/developers/overview.html)
   
   
   If this is not a [minor PR](https://github.com/apache/arrow/blob/main/CONTRIBUTING.md#Minor-Fixes). Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose
   
   Opening GitHub issues ahead of time contributes to the [Openness](http://theapacheway.com/open/#:~:text=Openness%20allows%20new%20users%20the,must%20happen%20in%20the%20open.) of the Apache Arrow project.
   
   Then could you also rename the pull request title in the following format?
   
       GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
   
   or
   
       MINOR: [${COMPONENT}] ${SUMMARY}
   
   In the case of PARQUET issues on JIRA the title also supports:
   
       PARQUET-${JIRA_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
   
   -->
   
   ### Rationale for this change
   
   Modify scripts and update documentation for building GLib and running test code in a Mac environment.
   
   <!--
    Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
    Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.  
   -->
   
   ### What changes are included in this PR?
   
   * Update Documentation (`c_glib/README.md`)
   * Update Script (`c_glib/test/run-test.sh`)
   
   <!--
   There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
   -->
   
   ### Are these changes tested?
   
   Yes.
   
   <!--
   We typically require tests for all PRs in order to:
   1. Prevent the code from being accidentally broken by subsequent changes
   2. Serve as another way to document the expected behavior of the code
   
   If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
   -->
   
   ### Are there any user-facing changes?
   
   Yes.
   
   <!--
   If there are user-facing changes then we may require documentation to be updated before approving the PR.
   -->
   
   <!--
   If there are any breaking changes to public APIs, please uncomment the line below and explain which changes are breaking.
   -->
   <!-- **This PR includes breaking changes to public APIs.** -->
   
   <!--
   Please uncomment the line below (and provide explanation) if the changes fix either (a) a security vulnerability, (b) a bug that caused incorrect or invalid data to be produced, or (c) a bug that causes a crash (even when the API contract is upheld). We use this to highlight fixes to issues that may affect users without their knowledge. For this reason, fixing bugs that cause errors don't count, since those are usually obvious.
   -->
   <!-- **This PR contains a "Critical Fix".** -->


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] GH-39427: [GLib] Update script and documentation [arrow]

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on code in PR #39428:
URL: https://github.com/apache/arrow/pull/39428#discussion_r1448493363


##########
c_glib/README.md:
##########
@@ -142,6 +142,17 @@ $ meson compile -C c_glib.build
 $ sudo meson install -C c_glib.build
 ```
 
+> [!WARNING]
+>
+> When building Arrow GLib, it typically uses the Arrow C++ installed via Homebrew. However, this can lead to build failures
+> if there are mismatches between the changes in Arrow's GLib and C++ libraries. To resolve this, you may need to
+> reference the Arrow C++ library built locally. In such cases, use the `-Darrow_cpp_build_dir`
+> and `-Darrow_cpp_build_type` options with the `meson setup` command to explicitly specify the library path.

Review Comment:
   Could you update the last sentence for the latest command line?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] GH-39427: [GLib] Update script and documentation [arrow]

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on code in PR #39428:
URL: https://github.com/apache/arrow/pull/39428#discussion_r1448896013


##########
c_glib/README.md:
##########
@@ -142,6 +142,17 @@ $ meson compile -C c_glib.build
 $ sudo meson install -C c_glib.build
 ```
 
+> [!WARNING]
+>
+> When building Arrow GLib, it typically uses the Arrow C++ installed via Homebrew. However, this can lead to build failures
+> if there are mismatches between the changes in Arrow's GLib and C++ libraries. To resolve this, you may need to
+> reference the Arrow C++ library built locally. In such cases, use the `--cmake-prefix-path` option with the `meson setup` 
+> command to explicitly specify the library path.
+>
+> ```bash
+> meson setup c_glib.build c_glib --cmake-prefix-path=${arrow_cpp_install_prefix} -Dgtk_doc=true

Review Comment:
   ```suggestion
   > ```console
   > $ meson setup c_glib.build c_glib --cmake-prefix-path=${arrow_cpp_install_prefix} -Dgtk_doc=true
   ```



##########
c_glib/README.md:
##########
@@ -231,9 +242,18 @@ Now, you can run unit tests by the followings:
 
 ```console
 $ cd c_glib.build
-$ bundle exec ../c_glib/test/run-test.sh
+$ BUNDLE_GEMFILE=../c_glib/Gemfile bundle exec ../c_glib/test/run-test.sh
 ```
 
+
+> [!NOTE]
+>
+> If debugging is necessary, you can proceed using the `DEBUGGER` option as follows:
+>
+> ```bash

Review Comment:
   ```suggestion
   > ```console
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] GH-39427: [GLib] Update script and documentation [arrow]

Posted by "conbench-apache-arrow[bot] (via GitHub)" <gi...@apache.org>.
conbench-apache-arrow[bot] commented on PR #39428:
URL: https://github.com/apache/arrow/pull/39428#issuecomment-1888470663

   After merging your PR, Conbench analyzed the 6 benchmarking runs that have been run so far on merge-commit 04afe3f017668d7fbd74301717ce467394e216d7.
   
   There was 1 benchmark result indicating a performance regression:
   
   - Commit Run on `ursa-i9-9960x` at [2024-01-11 20:23:56Z](https://conbench.ursa.dev/compare/runs/2e86c20eb72e4fc5840fe7cdbe0ec530...e55e0ba1079b46edb665058558878fcd/)
     - [`dataframe-to-table` (Python) with dataset=type_floats](https://conbench.ursa.dev/compare/benchmarks/0659ffc8b2da76058000c329d2e67157...065a04f274f7719c80005943d8b18ad7)
   
   The [full Conbench report](https://github.com/apache/arrow/runs/20413508693) has more details. It also includes information about 2 possible false positives for unstable benchmarks that are known to sometimes produce them.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] GH-39427: [GLib] Update script and documentation [arrow]

Posted by "llama90 (via GitHub)" <gi...@apache.org>.
llama90 commented on PR #39428:
URL: https://github.com/apache/arrow/pull/39428#issuecomment-1886627938

   Hello. I have made all the revisions based on your comments. Thank you for the review.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] GH-39427: [GLib] Update script and documentation [arrow]

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou commented on code in PR #39428:
URL: https://github.com/apache/arrow/pull/39428#discussion_r1448456801


##########
c_glib/README.md:
##########
@@ -142,6 +142,18 @@ $ meson compile -C c_glib.build
 $ sudo meson install -C c_glib.build
 ```
 
+> [!WARNING]
+>
+> When building GLib, it typically uses the Arrow library installed via brew. However, this can lead to build failures
+> if there are mismatches between the changes in Arrow's GLib and CPP libraries. To resolve this, you may need to
+> reference the Arrow CPP library built locally. In such cases, use the `-Darrow_cpp_build_dir`
+> and `-Darrow_cpp_build_type` options with the `meson setup` command to explicitly specify the library path.
+>
+> ```bash
+> meson setup c_glib.build c_glib -Dgtk_doc=true \
+>   -Darrow_cpp_build_dir=${arrow_cpp_build_dir} \
+>   -Darrow_cpp_build_type=${arrow_cpp_build_type}

Review Comment:
   How about using `--cmake-prefix-path` instead?
   
   ```bash
   meson setup c_glib.build c_glib --cmake-prefix-path=${arrow_cpp_install_prefix} -Dgtk_doc=true
   ```
   
   Note that Apache Arrow C++ must be installed. (Executing only `cmake --build` doesn't work. Executing `cmake --install` is needed.)



##########
c_glib/README.md:
##########
@@ -142,6 +142,18 @@ $ meson compile -C c_glib.build
 $ sudo meson install -C c_glib.build
 ```
 
+> [!WARNING]
+>
+> When building GLib, it typically uses the Arrow library installed via brew. However, this can lead to build failures
+> if there are mismatches between the changes in Arrow's GLib and CPP libraries. To resolve this, you may need to
+> reference the Arrow CPP library built locally. In such cases, use the `-Darrow_cpp_build_dir`
+> and `-Darrow_cpp_build_type` options with the `meson setup` command to explicitly specify the library path.
+>
+> ```bash
+> meson setup c_glib.build c_glib -Dgtk_doc=true \
+>   -Darrow_cpp_build_dir=${arrow_cpp_build_dir} \
+>   -Darrow_cpp_build_type=${arrow_cpp_build_type}

Review Comment:
   ```suggestion
   >   -Darrow_cpp_build_type=${arrow_cpp_build_type}
   > ```
   ```



##########
c_glib/README.md:
##########
@@ -142,6 +142,18 @@ $ meson compile -C c_glib.build
 $ sudo meson install -C c_glib.build
 ```
 
+> [!WARNING]
+>
+> When building GLib, it typically uses the Arrow library installed via brew. However, this can lead to build failures
+> if there are mismatches between the changes in Arrow's GLib and CPP libraries. To resolve this, you may need to
+> reference the Arrow CPP library built locally. In such cases, use the `-Darrow_cpp_build_dir`

Review Comment:
   ```suggestion
   > When building Arrow GLib, it typically uses the Arrow C++ installed via Homebrew. However, this can lead to build failures
   > if there are mismatches between the changes in Arrow's GLib and C++ libraries. To resolve this, you may need to
   > reference the Arrow C++ library built locally. In such cases, use the `-Darrow_cpp_build_dir`
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] GH-39427: [GLib] Update script and documentation [arrow]

Posted by "kou (via GitHub)" <gi...@apache.org>.
kou merged PR #39428:
URL: https://github.com/apache/arrow/pull/39428


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] GH-39427: [GLib] Update script and documentation [arrow]

Posted by "llama90 (via GitHub)" <gi...@apache.org>.
llama90 commented on PR #39428:
URL: https://github.com/apache/arrow/pull/39428#issuecomment-1886362462

   Hello @kou 
   
   I have updated the document regarding the issues I experienced while building GLib. I would appreciate it if you could review it when you have time.
   
   Thank you always.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] GH-39427: [GLib] Update script and documentation [arrow]

Posted by "llama90 (via GitHub)" <gi...@apache.org>.
llama90 commented on code in PR #39428:
URL: https://github.com/apache/arrow/pull/39428#discussion_r1448525120


##########
c_glib/README.md:
##########
@@ -142,6 +142,17 @@ $ meson compile -C c_glib.build
 $ sudo meson install -C c_glib.build
 ```
 
+> [!WARNING]
+>
+> When building Arrow GLib, it typically uses the Arrow C++ installed via Homebrew. However, this can lead to build failures
+> if there are mismatches between the changes in Arrow's GLib and C++ libraries. To resolve this, you may need to
+> reference the Arrow C++ library built locally. In such cases, use the `-Darrow_cpp_build_dir`
+> and `-Darrow_cpp_build_type` options with the `meson setup` command to explicitly specify the library path.

Review Comment:
   I fixed it. I was inconsiderate.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] GH-39427: [GLib] Update script and documentation [arrow]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #39428:
URL: https://github.com/apache/arrow/pull/39428#issuecomment-1874236040

   :warning: GitHub issue #39427 **has been automatically assigned in GitHub** to PR creator.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org