Skip to content

Commit f8a06f7

Browse files
committed
doc: remove references to disable-asm option now that it's gone
The comment about sha256_sse4::Transform is believed to be old and stale.
1 parent 376f0f6 commit f8a06f7

File tree

2 files changed

+1
-13
lines changed

2 files changed

+1
-13
lines changed

doc/developer-notes.md

-7
Original file line numberDiff line numberDiff line change
@@ -577,13 +577,6 @@ export UBSAN_OPTIONS="suppressions=$(pwd)/test/sanitizer_suppressions/ubsan:prin
577577
See the CI config for more examples, and upstream documentation for more information
578578
about any additional options.
579579

580-
There are a number of known problems when using the `address` sanitizer. The
581-
address sanitizer is known to fail in
582-
[sha256_sse4::Transform](/src/crypto/sha256_sse4.cpp) which makes it unusable
583-
unless you also use `--disable-asm` when running configure. We would like to fix
584-
sanitizer issues, so please send pull requests if you can fix any errors found
585-
by the address sanitizer (or any other sanitizer).
586-
587580
Not all sanitizer options can be enabled at the same time, e.g. trying to build
588581
with `--with-sanitizers=address,thread` will fail in the configure script as
589582
these sanitizers are mutually incompatible. Refer to your compiler manual to

doc/fuzzing.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -127,19 +127,14 @@ The default Clang/LLVM version supplied by Apple on macOS does not include
127127
fuzzing libraries, so macOS users will need to install a full version, for
128128
example using `brew install llvm`.
129129
130-
Should you run into problems with the address sanitizer, it is possible you
131-
may need to run `./configure` with `--disable-asm` to avoid errors
132-
with certain assembly code from Bitcoin Core's code. See [developer notes on sanitizers](https://github.com/bitcoin/bitcoin/blob/master/doc/developer-notes.md#sanitizers)
133-
for more information.
134-
135130
You may also need to take care of giving the correct path for `clang` and
136131
`clang++`, like `CC=/path/to/clang CXX=/path/to/clang++` if the non-systems
137132
`clang` does not come first in your path.
138133
139134
Full configure that was tested on macOS with `brew` installed `llvm`:
140135
141136
```sh
142-
./configure --enable-fuzz --with-sanitizers=fuzzer,address,undefined --disable-asm CC=$(brew --prefix llvm)/bin/clang CXX=$(brew --prefix llvm)/bin/clang++
137+
./configure --enable-fuzz --with-sanitizers=fuzzer,address,undefined CC=$(brew --prefix llvm)/bin/clang CXX=$(brew --prefix llvm)/bin/clang++
143138
```
144139
145140
Read the [libFuzzer documentation](https://llvm.org/docs/LibFuzzer.html) for more information. This [libFuzzer tutorial](https://github.com/google/fuzzing/blob/master/tutorial/libFuzzerTutorial.md) might also be of interest.

0 commit comments

Comments
 (0)