Skip to content

Commit 5615aad

Browse files
committed
Add information about the verbose option in .bazelrc
1 parent 45e12a9 commit 5615aad

1 file changed

Lines changed: 26 additions & 5 deletions

File tree

docs/bazel.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,16 @@ requires the circuit file to be specified both on the command line and in the
1616
bazel run --config=avx --config=openmp apps:qsim_base -- -c circuits/circuit_q24
1717
```
1818

19-
## Build configs
19+
## Build configurations
2020

2121
Depending on the optimizers available on your machine, different config flags
2222
(such as `--config=avx`, above) can be set to control which optimizers are
2323
included in a given build or test run.
2424

25-
Vector arithmetic optimizers (pick one at most):
25+
### Vector arithmetic optimizers
26+
27+
Pick at most one of the following options:
28+
2629
```
2730
# Use AVX instructions for vector arithmetic.
2831
--config=avx
@@ -34,7 +37,10 @@ Vector arithmetic optimizers (pick one at most):
3437
--config=basic
3538
```
3639

37-
Parallelism optimizers (pick one at most):
40+
### Parallelism optimizers
41+
42+
Pick at most one of the following options:
43+
3844
```
3945
# Use OpenMP to run operations in parallel when possible.
4046
--config=openmp
@@ -43,11 +49,26 @@ Parallelism optimizers (pick one at most):
4349
--config=nopenmp
4450
```
4551

46-
Memory allocation (pick one at most):
52+
### Memory allocators
53+
54+
55+
[TCMalloc](https://github.com/google/tcmalloc) is a fast, multithreaded
56+
implementation of C's `malloc()` and C++'s `new` operator. It is an independent
57+
open-source library developd by Google. TCMalloc can be used with qsim as an
58+
alternative to the default `malloc()`. Pick at most one of the following
59+
options:
60+
4761
```
48-
# Use tcmalloc for memory allocation.
62+
# Use TCMalloc for memory allocation.
4963
--config=tcmalloc
5064
5165
# Use malloc for memory allocation (default).
5266
--config=malloc
5367
```
68+
69+
### Additional configuration options
70+
71+
To provide more information when building and testing qsim, you can add the
72+
configuration option `--config=verbose` to any of the `bazel` commands above.
73+
74+
Other configuration options are described elsewhere in the qsim documentation.

0 commit comments

Comments
 (0)