cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs/contributing.rst: Don't use the default Solidity highlighting for shell and text snippets

Browse Source
This commit is contained in:
Kamil Śliwak 2021-05-20 21:00:44 +02:00
parent da40011d8c
commit b7bbf6bd07
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/contributing.rst
View File

@ -263,7 +263,7 @@ We mainly use `AFL <https://lcamtuf.coredump.cx/afl/>`_ for fuzzing. You need to
install the AFL packages from your repositories (afl, afl-clang) or build them manually. install the AFL packages from your repositories (afl, afl-clang) or build them manually.
Next, build Solidity (or just the ``solfuzzer`` binary) with AFL as your compiler: Next, build Solidity (or just the ``solfuzzer`` binary) with AFL as your compiler:
:: .. code-block:: shell
cd build cd build
# if needed # if needed
@ -273,7 +273,7 @@ Next, build Solidity (or just the ``solfuzzer`` binary) with AFL as your compile
At this stage you should be able to see a message similar to the following: At this stage you should be able to see a message similar to the following:
:: .. code-block:: text
Scanning dependencies of target solfuzzer Scanning dependencies of target solfuzzer
[ 98%] Building CXX object test/tools/CMakeFiles/solfuzzer.dir/fuzzer.cpp.o [ 98%] Building CXX object test/tools/CMakeFiles/solfuzzer.dir/fuzzer.cpp.o
@ -284,7 +284,7 @@ At this stage you should be able to see a message similar to the following:
If the instrumentation messages did not appear, try switching the cmake flags pointing to AFL's clang binaries: If the instrumentation messages did not appear, try switching the cmake flags pointing to AFL's clang binaries:
:: .. code-block:: shell
# if previously failed # if previously failed
make clean make clean
@ -293,7 +293,7 @@ If the instrumentation messages did not appear, try switching the cmake flags po
Otherwise, upon execution the fuzzer halts with an error saying binary is not instrumented: Otherwise, upon execution the fuzzer halts with an error saying binary is not instrumented:
:: .. code-block:: text
afl-fuzz 2.52b by <lcamtuf@google.com> afl-fuzz 2.52b by <lcamtuf@google.com>
... (truncated messages) ... (truncated messages)
@ -317,7 +317,7 @@ Next, you need some example source files. This makes it much easier for the fuzz
to find errors. You can either copy some files from the syntax tests or extract test files to find errors. You can either copy some files from the syntax tests or extract test files
from the documentation or the other tests: from the documentation or the other tests:
:: .. code-block:: shell
mkdir /tmp/test_cases mkdir /tmp/test_cases
cd /tmp/test_cases cd /tmp/test_cases
@ -334,7 +334,7 @@ that result in similar behaviour of the binary.
Now run the fuzzer (the ``-m`` extends the size of memory to 60 MB): Now run the fuzzer (the ``-m`` extends the size of memory to 60 MB):
:: .. code-block:: shell
afl-fuzz -m 60 -i /tmp/test_cases -o /tmp/fuzzer_reports -- /path/to/solfuzzer afl-fuzz -m 60 -i /tmp/test_cases -o /tmp/fuzzer_reports -- /path/to/solfuzzer