diff options
| author | Antonio Jesus Navarro Perez <antonio@sourced.tech> | 2017-02-23 17:07:08 +0100 |
|---|---|---|
| committer | Antonio Jesus Navarro Perez <antonio@sourced.tech> | 2017-02-23 17:14:43 +0100 |
| commit | 059a0be78399cdb0648bd514c5b179819d84403d (patch) | |
| tree | 007fea2e8529b865b354b45c8aed9045e136d462 /plumbing/format/packfile/encoder.go | |
| parent | b5da4e98571b02dc106de4f9b2cb2a298489f1b1 (diff) | |
| download | go-git-059a0be78399cdb0648bd514c5b179819d84403d.tar.gz | |
plumbing: improve documentation (Fix #242)
Diffstat (limited to 'plumbing/format/packfile/encoder.go')
| -rw-r--r-- | plumbing/format/packfile/encoder.go | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/plumbing/format/packfile/encoder.go b/plumbing/format/packfile/encoder.go index 96fe4b4..a0a13f8 100644 --- a/plumbing/format/packfile/encoder.go +++ b/plumbing/format/packfile/encoder.go @@ -23,7 +23,8 @@ type Encoder struct { } // NewEncoder creates a new packfile encoder using a specific Writer and -// EncodedObjectStorer +// EncodedObjectStorer. By default deltas used to generate the packfile will be +// OFSDeltaObject. To use Reference deltas, set useRefDeltas to true. func NewEncoder(w io.Writer, s storer.EncodedObjectStorer, useRefDeltas bool) *Encoder { h := plumbing.Hasher{ Hash: sha1.New(), |