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.

Sign up for GitHub

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

Update documentation #1533

Closed
wants to merge 2 commits into from
Closed

Update documentation #1533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
071f98e
Update python version
DonggeLiu Oct 20, 2022
8c07672
Update ubuntu version
DonggeLiu Oct 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/developing-fuzzbench/adding_a_new_benchmark.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ Building benchmarks and fuzzers entails the following process:
image. This is the first image in this build process that is defined by the
main FuzzBench code (e.g. not fuzzers, benchmarks, or OSS-Fuzz). Its first
function is to copy the FuzzBench code and install packages needed to run
FuzzBench like Python3.7 For benchmarks that define a `commit` in their
FuzzBench like Python3.10. For benchmarks that define a `commit` in their
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am not sure if I understand this sentence:

  1. The original text said 3.7. I guess this is a legacy typo, as I thought the current FuzzBench requires 3.8 at minimum?
  2. Do we really need to install python in docker/benchmark-builder/Dockerfile? For example, I remove the python installation in docker/benchmark-builder/Dockerfile in Upgrade base images, benchmark images, and Python. #1526, and it still seems to be able to build libpng-1.2.56 with libfuzzer.

Copy link
Contributor

Choose a reason for hiding this comment

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

  1. Yes.
  2. We should so that there is a consistent python version used throughout the project.

Copy link
Contributor Author

@DonggeLiu DonggeLiu Oct 21, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

Cool, I will add back the python installation steps.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in commit Install Python3.10 in BenchmarkBuilder.

`benchmark.yaml` (i.e. OSS-Fuzz benchmarks) the build process for this image
checks out the source code of that project at the specified commit. Then the
process defines the environment variables `CC`, `CXX`, `CXXFLAGS`, `CFLAGS`
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/adding_a_new_fuzzer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ with your fuzzer. For most projects, this will look like:

```dockerfile
ARG parent_image
FROM $parent_image # Base builder image (Ubuntu 16.04, with latest Clang).
FROM $parent_image # Base builder image (Ubuntu 20.04, with latest Clang).

RUN apt-get update && \ # Install any system dependencies to build your fuzzer.
apt-get install -y pkg1 pkg2
Expand All @@ -65,7 +65,7 @@ This file defines the image that will be used to run benchmarks with your
fuzzer. Making this lightweight allows trial instances to be spun up fast.

```dockerfile
FROM gcr.io/fuzzbench/base-image # Base image (Ubuntu 16.04).
FROM gcr.io/fuzzbench/base-image # Base image (Ubuntu 20.04).

RUN apt-get update && \ # Install any runtime dependencies for your fuzzer.
apt-get install pkg1 pkg2
Expand Down
6 changes: 3 additions & 3 deletions docs/getting-started/prerequisites.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,18 +57,18 @@ sudo apt-get install build-essential

### Python programming language

[Download Python 3.8](https://www.python.org/downloads/release/python-386/),
[Download Python 3.10](https://www.python.org/downloads/release/python-3104/),
then install it.

If you already have Python installed, you can verify its version by running
`python3 --version`. The minimum required version is 3.8.
`python3 --version`. The minimum required version is 3.10.4.

### Python package dependencies

Install the python dependencies by running the following command:

```bash
sudo apt-get install python3.8-dev python3.8-venv
sudo apt-get install python3.10-dev python3.10-venv
make install-dependencies
```

Expand Down