Skip to content

Commit

Permalink
Fix broken links to tinyxml2.yaml in docs (#763)
Browse files Browse the repository at this point in the history
Found a few 404 as the project was removed from the comparison benchmark
  • Loading branch information
vwvw authored Jan 16, 2025
1 parent 9472a76 commit 89f999d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ To generate and evaluate the fuzz targets in a benchmark set via *local* experim
[--work-dir=results-dir]
[...]
# E.g., generate fuzz targets for TinyXML-2 with default template and fuzz for 30 seconds.
# ./run_all_experiments.py -y ./benchmark-sets/comparison/tinyxml2.yaml
# ./run_all_experiments.py -y ./benchmark-sets/all/tinyxml2.yaml
```
where the `<model-name>` must be the name of one of the supported models. The
list of models supported by OSS-Fuzz-gen expands on a regular basis, and all
Expand Down Expand Up @@ -188,7 +188,7 @@ Configure and use framework in the following steps:
### Configure Benchmark
Prepare a [benchmark YAML](data_prep/README.md#Benchmark-YAML) that specifies
the function to test, here is
[an example](benchmark-sets/comparison/tinyxml2.yaml). Follow the link above
[an example](benchmark-sets/all/tinyxml2.yaml). Follow the link above
to automatically generate one for a `C`/`C++` project in `OSS-Fuzz`. Note that
the project under test needs to be integrated into `OSS-Fuzz` to build.

Expand Down
2 changes: 1 addition & 1 deletion data_prep/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This directory help you prepare three kinds of data to benefit fuzz target gener

## Benchmark YAML
A benchmark YAML file (e.g.,
[`tinyxml2.yaml`](../benchmark-sets/comparison/tinyxml2.yaml)) is required
[`tinyxml2.yaml`](../benchmark-sets/all/tinyxml2.yaml)) is required
for fuzz target generation, it specifies `functions`, `project`, `target_path`,
and optionally `target_name`:
* `functions` lists the signatures of the function to generate fuzz targets.
Expand Down

0 comments on commit 89f999d

Please sign in to comment.