-
-
Notifications
You must be signed in to change notification settings - Fork 710
Merging changes after introduction of formatting guidelines
If you forked and modified Soot before the introduction of our coding-style guidelines, you might want to take this in to account before merging:
Git should be able to automatically merge all formatting changes to files that weren't touched in your version of Soot's codebase. Also, files with small changes should be easy to merge. However, if you made huge changes to some files, it might make more sense to throw away the remote files, keep your own versions and apply the auto formatting to your files afterward.
Note:
<remote>
denotes the git remote pointing to this repository. If you just cloned our repository,<remote>
will most likely beorigin
.
- Pull the commit previous to our formatting commit:
git pull <remote> 5c8bfba2594942e89be978167febf533177879bd
- Merge your code with the remote code using a merge tool. To omit merging the auto generated files run
git checkout --theirs src/main/generated/*
git add src/main/generated/*
- When successfully merged, commit your changes
- Pull our formatting changes
git pull <remote> ae1cf8c4126771873414a127b89e59d0ba4c0d57
. Then run
git checkout --ours src/main/java/*
git add src/main/java/*
to keep your changes in source files that cannot be automatically merged and throw away our formatting changes.
- Merge all other conficts and run
mvn validate
to see which of your changes violate our guidelines - Apply formatting as stated in our formatting tutorials (Eclipse, IntelliJ Idea)
- Validate the state of your revision with
mvn validate
and fix remaining styling issues - Commit your changes
- Pull and merge changes after the formatting commit
git pull <remote> develop
- Run
mvn test -Dcheckstyle.failOnViolation=true
to check if everything works (This wil also recreate the generated files for your configuration)
Also check out Soot's webpage.
NOTE: If you find any bugs in those tutorials (or other parts of Soot) please help us out by reporting them in our issue tracker.
- Home
- Getting Help
- Tutorials
- Reference Material
- General Notions
- Getting Started
- A Few Uses of Soot
- Using Soot as a Command-Line Tool
- Using the Soot Eclipse Plugin
- Using Soot as a Compiler Framework
- Building Soot
- Coding Conventions
- Contributing to Soot
- Updating the Soot Web Page
- Reporting Bugs
- Preparing a New Soot Release