aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--blame.go30
-rw-r--r--references.go13
-rw-r--r--remote.go2
3 files changed, 24 insertions, 21 deletions
diff --git a/blame.go b/blame.go
index d16cf25..bf04570 100644
--- a/blame.go
+++ b/blame.go
@@ -13,17 +13,21 @@ import (
"srcd.works/go-git.v4/utils/diff"
)
+// BlameResult represents the result of a Blame operation
type BlameResult struct {
- Path string
- Rev plumbing.Hash
+ // Path is the path of the File that we're blaming
+ Path string
+ // Rev is the hash of the specified Commit used to generate this result
+ Rev plumbing.Hash
+ // Lines contains every line with its authorship
Lines []*Line
}
-// Blame returns the last commit that modified each line of a file in a
-// repository.
-//
-// The file to blame is identified by the input arguments: repo, commit and path.
-// The output is a slice of commits, one for each line in the file.
+// Blame returns a BlameResult that contains all the data needed to know the
+// last author of each line of an specified file starting the history from
+// a specified commit. The file to blame is identified by the input arguments:
+// commit and path. commit is a Commit object obtained from a Repository. Path
+// represents a path to a specific file contained into the repository.
//
// Blaming a file is a two step process:
//
@@ -33,12 +37,6 @@ type BlameResult struct {
// 2. Then build a graph with a node for every line in every file in
// the history of the file.
//
-// Each node (line) holds the commit where it was introduced or
-// last modified. To achieve that we use the FORWARD algorithm
-// described in Zimmermann, et al. "Mining Version Archives for
-// Co-changed Lines", in proceedings of the Mining Software
-// Repositories workshop, Shanghai, May 22-23, 2006.
-//
// Each node is assigned a commit: Start by the nodes in the first
// commit. Assign that commit as the creator of all its lines.
//
@@ -98,8 +96,10 @@ func Blame(c *object.Commit, path string) (*BlameResult, error) {
// Line values represent the contents and author of a line in BlamedResult values.
type Line struct {
- Author string // email address of the author of the line.
- Text string // original text of the line.
+ // Author is the email address of the last author that modified the line
+ Author string
+ // Text is the original text of the line.
+ Text string
}
func newLine(author, text string) *Line {
diff --git a/references.go b/references.go
index fe1d12b..338e2b7 100644
--- a/references.go
+++ b/references.go
@@ -10,15 +10,18 @@ import (
"github.com/sergi/go-diff/diffmatchpatch"
)
-// References returns a References for the file at "path", the commits are
-// sorted in commit order. It stops searching a branch for a file upon reaching
-// the commit were the file was created.
+// References returns a slice of Commits for the file at "path", starting from
+// the commit provided that contains the file from the provided path. The last
+// commit into the returned slice is the commit where the file was created.
+// If the provided commit does not contains the specified path, a nil slice is
+// returned. The commits are sorted in commit order, newer to older.
//
// Caveats:
+//
// - Moves and copies are not currently supported.
+//
// - Cherry-picks are not detected unless there are no commits between them and
-// therefore can appear repeated in the list.
-// (see git path-id for hints on how to fix this).
+// therefore can appear repeated in the list. (see git path-id for hints on how to fix this).
func References(c *object.Commit, path string) ([]*object.Commit, error) {
var result []*object.Commit
seen := make(map[plumbing.Hash]struct{}, 0)
diff --git a/remote.go b/remote.go
index fe7993c..4f034bb 100644
--- a/remote.go
+++ b/remote.go
@@ -32,7 +32,7 @@ func newRemote(s storage.Storer, c *config.RemoteConfig) *Remote {
return &Remote{s: s, c: c}
}
-// Config return the config
+// Config returns the RemoteConfig object used to instantiate this Remote
func (r *Remote) Config() *config.RemoteConfig {
return r.c
}