[GitHub] [arrow] thisisnic commented on a change in pull request #11521: ARROW-13398: [R] Update install.Rmd vignette

[GitBox <gi...@apache.org>]

thisisnic commented on a change in pull request #11521:
URL: https://github.com/apache/arrow/pull/11521#discussion_r760968708



##########
File path: r/vignettes/install.Rmd
##########
@@ -379,63 +312,86 @@ setting `ARROW_WITH_ZSTD=OFF` to build without `zstd`; or (3) uninstalling
 the conflicting `zstd`.
 See discussion [here](https://issues.apache.org/jira/browse/ARROW-8556).
 
-## Summary of build environment variables
-
-Some features are optional when you build Arrow from source. With the exception of `ARROW_S3`, these are all `ON` by default in the bundled C++ build, but you can set them to `OFF` to disable them.
-
-* `ARROW_S3`: If set to `ON` S3 support will be built as long as the
-  dependencies are met; if they are not met, the build script will turn this `OFF`
-* `ARROW_JEMALLOC` for the `jemalloc` memory allocator
-* `ARROW_MIMALLOC` for the `mimalloc` memmory allocator
-* `ARROW_PARQUET`
-* `ARROW_DATASET`
-* `ARROW_JSON` for the JSON parsing library
-* `ARROW_WITH_RE2` for the RE2 regular expression library, used in some string compute functions
-* `ARROW_WITH_UTF8PROC` for the UTF8Proc string library, used in many other string compute functions
-* `ARROW_JSON` for JSON parsing
-* `ARROW_WITH_BROTLI`, `ARROW_WITH_BZ2`, `ARROW_WITH_LZ4`, `ARROW_WITH_SNAPPY`, `ARROW_WITH_ZLIB`, and `ARROW_WITH_ZSTD` for various compression algorithms
-
-
-There are a number of other variables that affect the `configure` script and the bundled build script.
-By default, these are all unset. All boolean variables are case-insensitive.
-
-* `ARROW_USE_PKG_CONFIG`: If set to `false`, the configure script
-  won't look for Arrow libraries on your system and instead will look to download/build them.
-  Use this if you have a version mismatch between installed system libraries
-  and the version of the R package you're installing.
-* `LIBARROW_BINARY`: If set to `true`, the script will try to download a binary
-  C++ library built for your operating system.
-  You may also set it to some other string,
-  a related "distro-version" that has binaries built that work for your OS.
-  If no binary is found, installation will fall back to building C++
-  dependencies from source.
-* `LIBARROW_BUILD`: If set to `false`, the build script
+# Summary of build environment variables
+
+## libarrow configuration
+
+Some features are optional when you build Arrow from source - you can configure
+whether these components are built via the use of environment variables.  The 
+names of the environment variables which control these features and their 
+default values are shown below.
+
+| Name  | Description   | Default Value |
+| ---| --- | :-: |
+| `ARROW_S3`          | S3 support (if dependencies are met)*   | `OFF` |
+| `ARROW_JEMALLOC`    | The `jemalloc` memory allocator        | `ON` |
+| `ARROW_MIMALLOC`    | The `mimalloc` memory allocator        | `ON` |
+| `ARROW_PARQUET`    |   | `ON` |
+| `ARROW_DATASET`    |  | `ON` |
+| `ARROW_JSON`    | The JSON parsing library | `ON` |
+| `ARROW_WITH_RE2`    | The RE2 regular expression library, used in some string compute functions | `ON` |
+| `ARROW_WITH_UTF8PROC` | The UTF8Proc string library, used in many other string compute functions  | `ON` |
+| `ARROW_WITH_BROTLI`  | Compression algorithm  | `ON` |
+| `ARROW_WITH_BZ2`    | Compression algorithm  | `ON` |
+| `ARROW_WITH_LZ4`    | Compression algorithm  | `ON` |
+| `ARROW_WITH_SNAPPY`    | Compression algorithm  | `ON` |
+| `ARROW_WITH_ZLIB`    | Compression algorithm | `ON` |
+| `ARROW_WITH_ZSTD`    | Compression algorithm | `ON` |
+
+## R package configuration
+
+There are a number of other variables that affect the `configure` script and 
+the bundled build script.  All boolean variables are case-insensitive.
+
+| Name | Description | Default |
+| --- | --- | :-: |
+| `ARROW_USE_PKG_CONFIG` | Use `pkg-config` to search for `libarrow` install | `true` |
+| `LIBARROW_BUILD` | Allow building from source | `true` |
+| `LIBARROW_BINARY` | Try to install `libarrow` binary instead of building from source | `true` |
+| `LIBARROW_MINIMAL` | Build with minimal features enabled | (unset) |
+| `NOT_CRAN` | Set `LIBARROW_BINARY=true` and `LIBARROW_MINIMAL=false` | `false` |
+| `ARROW_R_DEV` | More verbose messaging and regenerates some code | `false` |
+| `LIBARROW_DEBUG_DIR` | Directory to save source build logs | (unset) |
+| `CMAKE` | Alternative CMake path | (unset) |
+
+See below for more in-depth explanations of these environment variables.
+
+* `ARROW_USE_PKG_CONFIG`: If set to `false`, the configure script won't look for 
+Arrow libraries on your system and instead will look to download/build them.
+  Use this if you have a version mismatch between installed system libraries and
+  the version of the R package you're installing.

Review comment:
       Hmm...how about I just remove it entirely from this section then?




-- 
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