Skip to content

Commit 3710f95

Browse files
committed
Add merge=crypt to setup instructions and detailed change notes
1 parent 546cec9 commit 3710f95

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,14 +92,14 @@ using the command line options. Run `transcrypt --help` for more details.
9292
### Designate a File to be Encrypted
9393

9494
Once a repository has been configured with transcrypt, you can designate for
95-
files to be encrypted by applying the "crypt" filter and diff to a
95+
files to be encrypted by applying the "crypt" filter, diff, and merge to a
9696
[pattern](https://www.kernel.org/pub/software/scm/git/docs/gitignore.html#_pattern_format)
9797
in the top-level _[.gitattributes](http://git-scm.com/docs/gitattributes)_
9898
config. If that pattern matches a file in your repository, the file will be
9999
transparently encrypted once you stage and commit it:
100100

101101
$ cd <path-to-your-repo>/
102-
$ echo 'sensitive_file filter=crypt diff=crypt' >> .gitattributes
102+
$ echo 'sensitive_file filter=crypt diff=crypt merge=crypt' >> .gitattributes
103103
$ git add .gitattributes sensitive_file
104104
$ git commit -m 'Add encrypted version of a sensitive file'
105105

@@ -311,6 +311,15 @@ To run the tests:
311311

312312
## Changes
313313

314+
Fixes:
315+
316+
- Fix handling of branch merges with conflicts in encrypted files, which
317+
would previously leave the user to manually merge files with a mix of
318+
encrypted and unencrypted content.
319+
320+
To apply this fix in projects that already use transcrypt: uninstall and
321+
re-init transcrypt, then add `merge=crypt` to the patterns in *.gitattributes*
322+
314323
Improvements:
315324

316325
- Add Git pre-commit hook to reject commit of file that should be encrypted but

0 commit comments

Comments
 (0)