aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMáximo Cuadros <mcuadros@gmail.com>2016-02-16 17:31:09 +0100
committerMáximo Cuadros <mcuadros@gmail.com>2016-02-16 17:37:29 +0100
commit1931dfbf38508e790e9f129873bc073aacc6a50f (patch)
treef57f34d75a73ca5f7bab800f5c8510f96522b686
parentdd8e9b02df17639b625b8c9c03f9537f5cfc039c (diff)
downloadgo-git-1931dfbf38508e790e9f129873bc073aacc6a50f.tar.gz
remove package docv2.2.0
-rw-r--r--blame.go46
-rw-r--r--clients/common/common.go1
-rw-r--r--clients/http/common.go1
-rw-r--r--core/object.go1
-rw-r--r--doc.go1
-rw-r--r--references.go17
6 files changed, 27 insertions, 40 deletions
diff --git a/blame.go b/blame.go
index fa25922..0faae67 100644
--- a/blame.go
+++ b/blame.go
@@ -27,41 +27,41 @@ type Blame struct {
// Blaming a file is a two step process:
//
// 1. Create a linear history of the commits affecting a file. We use
-// revlist.New for that.
+// revlist.New for that.
//
// 2. Then build a graph with a node for every line in every file in
-// the history of the file.
+// 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 (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 asigned a commit: Start by the nodes in the first
-// commit. Assign that commit as the creator of all its lines.
+// Each node is asigned a commit: Start by the nodes in the first
+// commit. Assign that commit as the creator of all its lines.
//
-// Then jump to the nodes in the next commit, and calculate the diff
-// between the two files. Newly created lines get
-// assigned the new commit as its origin. Modified lines also get
-// this new commit. Untouched lines retain the old commit.
+// Then jump to the nodes in the next commit, and calculate the diff
+// between the two files. Newly created lines get
+// assigned the new commit as its origin. Modified lines also get
+// this new commit. Untouched lines retain the old commit.
//
-// All this work is done in the assignOrigin function which holds all
-// the internal relevant data in a "blame" struct, that is not
-// exported.
+// All this work is done in the assignOrigin function which holds all
+// the internal relevant data in a "blame" struct, that is not
+// exported.
//
-// TODO: ways to improve the efficiency of this function:
+// TODO: ways to improve the efficiency of this function:
//
-// 1. Improve revlist
+// 1. Improve revlist
//
-// 2. Improve how to traverse the history (example a backward
-// traversal will be much more efficient)
+// 2. Improve how to traverse the history (example a backward
+// traversal will be much more efficient)
//
-// TODO: ways to improve the function in general:
+// TODO: ways to improve the function in general:
//
-// 1. Add memoization between revlist and assign.
+// 1. Add memoization between revlist and assign.
//
-// 2. It is using much more memory than needed, see the TODOs below.
+// 2. It is using much more memory than needed, see the TODOs below.
func (c *Commit) Blame(path string) (*Blame, error) {
b := new(blame)
b.fRev = c
diff --git a/clients/common/common.go b/clients/common/common.go
index a6f6166..ec04dda 100644
--- a/clients/common/common.go
+++ b/clients/common/common.go
@@ -1,3 +1,4 @@
+// Package common contains utils used by the clients
package common
import (
diff --git a/clients/http/common.go b/clients/http/common.go
index f0f2e6b..aa6e7a1 100644
--- a/clients/http/common.go
+++ b/clients/http/common.go
@@ -1,3 +1,4 @@
+// Package http implements a HTTP client for go-git.
package http
import (
diff --git a/core/object.go b/core/object.go
index 1034ab3..ffc561b 100644
--- a/core/object.go
+++ b/core/object.go
@@ -1,3 +1,4 @@
+// Package core implement the core interfaces and structs used by go-git
package core
import (
diff --git a/doc.go b/doc.go
index d6b3cf5..b823943 100644
--- a/doc.go
+++ b/doc.go
@@ -30,5 +30,6 @@
// }
//
// fmt.Println(commit)
+// }
// }
package git
diff --git a/references.go b/references.go
index 0c57df9..c69917d 100644
--- a/references.go
+++ b/references.go
@@ -1,20 +1,3 @@
-// Package revlist allows to create the revision history of a file, this
-// is, the list of commits in the past that affect the file.
-//
-// The general idea is to traverse the git commit graph backward,
-// flattening the graph into a linear history, and skipping commits that
-// are irrelevant for the particular file.
-//
-// There is no single answer for this operation. The git command
-// "git-revlist" returns different histories depending on its arguments
-// and some internal heuristics.
-//
-// The current implementation tries to get something similar to what you
-// whould get using git-revlist. See the failing tests for some
-// insight about how the current implementation and git-revlist differs.
-//
-// Another way to get the revision history for a file is:
-// git log --follow -p -- file
package git
import (