summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJed Brown <jed@59A2.org>2013-02-14 19:28:16 -0600
committerJed Brown <jed@59A2.org>2013-02-14 19:28:16 -0600
commit0f143e2d41cc70db5777cbf8d00aa52858e18fc3 (patch)
tree8de9bdc907941774d64593130470ecb49d600e9e /README.md
parentb8524eb4574ac8f0d340ed4e9c4607634c4758af (diff)
downloadgit-fat-0f143e2d41cc70db5777cbf8d00aa52858e18fc3.tar.gz
Update readme on retroactive cleaning
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/README.md b/README.md
index 90fe9c0..ce169e2 100644
--- a/README.md
+++ b/README.md
@@ -179,7 +179,7 @@ where the first number after the `#` is the number of bytes and the
second number is the number of modifications that path has seen. You
will normally filter out some of these paths using grep and/or an
editor. When satisfied, remove the ends of the lines (including the `#`)
-and append to `.gitattributes`. It's best to `git checkout .` and commit
+and append to `.gitattributes`. It's best to `git add .gitattributes` and commit
at this time (likely enrolling some extant files into `git fat`).
### Step 2: `filter-branch`
@@ -190,9 +190,13 @@ Currently, this may only contain exact paths relative to the root of the
repository. Finally, run
git filter-branch --index-filter \
- 'git fat index-filter /tmp/fat-filter-files' \
+ 'git fat index-filter /tmp/fat-filter-files --manage-gitattributes' \
--tag-name-filter cat -- --all
+(You can remove the `--manage-gitattributes` option if you don't want to
+append all the files being enrolled in `git fat` to `.gitattributes`,
+however, future users would need to use `.git/info/attributes` to have
+the `git fat` fileters run.)
When this finishes, inspect to see if everything is in order and follow
the
[Checklist for Shrinking a Repository](http://www.kernel.org/pub/software/scm/git/docs/git-filter-branch.html#_checklist_for_shrinking_a_repository)
@@ -200,6 +204,8 @@ in the `git filter-branch` man page, typically `git clone
file:///path/to/repo`. Be sure to `git fat push` from the original
repository.
+See the script `test-retroactive.sh` for an example of cleaning.
+
## Implementation notes
The actual binary files are stored in `.git/fat/objects`, leaving `.git/objects` nice and small.