ARROW-14039: [C++][Docs] Indicate memory requirements for building #11205
Conversation
|
|
bkmgit
changed the title
| @@ -124,7 +124,7 @@ argument is omitted then a release build will be produced. | |||
| You need to more options to build on Windows. See | |||
| :ref:`developers-cpp-windows` for details. | |||
|
|
|||
| Minimal release build: | |||
| Minimal release build (1Gb of RAM for building or more recommended): | |||
There was a problem hiding this comment.
How did you arrived at these estimates?
There was a problem hiding this comment.
There is a discussion on JIRA, estimates arrived at by measuring when doing compilation. It is suggested to just have an estimate of 4GB.
| @@ -135,7 +135,7 @@ Minimal release build: | |||
| cmake .. | |||
| make | |||
|
|
|||
| Minimal debug build with unit tests: | |||
| Minimal debug build with unit tests (4Gb of RAM for building or more recommended): | |||
There was a problem hiding this comment.
I think you are referring to bytes (GB) and not bits (Gb).
Indicate minimum RAM requirements, Full Ubuntu docker build fails if less than 8GB of RAM. Minimal and minimal debug build estimates based on measurements.
There was a problem hiding this comment.
As mentioned in the JIRA I don't love listing 1GB because that's really a specialized machine at this point and you'd be better off cross compiling on a larger system. In other words, if we started requiring 1.2GB of RAM for some minimal builds (maybe a certain version of gcc or clang) then:
- I doubt we'd detect that
- I wouldn't want to do too much to fix that if there was no obvious fix
However, this message is better than nothing so I won't stand in the way. @pitrou any concerns? Otherwise I'll merge this tomorrow.
|
Fair enough. |
| @@ -41,6 +41,9 @@ Building requires: | |||
| sufficient. For Windows, at least Visual Studio 2017 is required. | |||
| * CMake 3.5 or higher | |||
| * On Linux and macOS, either ``make`` or ``ninja`` build utilities | |||
| * At least 1GB of RAM for a minimal build, 4GB for a minimal | |||
| debug build with tests and 8GB for a full build using | |||
| :ref:`docker <docker>`. | |||
There was a problem hiding this comment.
One thing that we've run into is that enabling the Unity build will frequently cause more memory to be required. https://issues.apache.org/jira/browse/ARROW-14555 is an example of that (it appears the VM had/was using 4GB when it was OOMkilled building unity). Maybe we should mention here that in ram-constrained environments that's one flag to turn off (ie. CMAKE_UNITY_BUILD=OFF)
There was a problem hiding this comment.
This is helpful. It seems that about 8GB is what is needed for most options, but that one can often use less. VM's with 1GB are significantly cheaper than VMs with 8GB
|
@jonkeane @pitrou @westonpace Can this be merged? |
|
Benchmark runs are scheduled for baseline = 911a833 and contender = 7a9738a. 7a9738a is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
No description provided.