Skip to content
This repository was archived by the owner on Sep 11, 2020. It is now read-only.

Commit 1931dfb

Browse files
committed
remove package doc
1 parent dd8e9b0 commit 1931dfb

File tree

6 files changed

+27
-40
lines changed

6 files changed

+27
-40
lines changed

blame.go

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -27,41 +27,41 @@ type Blame struct {
2727
// Blaming a file is a two step process:
2828
//
2929
// 1. Create a linear history of the commits affecting a file. We use
30-
// revlist.New for that.
30+
// revlist.New for that.
3131
//
3232
// 2. Then build a graph with a node for every line in every file in
33-
// the history of the file.
33+
// the history of the file.
3434
//
35-
// Each node (line) holds the commit where it was introduced or
36-
// last modified. To achieve that we use the FORWARD algorithm
37-
// described in Zimmermann, et al. "Mining Version Archives for
38-
// Co-changed Lines", in proceedings of the Mining Software
39-
// Repositories workshop, Shanghai, May 22-23, 2006.
35+
// Each node (line) holds the commit where it was introduced or
36+
// last modified. To achieve that we use the FORWARD algorithm
37+
// described in Zimmermann, et al. "Mining Version Archives for
38+
// Co-changed Lines", in proceedings of the Mining Software
39+
// Repositories workshop, Shanghai, May 22-23, 2006.
4040
//
41-
// Each node is asigned a commit: Start by the nodes in the first
42-
// commit. Assign that commit as the creator of all its lines.
41+
// Each node is asigned a commit: Start by the nodes in the first
42+
// commit. Assign that commit as the creator of all its lines.
4343
//
44-
// Then jump to the nodes in the next commit, and calculate the diff
45-
// between the two files. Newly created lines get
46-
// assigned the new commit as its origin. Modified lines also get
47-
// this new commit. Untouched lines retain the old commit.
44+
// Then jump to the nodes in the next commit, and calculate the diff
45+
// between the two files. Newly created lines get
46+
// assigned the new commit as its origin. Modified lines also get
47+
// this new commit. Untouched lines retain the old commit.
4848
//
49-
// All this work is done in the assignOrigin function which holds all
50-
// the internal relevant data in a "blame" struct, that is not
51-
// exported.
49+
// All this work is done in the assignOrigin function which holds all
50+
// the internal relevant data in a "blame" struct, that is not
51+
// exported.
5252
//
53-
// TODO: ways to improve the efficiency of this function:
53+
// TODO: ways to improve the efficiency of this function:
5454
//
55-
// 1. Improve revlist
55+
// 1. Improve revlist
5656
//
57-
// 2. Improve how to traverse the history (example a backward
58-
// traversal will be much more efficient)
57+
// 2. Improve how to traverse the history (example a backward
58+
// traversal will be much more efficient)
5959
//
60-
// TODO: ways to improve the function in general:
60+
// TODO: ways to improve the function in general:
6161
//
62-
// 1. Add memoization between revlist and assign.
62+
// 1. Add memoization between revlist and assign.
6363
//
64-
// 2. It is using much more memory than needed, see the TODOs below.
64+
// 2. It is using much more memory than needed, see the TODOs below.
6565
func (c *Commit) Blame(path string) (*Blame, error) {
6666
b := new(blame)
6767
b.fRev = c

clients/common/common.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Package common contains utils used by the clients
12
package common
23

34
import (

clients/http/common.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Package http implements a HTTP client for go-git.
12
package http
23

34
import (

core/object.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Package core implement the core interfaces and structs used by go-git
12
package core
23

34
import (

doc.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,6 @@
3030
// }
3131
//
3232
// fmt.Println(commit)
33+
// }
3334
// }
3435
package git

references.go

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,3 @@
1-
// Package revlist allows to create the revision history of a file, this
2-
// is, the list of commits in the past that affect the file.
3-
//
4-
// The general idea is to traverse the git commit graph backward,
5-
// flattening the graph into a linear history, and skipping commits that
6-
// are irrelevant for the particular file.
7-
//
8-
// There is no single answer for this operation. The git command
9-
// "git-revlist" returns different histories depending on its arguments
10-
// and some internal heuristics.
11-
//
12-
// The current implementation tries to get something similar to what you
13-
// whould get using git-revlist. See the failing tests for some
14-
// insight about how the current implementation and git-revlist differs.
15-
//
16-
// Another way to get the revision history for a file is:
17-
// git log --follow -p -- file
181
package git
192

203
import (

0 commit comments

Comments
 (0)