Add some docs for newly exported functions

This commit is contained in:
Alexander Larsson 2013-10-14 10:53:12 +02:00
parent 48070274ee
commit 8e4b3a3390
2 changed files with 5 additions and 0 deletions

View file

@ -283,6 +283,8 @@ func collectFileInfo(sourceDir string) (*FileInfo, error) {
return root, nil
}
// Compare a directory with an array of layer directories it was based on and
// generate an array of Change objects describing the changes
func ChangesLayers(newDir string, layers []string) ([]Change, error) {
newRoot, err := collectFileInfo(newDir)
if err != nil {
@ -299,6 +301,7 @@ func ChangesLayers(newDir string, layers []string) ([]Change, error) {
return newRoot.Changes(oldRoot), nil
}
// Compare two directories and generate an array of Change objects describing the changes
func ChangesDirs(newDir, oldDir string) ([]Change, error) {
oldRoot, err := collectFileInfo(oldDir)
if err != nil {

View file

@ -1051,6 +1051,8 @@ func quote(word string, buf *bytes.Buffer) {
buf.WriteString("'")
}
// Take a list of strings and escape them so they will be handled right
// when passed as arguments to an program via a shell
func ShellQuoteArguments(args []string) string {
var buf bytes.Buffer
for i, arg := range args {