Skip to content

docs: document patch dataset source #36

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

Merged
LeiGuo622 merged 1 commit into from
May 25, 2026
Merged

docs: document patch dataset source #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,10 @@ patch_dataset_dir/
poc.sh optional; runs the bug trigger / PoC
```

Public benchmark cases are available in the OS3Lab patch dataset:
https://github.com/OS3Lab/patch_dataset. Each case directory can be used as
`patch_dataset_dir` after cloning the corresponding target project repository.

If a script is absent, RetroPatch treats that validation stage as passed.

3. Copy and edit the example configuration.
Expand Down
4 changes: 4 additions & 0 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,10 @@ patch_dataset_dir/
poc.sh 可选；运行 bug 触发脚本 / PoC
```

公开 benchmark 案例可从 OS3Lab patch dataset 获取：
https://github.com/OS3Lab/patch_dataset。克隆对应目标项目仓库后，其中每个
case 目录都可以作为 `patch_dataset_dir` 使用。

如果某个脚本不存在，RetroPatch 会将对应验证阶段视为通过。

3. 复制并编辑示例配置。
Expand Down
3 changes: 3 additions & 0 deletions docs/config-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ If either path does not end with `/`, the loader appends `/` internally. This me

Both directories must already exist. The loader exits if either is missing.

Public benchmark case directories can be cloned from
https://github.com/OS3Lab/patch_dataset and used as `patch_dataset_dir` values.

## Commit Rules

The loader verifies these values against `project_dir`:
Expand Down
Loading