Skip to content

README.md: list common options to ./configure, expand build-from-src instructions

Karl Wette requested to merge ANU-CGA/lalsuite:README-configure-options into master

Description

This MR expands the "building from source" instructions in the top-level README.md. I've included a list of ./configure options I think are useful; I've generally excluded options which are only used by one LALSuite component/library and/or options which are quite specialised/obscure.

The top-level ./configure help doesn't list all options available, unless you run ./configure --help=recursive which is quite verbose. So documenting a subset of useful options in README.md is probably the better solution. These options should be stable enough to not change often (if at all) so hopefully the README.md should remain up-to-date.

API Changes and Justification

Backwards Compatible Changes

  • This change does not modify any class/function/struct/type definitions in a public C header file or any Python class/function definitions
  • This change adds new classes/functions/structs/types to a public C header file or Python module

Backwards Incompatible Changes

  • This change modifies an existing class/function/struct/type definition in a public C header file or Python module
  • This change removes an existing class/function/struct/type from a public C header file or Python module

Review Status

@david-keitel @adam-mercer @duncanmmacleod Thoughts?

Edited by Karl Wette

Merge request reports