Merge branch 'pack-cmd'

Author: warpfork

CHANGELOG.md

@@ -2,6 +2,7 @@ recent /// not yet released
 ---------------------------
 
 - *your changes here!*
+- Change: `repeatr scan` is now known as `repeatr pack`, because that's a much more accurate description of what it does.
 - Bugfix: Results in a RunRecord are serialized in a consistent order again as they should be.  This was a regression introduced when we moved from "outputs" to the slightly terser "results" structs.
 - Feature: Errors got a facelift and consistency rework.  Many errors are now reported more tersely and helpfully at the command line.  And errors in the API are properly serializable.
   - All of these new error types are exported in the `def` package and are easily serializable, with strongly-typed fields.

cmd/repeatr/main.go

@@ -13,8 +13,8 @@ import (
 	"go.polydawn.net/repeatr/cmd/repeatr/bhv"
 	"go.polydawn.net/repeatr/cmd/repeatr/cfg"
 	"go.polydawn.net/repeatr/cmd/repeatr/examine"
+	"go.polydawn.net/repeatr/cmd/repeatr/pack"
 	"go.polydawn.net/repeatr/cmd/repeatr/run"
-	"go.polydawn.net/repeatr/cmd/repeatr/scan"
 	"go.polydawn.net/repeatr/cmd/repeatr/twerk"
 	"go.polydawn.net/repeatr/cmd/repeatr/unpack"
 	"go.polydawn.net/repeatr/cmd/repeatr/version"
@@ -127,8 +127,8 @@ func Main(
 				Action: unpackCmd.Unpack(stderr),
 			},
 			{
-				Name:  "scan",
-				Usage: "Scan a local filesystem, optionally packing the data into a warehouse",
+				Name:  "pack",
+				Usage: "Scan a local filesystem reporting the hash, and (optionally) packing the data into snapshot form to save in a warehouse",
 				Flags: []cli.Flag{
 					cli.StringFlag{
 						Name:  "place",
@@ -148,7 +148,7 @@ func Main(
 						Usage: "Optional.  Filters to apply when scanning.  If not provided, reasonable defaults (flattening uid, gid, and mtime) will be used.",
 					},
 				},
-				Action: scanCmd.Scan(stdout, stderr),
+				Action: packCmd.Pack(stdout, stderr),
 			},
 			{
 				Name:  "examine",

cmd/repeatr/scan/scan.go renamed to cmd/repeatr/pack/pack.go

@@ -1,4 +1,4 @@
-package scanCmd
+package packCmd
 
 import (
 	"github.com/inconshreveable/log15"
@@ -12,7 +12,7 @@ import (
 	Returns an output specification complete with hash, which can be
 	flipped around and used as an `Input` specification in a `Formula`.
 */
-func scan(outputSpec def.Output, log log15.Logger) def.Output {
+func pack(outputSpec def.Output, log log15.Logger) def.Output {
 	// TODO validate MountPath exists, give nice errors
 
 	// todo: create validity checking api for URIs, check them all before launching anything
@@ -21,8 +21,6 @@ func scan(outputSpec def.Output, log log15.Logger) def.Output {
 		warehouses[i] = rio.SiloURI(wh)
 	}
 
-	// So, this CLI command is *not* in its rights to change the subject area,
-	//  so take that as a pretty strong hint that filters are going to have to pass down *into* transmats.
 	commitID := util.DefaultTransmat().Scan(
 		// All of this stuff that's type-coercing?
 		//  Yeah these are hints that this stuff should be facing data validation.

cmd/repeatr/scan/scanCmd.go renamed to cmd/repeatr/pack/packCmd.go

@@ -1,4 +1,4 @@
-package scanCmd
+package packCmd
 
 import (
 	"fmt"
@@ -13,7 +13,7 @@ import (
 	"go.polydawn.net/repeatr/cmd/repeatr/bhv"
 )
 
-func Scan(stdout, stderr io.Writer) cli.ActionFunc {
+func Pack(stdout, stderr io.Writer) cli.ActionFunc {
 	return func(ctx *cli.Context) error {
 		// args parse
 		var warehouses def.WarehouseCoords
@@ -49,7 +49,7 @@ func Scan(stdout, stderr io.Writer) cli.ActionFunc {
 		// invoke
 		var output def.Output
 		meep.Try(func() {
-			output = scan(outputSpec, log)
+			output = pack(outputSpec, log)
 		}, cmdbhv.TryPlanToExit)
 		// output
 		if err := codec.NewEncoder(stdout, &codec.JsonHandle{Indent: -1}).Encode(output); err != nil {

demo.sh

@@ -39,13 +39,13 @@ echo -e "${clblue} ----------------------------${cnone}\n\n"
 awaitack
 
 
-echo -e "${clblue}# To suck in data, use the scan command:${cnone}"
+echo -e "${clblue}# To suck in data, use the pack command:${cnone}"
 echo
 (
-	tellRunning "repeatr scan --help"
-	time repeatr scan --help
-	tellRunning "repeatr scan --kind=tar"
-	time repeatr scan --kind=tar
+	tellRunning "repeatr pack --help"
+	time repeatr pack --help
+	tellRunning "repeatr pack --kind=tar"
+	time repeatr pack --kind=tar
 )
 echo
 echo -e "${clblue}#  This determines the data identity,${cnone}"