jeans/etcher
jeans/etcher
1
0
Fork 0
mirror of https://github.com/balena-io/etcher.git synced 2025-07-24 19:56:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc(contributing): Add section about binary diffs (#1380)

Browse Source 
This adds instructions on how to set up human-readable binary diffs
with git for Etcher, which is useful when altering test images etc.
This commit is contained in:
Jonas Hermsmeier 2017-05-07 20:59:11 +02:00 committed by Juan Cruz Viotti
parent 91784d6380
commit 9055b4b773
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/CONTRIBUTING.md
View File

@ -69,6 +69,28 @@ systems as they can before sending a pull request.
*The test suite is run automatically by CI servers when you send a pull
request.*
Diffing Binaries
----------------
Binary files are tagged as "binary" in the `.gitattributes` file, but also have
a `diff=hex` tag, which allows you to see hexdump-style diffs for binaries,
if you add the following to either your global or repository-local git config:
```sh
$ git config diff.hex.textconv hexdump
$ git config diff.hex.binary true
```
And global, respectively:
```sh
$ git config --global diff.hex.textconv hexdump
$ git config --global diff.hex.binary true
```
If you don't have `hexdump` available on your platform,
you can try [hxd], which is also a bit faster.
Sending a pull request
----------------------
@ -108,3 +130,4 @@ Don't hesitate to get in touch if you have any questions or need any help!
[RUNNING-LOCALLY]: https://github.com/resin-io/etcher/blob/master/docs/RUNNING-LOCALLY.md
[EditorConfig]: http://editorconfig.org
[shrinkwrap]: https://docs.npmjs.com/cli/shrinkwrap
[hxd]: https://github.com/jhermsmeier/hxd