[Python][Documentation] Build docs don't suggest assigning $ARROW_BUILD_TYPE

[asfimport]

Build documentation is great. However it does not explicitly suggest assigning a value to ARROW_BUILD_TYPE and the error thrown is not obvious:

...
 [100%] Built target _parquet
 – Finished cmake --build for pyarrow
 Bundling includes: include
 error: [Errno 2] No such file or directory: 'include'

This cost me a couple of hours to debug.

Could we include a note in build documentation suggesting devs to run:

export ARROW_BUILD_TYPE=release

Reporter: Rok Mihevc / @rok
Assignee: Joris Van den Bossche / @jorisvandenbossche
Watchers: Rok Mihevc / @rok

PRs and other links:

• GitHub Pull Request #4192

_{Note: This issue was originally created as ARROW-5165. Please see the migration documentation for further details.}

[asfimport]

Wes McKinney / @wesm:
The logging should also be made more verbose so that it is more clear what is wrong

Did you have a mix of build types, release in one part and debug in another?

[asfimport]

Rok Mihevc / @rok:
I was only building for ARROW_BUILD_TYPE=release.

If a mix of build types is a common approach, then clear logging (and perhaps failing on 

--build-type="") would perhaps be best.

[asfimport]

Joris Van den Bossche / @jorisvandenbossche:
Just ran into this as well. If you exactly follow the instructions in the docs, you indeed get that error, because ARROW_BUILD_TYPE is not set.

 

Would the best recommendation for the docs be to set it to 'release' ?

[asfimport]

Wes McKinney / @wesm:
This must be a consequence of the recent change to make "release" the default build type.

I think ARROW_BUILD_TYPE=release is a reasonable default, with the comment that debug should be used when diagnosing segfaults/core dumps. EDIT: I see there is a PR already, thanks

[asfimport]

Antoine Pitrou / @pitrou:
Issue resolved by pull request 4192
#4192