Merge pull request #2199 from alexlarsson/dm-docs

Add some docs for newly exported functions
Upstream-commit: 5892c8e46950268faa9cc02b611a71d0a182d47c
Component: engine

components/engine/changes.go

@@ -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 {

components/engine/utils/utils.go

@@ -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 {