Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cmake: Amend docs per feedback #316

Merged
merged 2 commits into from
Aug 10, 2024
Merged

cmake: Amend docs per feedback #316

merged 2 commits into from
Aug 10, 2024

Conversation

hebasto
Copy link
Owner

@hebasto hebasto commented Aug 9, 2024

A few amendments to the fuzzing.md:

  1. Removed non-portable $(nproc), mirrors the master branch.
  2. Removed stray back slash.
  3. Added a linker workaround for macOS.

Also a "TODO" prefix has been added to the comment.

A few amendment to fuzzing.md
1. Removed non-portable $(nproc), mirrors the master branch.
2. Removed stray back slash.
3. Added a linker workaround for macOS.
@hebasto hebasto added the documentation Docs and manuals label Aug 9, 2024
@hebasto
Copy link
Owner Author

hebasto commented Aug 9, 2024

cc @dergoegge @m3dwards @paplorinc

@@ -150,6 +150,7 @@ $ cmake -B build_fuzz \
-DCMAKE_CXX_COMPILER="$(brew --prefix llvm)/bin/clang++" \
-DBUILD_FOR_FUZZING=ON \
-DSANITIZERS=undefined,address,fuzzer \
-DAPPEND_LDFLAGS=-Wl,-no_warn_duplicate_libraries
Copy link

@fanquake fanquake Aug 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reading the thread from the other PR, it's not clear if there is an upstream issue open, or someone is going to open one. I see links to other discussions that look similar, but from what I can tell, aren't our issue.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link

@l0rinc l0rinc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, left a few comments that I'd like us to consider

doc/fuzzing.md Show resolved Hide resolved
@@ -171,9 +172,9 @@ $ cmake -B build_fuzz \
-DCMAKE_C_COMPILER="$(pwd)/AFLplusplus/afl-clang-lto" \
-DCMAKE_CXX_COMPILER="$(pwd)/AFLplusplus/afl-clang-lto++" \
-DBUILD_FOR_FUZZING=ON
$ cmake --build build_fuzz -j$(nproc)
$ cmake --build build_fuzz
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't tried these, it's possible that these might also need a -no_warn_duplicate_libraries, right?

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did not test it.

@@ -14,7 +14,7 @@ $ cmake -B build_fuzz \
-DSANITIZERS=undefined,address,fuzzer
# macOS users: If you have problem with this step then make sure to read "macOS hints for
# libFuzzer" on https://github.com/bitcoin/bitcoin/blob/master/doc/fuzzing.md#macos-hints-for-libfuzzer
$ cmake --build build_fuzz -j$(nproc)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

doc/fuzzing.md Show resolved Hide resolved
@@ -150,6 +150,7 @@ $ cmake -B build_fuzz \
-DCMAKE_CXX_COMPILER="$(brew --prefix llvm)/bin/clang++" \
-DBUILD_FOR_FUZZING=ON \
-DSANITIZERS=undefined,address,fuzzer \
-DAPPEND_LDFLAGS=-Wl,-no_warn_duplicate_libraries
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

checked, this works as well 👍

@l0rinc
Copy link

l0rinc commented Aug 9, 2024

ACK 7c37119

@hebasto hebasto merged commit 97bc580 into cmake-staging Aug 10, 2024
40 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Docs and manuals
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants