Skip to content

Commit

Permalink
Resolve Issue #320 (Doc config options)
Browse files Browse the repository at this point in the history
  • Loading branch information
james-d-mitchell committed Mar 1, 2021
1 parent 8c649c6 commit 4720e96
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,27 @@ If you installed GAP on several architectures, then you must execute the
configure/make step for each of the architectures. You can either do this
immediately after configuring and compiling GAP itself on this architecture, or
alternatively set the environment variable `CONFIGNAME` to the name of the
configuration you used when compiling GAPbefore running `./configure`. Note
configuration you used when compiling GAP before running `./configure`. Note
however that your compiler choice and flags (environment variables `CC` and
`CFLAGS`) need to be chosen to match the setup of the original GAP compilation.
For example, you have to specify 32-bit or 64-bit mode correctly!

Digraphs vendors `bliss` and `planarity` libraries in the `extern` directory.
### Configuration options

In addition to the usual autoconf generated configuration flags, the following
flags are provided.

Option | Meaning
-------- | -------
--enable-code-coverage | enable code coverage support
--enable-compile-warnings | enable compiler warnings
--enable-debug | enable debug mode
--with-external-bliss | use external bliss
--with-external-planarity | use external planarity
--with-gaproot | specify root of GAP installation
--without-intrinsics | do not use compiler intrinsics even if available

Digraphs vendors the `bliss` and `planarity` libraries in the `extern` directory.
If you wish to use your system copy of `bliss` or `planarity`, please use the
configure options `--with-external-bliss` or `--with-external-planarity`, as
appropriate.
Expand Down
39 changes: 39 additions & 0 deletions doc/z-chap1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,45 @@ make]]></Listing>
If you want to check that the package is working correctly, you
should run some of the tests described in Section
<Ref Sect="Testing your installation"/>.
<Subsection Label="Configuration options">
<Heading>Configuration options</Heading>

In addition to the usual autoconf generated configuration flags, the following
flags are provided.

<Table Align="|l|l|">
<Caption>Configuration flags</Caption>
<HorLine/>
<Row>
<Item>Option</Item><Item>Meaning</Item>
</Row>
<HorLine/>
<HorLine/>
<Row>
<Item>--enable-code-coverage </Item><Item> enable code coverage support</Item>
</Row>
<Row>
<Item>--enable-compile-warnings </Item><Item> enable compiler warnings</Item>
</Row>
<Row>
<Item>--enable-debug </Item><Item> enable debug mode</Item>
</Row>
<Row>
<Item>--with-external-bliss </Item><Item> use external bliss</Item>
</Row>
<Row>
<Item>--with-external-planarity </Item><Item> use external planarity</Item>
</Row>
<Row>
<Item>--with-gaproot </Item><Item> specify root of GAP installation</Item>
</Row>
<Row>
<Item>--without-intrinsics </Item><Item> do not use compiler intrinsics even if available</Item>

</Row>
<HorLine/>
</Table>
</Subsection>
</Section>

<!--**********************************************************************-->
Expand Down

0 comments on commit 4720e96

Please sign in to comment.