diff options
author | Michele Locati <michele@locati.it> | 2018-03-09 18:09:56 +0100 |
---|---|---|
committer | Michele Locati <michele@locati.it> | 2018-03-09 18:22:47 +0100 |
commit | 1fd08382f2ad89f6bb09d0970912f95a7d3d30d6 (patch) | |
tree | c639f77c96d6bcfe32a9e0ce1cf6cf5c08069b8a /README.md | |
parent | d794bc04751f40edd67cb18b30cc8a5cf5e2e856 (diff) | |
download | incremental-git-filter-branch-1fd08382f2ad89f6bb09d0970912f95a7d3d30d6.tar.gz incremental-git-filter-branch-1fd08382f2ad89f6bb09d0970912f95a7d3d30d6.tar.bz2 incremental-git-filter-branch-1fd08382f2ad89f6bb09d0970912f95a7d3d30d6.zip |
Initial version
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..b29b493 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +## Introduction + +[`git filter-branch`](https://git-scm.com/docs/git-filter-branch) is a really nice git feature. +For instance, it allows fancy stuff like subtree-splitting. + +Problems may arise when the repository contains a lot of commits: this operation can take a lot of time. + +Luckily recent versions of git allow us to perform this operation in an incremental way: +the first time `filter-branch` still requires some time, but following calls can be very fast. + + +## Requirements + +- recent bash shell
+- git 2.5.0 or newer. + +## Usage + +Get the script, and customize the variables you can find at its beginning. + + +## Legal stuff + +Use at your own risk. +[MIT License](https://github.com/mlocati/incremental-git-filter-branch/blob/master/LICENSE). + + +## Credits + +Special thanks to [Ian Campbell](https://github.com/ijc) for the implementation of the `--state-branch` option of git, +and his hints about how it can be used. +This script works only thanks to him (and if it doesn't work I'm the only person to blame). |