Skip to content

Commit

Permalink
add notes about --slow flag and apple silicon
Browse files Browse the repository at this point in the history
  • Loading branch information
bennibbelink committed Oct 2, 2024
1 parent 8e5d9c0 commit c2f15f6
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 3 deletions.
15 changes: 14 additions & 1 deletion INSTALL.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,21 @@ flags:
- the cmake prefix path for use with FIND_PACKAGE, FIND_PATH, FIND_PROGRAM, or FIND_LIBRARY macros

* - ``--build-type BUILD_TYPE``
- change the CMAKE_BUILD_TYPE
- change the CMAKE_BUILD_TYPE

* - ``--data-model-version``
- sets the data model version number

* - ``--code_coverage``
- Enable code coverage analysis using gcov/lcov

* - ``--fast``
- Will try to compile from assembly, if possible (default). This is faster than compiling from source.

* - ``--slow``
- Will NOT try to compile from assembly, if possible. This is slower as it must compile from source.
**This is required to build on Apple Silicon**

* - ``-D VAR``
- set environment variable(s).

Expand Down
5 changes: 3 additions & 2 deletions install.py
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ def main():
default='Release')

parser.add_argument('--data-model-version', dest='data_model_version', default=None,
help='Sets the core version number.')
help='Sets the data model version number.')

parser.add_argument('-D', metavar='VAR', action='append',
help='Set enviornment variable(s).')
Expand All @@ -210,7 +210,8 @@ def main():
parser.add_argument('--slow', dest='fast',
action='store_false', help="Will NOT try to compile "
"from assembly, if possible. This is slower as it "
"must compile from source.")
"must compile from source. **This is required to "
"build on Apple Silicon**")

args = parser.parse_args()
# modify roots as needed
Expand Down

0 comments on commit c2f15f6

Please sign in to comment.