Merge pull request #836 from hezhizhen/typo

*: fix some typos

2 files changed, 246 insertions, 246 deletions

diff --git a/plumbing/object/commitgraph/commitnode.go b/plumbing/object/commitgraph/commitnode.go
index 7abc58b..d92c906 100644
--- a/plumbing/object/commitgraph/commitnode.go
+++ b/plumbing/object/commitgraph/commitnode.go
@@ -1,98 +1,98 @@
-package commitgraph

-

-import (

-	"io"

-	"time"

-

-	"github.com/go-git/go-git/v5/plumbing"

-	"github.com/go-git/go-git/v5/plumbing/object"

-	"github.com/go-git/go-git/v5/plumbing/storer"

-)

-

-// CommitNode is generic interface encapsulating a lightweight commit object retrieved

-// from CommitNodeIndex

-type CommitNode interface {

-	// ID returns the Commit object id referenced by the commit graph node.

-	ID() plumbing.Hash

-	// Tree returns the Tree referenced by the commit graph node.

-	Tree() (*object.Tree, error)

-	// CommitTime returns the Commiter.When time of the Commit referenced by the commit graph node.

-	CommitTime() time.Time

-	// NumParents returns the number of parents in a commit.

-	NumParents() int

-	// ParentNodes return a CommitNodeIter for parents of specified node.

-	ParentNodes() CommitNodeIter

-	// ParentNode returns the ith parent of a commit.

-	ParentNode(i int) (CommitNode, error)

-	// ParentHashes returns hashes of the parent commits for a specified node

-	ParentHashes() []plumbing.Hash

-	// Generation returns the generation of the commit for reachability analysis.

-	// Objects with newer generation are not reachable from objects of older generation.

-	Generation() uint64

-	// Commit returns the full commit object from the node

-	Commit() (*object.Commit, error)

-}

-

-// CommitNodeIndex is generic interface encapsulating an index of CommitNode objects

-type CommitNodeIndex interface {

-	// Get returns a commit node from a commit hash

-	Get(hash plumbing.Hash) (CommitNode, error)

-}

-

-// CommitNodeIter is a generic closable interface for iterating over commit nodes.

-type CommitNodeIter interface {

-	Next() (CommitNode, error)

-	ForEach(func(CommitNode) error) error

-	Close()

-}

-

-// parentCommitNodeIter provides an iterator for parent commits from associated CommitNodeIndex.

-type parentCommitNodeIter struct {

-	node CommitNode

-	i    int

-}

-

-func newParentgraphCommitNodeIter(node CommitNode) CommitNodeIter {

-	return &parentCommitNodeIter{node, 0}

-}

-

-// Next moves the iterator to the next commit and returns a pointer to it. If

-// there are no more commits, it returns io.EOF.

-func (iter *parentCommitNodeIter) Next() (CommitNode, error) {

-	obj, err := iter.node.ParentNode(iter.i)

-	if err == object.ErrParentNotFound {

-		return nil, io.EOF

-	}

-	if err == nil {

-		iter.i++

-	}

-

-	return obj, err

-}

-

-// ForEach call the cb function for each commit contained on this iter until

-// an error appends or the end of the iter is reached. If ErrStop is sent

-// the iteration is stopped but no error is returned. The iterator is closed.

-func (iter *parentCommitNodeIter) ForEach(cb func(CommitNode) error) error {

-	for {

-		obj, err := iter.Next()

-		if err != nil {

-			if err == io.EOF {

-				return nil

-			}

-

-			return err

-		}

-

-		if err := cb(obj); err != nil {

-			if err == storer.ErrStop {

-				return nil

-			}

-

-			return err

-		}

-	}

-}

-

-func (iter *parentCommitNodeIter) Close() {

-}

+package commitgraph
+
+import (
+	"io"
+	"time"
+
+	"github.com/go-git/go-git/v5/plumbing"
+	"github.com/go-git/go-git/v5/plumbing/object"
+	"github.com/go-git/go-git/v5/plumbing/storer"
+)
+
+// CommitNode is generic interface encapsulating a lightweight commit object retrieved
+// from CommitNodeIndex
+type CommitNode interface {
+	// ID returns the Commit object id referenced by the commit graph node.
+	ID() plumbing.Hash
+	// Tree returns the Tree referenced by the commit graph node.
+	Tree() (*object.Tree, error)
+	// CommitTime returns the Committer.When time of the Commit referenced by the commit graph node.
+	CommitTime() time.Time
+	// NumParents returns the number of parents in a commit.
+	NumParents() int
+	// ParentNodes return a CommitNodeIter for parents of specified node.
+	ParentNodes() CommitNodeIter
+	// ParentNode returns the ith parent of a commit.
+	ParentNode(i int) (CommitNode, error)
+	// ParentHashes returns hashes of the parent commits for a specified node
+	ParentHashes() []plumbing.Hash
+	// Generation returns the generation of the commit for reachability analysis.
+	// Objects with newer generation are not reachable from objects of older generation.
+	Generation() uint64
+	// Commit returns the full commit object from the node
+	Commit() (*object.Commit, error)
+}
+
+// CommitNodeIndex is generic interface encapsulating an index of CommitNode objects
+type CommitNodeIndex interface {
+	// Get returns a commit node from a commit hash
+	Get(hash plumbing.Hash) (CommitNode, error)
+}
+
+// CommitNodeIter is a generic closable interface for iterating over commit nodes.
+type CommitNodeIter interface {
+	Next() (CommitNode, error)
+	ForEach(func(CommitNode) error) error
+	Close()
+}
+
+// parentCommitNodeIter provides an iterator for parent commits from associated CommitNodeIndex.
+type parentCommitNodeIter struct {
+	node CommitNode
+	i    int
+}
+
+func newParentgraphCommitNodeIter(node CommitNode) CommitNodeIter {
+	return &parentCommitNodeIter{node, 0}
+}
+
+// Next moves the iterator to the next commit and returns a pointer to it. If
+// there are no more commits, it returns io.EOF.
+func (iter *parentCommitNodeIter) Next() (CommitNode, error) {
+	obj, err := iter.node.ParentNode(iter.i)
+	if err == object.ErrParentNotFound {
+		return nil, io.EOF
+	}
+	if err == nil {
+		iter.i++
+	}
+
+	return obj, err
+}
+
+// ForEach call the cb function for each commit contained on this iter until
+// an error appends or the end of the iter is reached. If ErrStop is sent
+// the iteration is stopped but no error is returned. The iterator is closed.
+func (iter *parentCommitNodeIter) ForEach(cb func(CommitNode) error) error {
+	for {
+		obj, err := iter.Next()
+		if err != nil {
+			if err == io.EOF {
+				return nil
+			}
+
+			return err
+		}
+
+		if err := cb(obj); err != nil {
+			if err == storer.ErrStop {
+				return nil
+			}
+
+			return err
+		}
+	}
+}
+
+func (iter *parentCommitNodeIter) Close() {
+}
diff --git a/plumbing/object/commitgraph/commitnode_test.go b/plumbing/object/commitgraph/commitnode_test.go
index 6c9a643..91fb211 100644
--- a/plumbing/object/commitgraph/commitnode_test.go
+++ b/plumbing/object/commitgraph/commitnode_test.go
@@ -1,148 +1,148 @@
-package commitgraph

-

-import (

-	"path"

-	"testing"

-

-	"github.com/go-git/go-git/v5/plumbing"

-	"github.com/go-git/go-git/v5/plumbing/cache"

-	"github.com/go-git/go-git/v5/plumbing/format/commitgraph"

-	"github.com/go-git/go-git/v5/plumbing/format/packfile"

-	"github.com/go-git/go-git/v5/storage/filesystem"

-

-	fixtures "github.com/go-git/go-git-fixtures/v4"

-	. "gopkg.in/check.v1"

-)

-

-func Test(t *testing.T) { TestingT(t) }

-

-type CommitNodeSuite struct {

-	fixtures.Suite

-}

-

-var _ = Suite(&CommitNodeSuite{})

-

-func unpackRepositry(f *fixtures.Fixture) *filesystem.Storage {

-	storer := filesystem.NewStorage(f.DotGit(), cache.NewObjectLRUDefault())

-	p := f.Packfile()

-	defer p.Close()

-	packfile.UpdateObjectStorage(storer, p)

-	return storer

-}

-

-func testWalker(c *C, nodeIndex CommitNodeIndex) {

-	head, err := nodeIndex.Get(plumbing.NewHash("b9d69064b190e7aedccf84731ca1d917871f8a1c"))

-	c.Assert(err, IsNil)

-

-	iter := NewCommitNodeIterCTime(

-		head,

-		nil,

-		nil,

-	)

-

-	var commits []CommitNode

-	iter.ForEach(func(c CommitNode) error {

-		commits = append(commits, c)

-		return nil

-	})

-

-	c.Assert(commits, HasLen, 9)

-

-	expected := []string{

-		"b9d69064b190e7aedccf84731ca1d917871f8a1c",

-		"6f6c5d2be7852c782be1dd13e36496dd7ad39560",

-		"a45273fe2d63300e1962a9e26a6b15c276cd7082",

-		"c0edf780dd0da6a65a7a49a86032fcf8a0c2d467",

-		"bb13916df33ed23004c3ce9ed3b8487528e655c1",

-		"03d2c021ff68954cf3ef0a36825e194a4b98f981",

-		"ce275064ad67d51e99f026084e20827901a8361c",

-		"e713b52d7e13807e87a002e812041f248db3f643",

-		"347c91919944a68e9413581a1bc15519550a3afe",

-	}

-	for i, commit := range commits {

-		c.Assert(commit.ID().String(), Equals, expected[i])

-	}

-}

-

-func testParents(c *C, nodeIndex CommitNodeIndex) {

-	merge3, err := nodeIndex.Get(plumbing.NewHash("6f6c5d2be7852c782be1dd13e36496dd7ad39560"))

-	c.Assert(err, IsNil)

-

-	var parents []CommitNode

-	merge3.ParentNodes().ForEach(func(c CommitNode) error {

-		parents = append(parents, c)

-		return nil

-	})

-

-	c.Assert(parents, HasLen, 3)

-

-	expected := []string{

-		"ce275064ad67d51e99f026084e20827901a8361c",

-		"bb13916df33ed23004c3ce9ed3b8487528e655c1",

-		"a45273fe2d63300e1962a9e26a6b15c276cd7082",

-	}

-	for i, parent := range parents {

-		c.Assert(parent.ID().String(), Equals, expected[i])

-	}

-}

-

-func testCommitAndTree(c *C, nodeIndex CommitNodeIndex) {

-	merge3node, err := nodeIndex.Get(plumbing.NewHash("6f6c5d2be7852c782be1dd13e36496dd7ad39560"))

-	c.Assert(err, IsNil)

-	merge3commit, err := merge3node.Commit()

-	c.Assert(err, IsNil)

-	c.Assert(merge3node.ID().String(), Equals, merge3commit.ID().String())

-	tree, err := merge3node.Tree()

-	c.Assert(err, IsNil)

-	c.Assert(tree.ID().String(), Equals, merge3commit.TreeHash.String())

-}

-

-func (s *CommitNodeSuite) TestObjectGraph(c *C) {

-	f := fixtures.ByTag("commit-graph").One()

-	storer := unpackRepositry(f)

-

-	nodeIndex := NewObjectCommitNodeIndex(storer)

-	testWalker(c, nodeIndex)

-	testParents(c, nodeIndex)

-	testCommitAndTree(c, nodeIndex)

-}

-

-func (s *CommitNodeSuite) TestCommitGraph(c *C) {

-	f := fixtures.ByTag("commit-graph").One()

-	storer := unpackRepositry(f)

-	reader, err := storer.Filesystem().Open(path.Join("objects", "info", "commit-graph"))

-	c.Assert(err, IsNil)

-	defer reader.Close()

-	index, err := commitgraph.OpenFileIndex(reader)

-	c.Assert(err, IsNil)

-

-	nodeIndex := NewGraphCommitNodeIndex(index, storer)

-	testWalker(c, nodeIndex)

-	testParents(c, nodeIndex)

-	testCommitAndTree(c, nodeIndex)

-}

-

-func (s *CommitNodeSuite) TestMixedGraph(c *C) {

-	f := fixtures.ByTag("commit-graph").One()

-	storer := unpackRepositry(f)

-

-	// Take the commit-graph file and copy it to memory index without the last commit

-	reader, err := storer.Filesystem().Open(path.Join("objects", "info", "commit-graph"))

-	c.Assert(err, IsNil)

-	defer reader.Close()

-	fileIndex, err := commitgraph.OpenFileIndex(reader)

-	c.Assert(err, IsNil)

-	memoryIndex := commitgraph.NewMemoryIndex()

-	for i, hash := range fileIndex.Hashes() {

-		if hash.String() != "b9d69064b190e7aedccf84731ca1d917871f8a1c" {

-			node, err := fileIndex.GetCommitDataByIndex(i)

-			c.Assert(err, IsNil)

-			memoryIndex.Add(hash, node)

-		}

-	}

-

-	nodeIndex := NewGraphCommitNodeIndex(memoryIndex, storer)

-	testWalker(c, nodeIndex)

-	testParents(c, nodeIndex)

-	testCommitAndTree(c, nodeIndex)

-}

+package commitgraph
+
+import (
+	"path"
+	"testing"
+
+	"github.com/go-git/go-git/v5/plumbing"
+	"github.com/go-git/go-git/v5/plumbing/cache"
+	"github.com/go-git/go-git/v5/plumbing/format/commitgraph"
+	"github.com/go-git/go-git/v5/plumbing/format/packfile"
+	"github.com/go-git/go-git/v5/storage/filesystem"
+
+	fixtures "github.com/go-git/go-git-fixtures/v4"
+	. "gopkg.in/check.v1"
+)
+
+func Test(t *testing.T) { TestingT(t) }
+
+type CommitNodeSuite struct {
+	fixtures.Suite
+}
+
+var _ = Suite(&CommitNodeSuite{})
+
+func unpackRepository(f *fixtures.Fixture) *filesystem.Storage {
+	storer := filesystem.NewStorage(f.DotGit(), cache.NewObjectLRUDefault())
+	p := f.Packfile()
+	defer p.Close()
+	packfile.UpdateObjectStorage(storer, p)
+	return storer
+}
+
+func testWalker(c *C, nodeIndex CommitNodeIndex) {
+	head, err := nodeIndex.Get(plumbing.NewHash("b9d69064b190e7aedccf84731ca1d917871f8a1c"))
+	c.Assert(err, IsNil)
+
+	iter := NewCommitNodeIterCTime(
+		head,
+		nil,
+		nil,
+	)
+
+	var commits []CommitNode
+	iter.ForEach(func(c CommitNode) error {
+		commits = append(commits, c)
+		return nil
+	})
+
+	c.Assert(commits, HasLen, 9)
+
+	expected := []string{
+		"b9d69064b190e7aedccf84731ca1d917871f8a1c",
+		"6f6c5d2be7852c782be1dd13e36496dd7ad39560",
+		"a45273fe2d63300e1962a9e26a6b15c276cd7082",
+		"c0edf780dd0da6a65a7a49a86032fcf8a0c2d467",
+		"bb13916df33ed23004c3ce9ed3b8487528e655c1",
+		"03d2c021ff68954cf3ef0a36825e194a4b98f981",
+		"ce275064ad67d51e99f026084e20827901a8361c",
+		"e713b52d7e13807e87a002e812041f248db3f643",
+		"347c91919944a68e9413581a1bc15519550a3afe",
+	}
+	for i, commit := range commits {
+		c.Assert(commit.ID().String(), Equals, expected[i])
+	}
+}
+
+func testParents(c *C, nodeIndex CommitNodeIndex) {
+	merge3, err := nodeIndex.Get(plumbing.NewHash("6f6c5d2be7852c782be1dd13e36496dd7ad39560"))
+	c.Assert(err, IsNil)
+
+	var parents []CommitNode
+	merge3.ParentNodes().ForEach(func(c CommitNode) error {
+		parents = append(parents, c)
+		return nil
+	})
+
+	c.Assert(parents, HasLen, 3)
+
+	expected := []string{
+		"ce275064ad67d51e99f026084e20827901a8361c",
+		"bb13916df33ed23004c3ce9ed3b8487528e655c1",
+		"a45273fe2d63300e1962a9e26a6b15c276cd7082",
+	}
+	for i, parent := range parents {
+		c.Assert(parent.ID().String(), Equals, expected[i])
+	}
+}
+
+func testCommitAndTree(c *C, nodeIndex CommitNodeIndex) {
+	merge3node, err := nodeIndex.Get(plumbing.NewHash("6f6c5d2be7852c782be1dd13e36496dd7ad39560"))
+	c.Assert(err, IsNil)
+	merge3commit, err := merge3node.Commit()
+	c.Assert(err, IsNil)
+	c.Assert(merge3node.ID().String(), Equals, merge3commit.ID().String())
+	tree, err := merge3node.Tree()
+	c.Assert(err, IsNil)
+	c.Assert(tree.ID().String(), Equals, merge3commit.TreeHash.String())
+}
+
+func (s *CommitNodeSuite) TestObjectGraph(c *C) {
+	f := fixtures.ByTag("commit-graph").One()
+	storer := unpackRepository(f)
+
+	nodeIndex := NewObjectCommitNodeIndex(storer)
+	testWalker(c, nodeIndex)
+	testParents(c, nodeIndex)
+	testCommitAndTree(c, nodeIndex)
+}
+
+func (s *CommitNodeSuite) TestCommitGraph(c *C) {
+	f := fixtures.ByTag("commit-graph").One()
+	storer := unpackRepository(f)
+	reader, err := storer.Filesystem().Open(path.Join("objects", "info", "commit-graph"))
+	c.Assert(err, IsNil)
+	defer reader.Close()
+	index, err := commitgraph.OpenFileIndex(reader)
+	c.Assert(err, IsNil)
+
+	nodeIndex := NewGraphCommitNodeIndex(index, storer)
+	testWalker(c, nodeIndex)
+	testParents(c, nodeIndex)
+	testCommitAndTree(c, nodeIndex)
+}
+
+func (s *CommitNodeSuite) TestMixedGraph(c *C) {
+	f := fixtures.ByTag("commit-graph").One()
+	storer := unpackRepository(f)
+
+	// Take the commit-graph file and copy it to memory index without the last commit
+	reader, err := storer.Filesystem().Open(path.Join("objects", "info", "commit-graph"))
+	c.Assert(err, IsNil)
+	defer reader.Close()
+	fileIndex, err := commitgraph.OpenFileIndex(reader)
+	c.Assert(err, IsNil)
+	memoryIndex := commitgraph.NewMemoryIndex()
+	for i, hash := range fileIndex.Hashes() {
+		if hash.String() != "b9d69064b190e7aedccf84731ca1d917871f8a1c" {
+			node, err := fileIndex.GetCommitDataByIndex(i)
+			c.Assert(err, IsNil)
+			memoryIndex.Add(hash, node)
+		}
+	}
+
+	nodeIndex := NewGraphCommitNodeIndex(memoryIndex, storer)
+	testWalker(c, nodeIndex)
+	testParents(c, nodeIndex)
+	testCommitAndTree(c, nodeIndex)
+}