DOC-450: patches support in mutations#425
Merged
rahav-priv merged 4 commits intomasterfrom Aug 10, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for patch file support in manual mutations, expanding the existing functionality to support diff patches in addition to complete file replacements.
- Updated the
mutants_locationdescription to clarify that patches are now supported alongside complete files - Added detailed explanation of patch file requirements and creation process
- Included example command for creating patches using the
diffcommand
docs/gambit/mutation-verifier.md
Outdated
| - `mutants_location`: A relative path to a directory from the current working directory. This directory contains files and patches that will be tested in place of the mutated file. All files in the directory will undergo testing. Patches must end with `.patch` and must comply with the `diff` shell command. Patches can be created by calling `diff -u original_file mutated_file > matuant1.patch`, where `original_file` is the file to mutate and `mutated_file` is the file with the mutation. | ||
| The patch will be applied to the original file before running the prover on the mutant . | ||
|
|
||
| Patches |
There was a problem hiding this comment.
This line appears to be incomplete or orphaned. It contains only the word 'Patches' followed by a space, which seems like an unfinished thought or accidental text that should be removed.
urikirsh
approved these changes
Aug 3, 2025
docs/gambit/mutation-verifier.md
Outdated
| Each manual mutation object must contain two keys: | ||
| - `file_to_mutate`: A file path relative to the current working directory of the file we wish to replace with the mutations | ||
| - `mutants_location`: A relative path to a directory from the current working directory. This directory contains files that will be tested in place of the mutated file. All .sol files in the directory will undergo testing. | ||
| - `mutants_location`: A relative path to a directory from the current working directory. This directory contains files and patches that will be tested in place of the mutated file. All files in the directory will undergo testing. Patches must end with `.patch` and must comply with the `diff` shell command. Patches can be created by calling `diff -u original_file mutated_file > matuant1.patch`, where `original_file` is the file to mutate and `mutated_file` is the file with the mutation. |
Contributor
There was a problem hiding this comment.
It's better to use code tags, since they look nicer and have a copy button (triple quotes):
`sh
diff -u original_file mutated_file > matuant1.patch
`
Contributor
There was a problem hiding this comment.
Also copilot is right here
urikirsh
approved these changes
Aug 7, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Naming convention:
Before requesting review:
spelling_wordlist.txtREADME.mdfor information about style and markdown syntaxJira ticket: TODO
Link to generated documentation: TODO