瀏覽代碼

Add mailmap docs

Vadim Markovtsev 7 年之前
父節點
當前提交
6e7f595215
共有 1 個文件被更改,包括 4 次插入0 次删除
  1. 4 0
      mailmap.go

+ 4 - 0
mailmap.go

@@ -6,6 +6,10 @@ import (
 	"gopkg.in/src-d/go-git.v4/plumbing/object"
 )
 
+// ParseMailmap parses the contents of .mailmap and returns the mapping
+// between signature parts. It does *not* follow the full signature
+// matching convention, that is, developers are identified by email
+// and by name independently.
 func ParseMailmap(contents string) map[string]object.Signature {
   mm := map[string]object.Signature{}
 	lines := strings.Split(contents, "\n")