Skip to content

Commit b614412

Browse files
committed
doc(builder.go,git.go,server.go,utils.go): adding proper godoc
1 parent b183450 commit b614412

4 files changed

Lines changed: 6 additions & 5 deletions

File tree

pkg/builder.go

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
// Package builder provides libraries for the Deis builder.
1+
// Package pkg provides common libraries for the Deis builder.
22
//
33
// The Deis builder is responsible for packaging Docker images for consumers.
4-
//
5-
// The builder/cli package contains command line clients for this library.
64
package pkg
75

86
import (

pkg/git/git.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import (
2020
"golang.org/x/crypto/ssh"
2121
)
2222

23-
// PrereceiveHookTmpl is a pre-receive hook.
23+
// PrereceiveHookTpl is a pre-receive hook.
2424
//
2525
// This is overridable. The following template variables are passed into it:
2626
//

pkg/sshd/server.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ const (
3131
ServerConfig string = "ssh.ServerConfig"
3232
)
3333

34-
// PrereceiveHookTmpl is a pre-receive hook.
34+
// PrereceiveHookTpl is a pre-receive hook.
3535
const PrereceiveHookTpl = `#!/bin/bash
3636
strip_remote_prefix() {
3737
stdbuf -i0 -o0 -e0 sed "s/^/"$'\e[1G'"/"

pkg/utils.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,9 @@ func ParseControllerConfig(bytes []byte) ([]string, error) {
110110
}
111111
return retVal, nil
112112
}
113+
114+
// Extract opens sourcefile and, if it has a '.gz' extension, unzips it using a gzip.Reader.
115+
// then, it untars it using a tar.Reader
113116
func Extract(sourcefile string) (err error) {
114117

115118
file, err := os.Open(sourcefile)

0 commit comments

Comments
 (0)