diff options
| -rw-r--r-- | clients/common.go | 10 | ||||
| -rw-r--r-- | clients/common/common.go | 2 | ||||
| -rw-r--r-- | config/config.go | 1 | ||||
| -rw-r--r-- | formats/idxfile/doc.go | 4 | ||||
| -rw-r--r-- | formats/packfile/doc.go | 6 | ||||
| -rw-r--r-- | formats/pktline/doc.go | 1 | ||||
| -rw-r--r-- | storage/filesystem/storage.go | 1 | ||||
| -rw-r--r-- | storage/memory/storage.go | 1 | ||||
| -rw-r--r-- | utils/fs/fs.go | 1 |
9 files changed, 18 insertions, 9 deletions
diff --git a/clients/common.go b/clients/common.go index 1eeacf0..c28c465 100644 --- a/clients/common.go +++ b/clients/common.go @@ -1,10 +1,12 @@ -// Go-git needs the packfile and the refs of the repo. The +// Package clients includes the implementation for diferent transport protocols +// +// go-git needs the packfile and the refs of the repo. The // `NewGitUploadPackService` function returns an object that allows to // download them. // -// Go-git supports HTTP and SSH (see `KnownProtocols`) for downloading -// the packfile and the refs, but you can also install your own -// protocols (see `InstallProtocol` below). +// go-git supports HTTP and SSH (see `Protocols`) for downloading the packfile +// and the refs, but you can also install your own protocols (see +// `InstallProtocol` below). // // Each protocol has its own implementation of // `NewGitUploadPackService`, but you should generally not use them diff --git a/clients/common/common.go b/clients/common/common.go index b5e6152..1518081 100644 --- a/clients/common/common.go +++ b/clients/common/common.go @@ -1,4 +1,4 @@ -// Package common contains utils used by the clients +// Package common contains interfaces and non-specific protocol entities package common import ( diff --git a/config/config.go b/config/config.go index 7138952..f94d4c9 100644 --- a/config/config.go +++ b/config/config.go @@ -1,3 +1,4 @@ +// Package config storage is the implementation of git config for go-git package config import ( diff --git a/formats/idxfile/doc.go b/formats/idxfile/doc.go index 74149ab..8a76853 100644 --- a/formats/idxfile/doc.go +++ b/formats/idxfile/doc.go @@ -1,3 +1,6 @@ +// Package idxfile implements a encoder/decoder of idx files +package idxfile + /* == Original (version 1) pack-*.idx files have the following format: @@ -127,4 +130,3 @@ Pack file entry: <+ From: https://www.kernel.org/pub/software/scm/git/docs/v1.7.5/technical/pack-protocol.txt */ -package idxfile diff --git a/formats/packfile/doc.go b/formats/packfile/doc.go index c79c180..0b173ca 100644 --- a/formats/packfile/doc.go +++ b/formats/packfile/doc.go @@ -1,6 +1,7 @@ -// Package packfile documentation: -/* +// Package packfile implements a encoder/decoder of packfile format +package packfile +/* GIT pack format =============== @@ -165,4 +166,3 @@ Pack file entry: <+ From: https://www.kernel.org/pub/software/scm/git/docs/v1.7.5/technical/pack-protocol.txt */ -package packfile diff --git a/formats/pktline/doc.go b/formats/pktline/doc.go index 555a073..1e14ec0 100644 --- a/formats/pktline/doc.go +++ b/formats/pktline/doc.go @@ -1,3 +1,4 @@ +// Package pktline implements a encoder/decoder of pkt-line format package pktline // pkt-line Format diff --git a/storage/filesystem/storage.go b/storage/filesystem/storage.go index c483218..a0cb0b1 100644 --- a/storage/filesystem/storage.go +++ b/storage/filesystem/storage.go @@ -1,3 +1,4 @@ +// Package filesystem is a storage backend base on filesystems package filesystem import ( diff --git a/storage/memory/storage.go b/storage/memory/storage.go index fa34c4d..c8a152d 100644 --- a/storage/memory/storage.go +++ b/storage/memory/storage.go @@ -1,3 +1,4 @@ +// Package memory is a storage backend base on memory package memory import ( diff --git a/utils/fs/fs.go b/utils/fs/fs.go index df771dd..cfab692 100644 --- a/utils/fs/fs.go +++ b/utils/fs/fs.go @@ -1,3 +1,4 @@ +// Package fs interace and implementations used by storage/filesystem package fs import ( |