9397: Update method documentation for Extract()
authorPeter Amstutz <peter.amstutz@curoverse.com>
Thu, 9 Feb 2017 21:55:10 +0000 (16:55 -0500)
committerPeter Amstutz <peter.amstutz@curoverse.com>
Thu, 9 Feb 2017 21:55:10 +0000 (16:55 -0500)
sdk/go/manifest/manifest.go

index 67bd02bec9db6877adae15453d7404cccf7ddee1..3d4d20817b7a253afd91403bc7541a3f43b075c2 100644 (file)
@@ -463,20 +463,21 @@ func (m segmentedManifest) manifestTextForPath(srcpath, relocate string) string
 // If 'srcpath' and 'relocate' are '.' it simply returns an equivalent manifest
 // in normalized form.
 //
+//   Extract(".", ".")  (return entire normalized manfest text)
+//
 // If 'srcpath' points to a single file, it will return manifest text for just that file.
 // The value of "relocate" is can be used to rename the file or set the file stream.
 //
-// ManifestTextForPath("./foo", ".")  (extract file "foo" and put it in stream ".")
-// ManifestTextForPath("./foo", "./bar")  (extract file "foo", rename it to "bar" in stream ".")
-// ManifestTextForPath("./foo", "./bar/") (extract file "foo", rename it to "./bar/foo")
-// ManifestTextForPath("./foo", "./bar/baz") (extract file "foo", rename it to "./bar/baz")
+//   Extract("./foo", ".")  (extract file "foo" and put it in stream ".")
+//   Extract("./foo", "./bar")  (extract file "foo", rename it to "bar" in stream ".")
+//   Extract("./foo", "./bar/") (extract file "foo", rename it to "./bar/foo")
+//   Extract("./foo", "./bar/baz") (extract file "foo", rename it to "./bar/baz")
 //
 // Otherwise it will return the manifest text for all streams with the prefix in "srcpath" and place
 // them under the path in "relocate".
 //
-// ManifestTextForPath(".", ".")  (return entire normalized manfest text)
-// ManifestTextForPath("./stream", ".")  (extract "./stream" to "." and "./stream/subdir" to "./subdir")
-// ManifestTextForPath("./stream", "./bar")  (extract "./stream" to "./bar" and "./stream/subdir" to "./bar/subdir")
+//   Extract("./stream", ".")  (extract "./stream" to "." and "./stream/subdir" to "./subdir")
+//   Extract("./stream", "./bar")  (extract "./stream" to "./bar" and "./stream/subdir" to "./bar/subdir")
 func (m Manifest) Extract(srcpath, relocate string) (ret Manifest) {
        segmented, err := m.segment()
        if err != nil {