nealrichardson commented on a change in pull request #8235: URL: https://github.com/apache/arrow/pull/8235#discussion_r492820728
########## File path: r/README.md ########## @@ -102,6 +102,43 @@ elsewhere, you’ll need to build it from source too. First, install the C++ library. See the [developer guide](https://arrow.apache.org/docs/developers/cpp/building.html) for details. +It's recommended to make a `build` directory inside of the `cpp` directory of +the Arrow git repository (it is git-ignored). Assuming you are inside `cpp/build`, +you'll first call `cmake` to configure the build and then `make install`. +For the R package, you'll need to enable several features in the C++ library +using `-D` flags: + +``` +cmake + -DARROW_COMPUTE=ON \ + -DARROW_CSV=ON \ + -DARROW_DATASET=ON \ + -DARROW_FILESYSTEM=ON \ + -DARROW_JEMALLOC=ON \ + -DARROW_JSON=ON \ + -DARROW_PARQUET=ON \ + -DCMAKE_BUILD_TYPE=release \ + .. +``` + +where `..` is the path to the `cpp/` directory when you're in `cpp/build`. + +If you want to enable support for compression libraries, add some or all of these: + +``` + -DARROW_WITH_BROTLI=ON \ + -DARROW_WITH_BZ2=ON \ + -DARROW_WITH_LZ4=ON \ + -DARROW_WITH_SNAPPY=ON \ + -DARROW_WITH_ZLIB=ON \ + -DARROW_WITH_ZSTD=ON \ +``` + +Other flags that may be useful: + +* `-DARROW_EXTRA_ERROR_CONTEXT=ON` makes errors coming from the C++ library point to files and line numbers Review comment: This is in the instructions for developers. Regular users shouldn't ever have to mess with cmake flags ########## File path: r/README.md ########## @@ -102,6 +102,43 @@ elsewhere, you’ll need to build it from source too. First, install the C++ library. See the [developer guide](https://arrow.apache.org/docs/developers/cpp/building.html) for details. +It's recommended to make a `build` directory inside of the `cpp` directory of +the Arrow git repository (it is git-ignored). Assuming you are inside `cpp/build`, +you'll first call `cmake` to configure the build and then `make install`. Review comment: I guess I could change it to `cmake --build . --target install`? I'm kinda assuming that if you know how to change the cmake generator then you also know how to invoke it. ---------------------------------------------------------------- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
