bootcfg/: Rename and document packages with their purpose (#145)

bootcfg/cli/doc.go

@@ -0,0 +1,2 @@
+// Package cli provides a command line interface client.
+package cli

bootcfg/cli/error.go

@@ -1,4 +1,4 @@
-package cmd
+package cli
 
 import (
 	"fmt"

bootcfg/cli/format.go

@@ -1,4 +1,4 @@
-package cmd
+package cli
 
 import (
 	"io"

bootcfg/cli/group.go

@@ -1,4 +1,4 @@
-package cmd
+package cli
 
 import (
 	"github.com/spf13/cobra"

bootcfg/cli/group_create.go

@@ -1,4 +1,4 @@
-package cmd
+package cli
 
 import (
 	"io/ioutil"

bootcfg/cli/group_describe.go

@@ -1,4 +1,4 @@
-package cmd
+package cli
 
 import (
 	"fmt"

bootcfg/cli/group_list.go

@@ -1,4 +1,4 @@
-package cmd
+package cli
 
 import (
 	"fmt"

bootcfg/cli/instance.go

@@ -1,4 +1,4 @@
-package cmd
+package cli
 
 import (
 	"github.com/spf13/cobra"

bootcfg/cli/instance_list.go

@@ -1,4 +1,4 @@
-package cmd
+package cli
 
 import (
 	"fmt"

bootcfg/cli/profile.go

@@ -1,4 +1,4 @@
-package cmd
+package cli
 
 import (
 	"github.com/spf13/cobra"

bootcfg/cli/profile_create.go

@@ -1,4 +1,4 @@
-package cmd
+package cli
 
 import (
 	"io/ioutil"

bootcfg/cli/profile_describe.go

@@ -1,4 +1,4 @@
-package cmd
+package cli
 
 import (
 	"fmt"

bootcfg/cli/profile_list.go

@@ -1,4 +1,4 @@
-package cmd
+package cli
 
 import (
 	"fmt"

bootcfg/cli/root.go

@@ -1,4 +1,4 @@
-package cmd
+package cli
 
 import (
 	"fmt"

bootcfg/cli/version.go

@@ -1,4 +1,4 @@
-package cmd
+package cli
 
 import (
 	"fmt"

bootcfg/client/doc.go

@@ -0,0 +1,2 @@
+// Package client provides the bootcfg gRPC client.
+package client

bootcfg/http/cloud.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"bytes"

bootcfg/http/cloud_test.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"net/http"

bootcfg/http/context.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"errors"

bootcfg/http/context_test.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"testing"

bootcfg/http/doc.go

@@ -0,0 +1,2 @@
+// Package http provides the bootcfg HTTP server
+package http

bootcfg/http/grub.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"bytes"

bootcfg/http/handlers.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"net/http"

bootcfg/http/handlers_test.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"fmt"

bootcfg/http/http.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"net"

bootcfg/http/http_test.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"fmt"

bootcfg/http/ignition.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"bytes"

bootcfg/http/ignition_test.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"net/http"

bootcfg/http/ipxe.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"bytes"

bootcfg/http/ipxe_test.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"net/http"

bootcfg/http/metadata.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"encoding/json"

bootcfg/http/metadata_test.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"bufio"

bootcfg/http/pixiecore.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"net/http"

bootcfg/http/pixiecore_test.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"net/http"

bootcfg/http/serialize.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"encoding/json"

bootcfg/http/serialize_test.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"fmt"

bootcfg/http/server.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"net/http"

bootcfg/http/test_fixtures.go

@@ -1,4 +1,4 @@
-package api
+package http
 
 import (
 	"github.com/coreos/coreos-baremetal/bootcfg/storage/storagepb"

bootcfg/rpc/doc.go

@@ -0,0 +1,2 @@
+// Package rpc provides the bootcfg gRPC server
+package rpc

bootcfg/server/doc.go

@@ -0,0 +1,2 @@
+// Package server is a bootcfg library package for implementing servers.
+package server

bootcfg/sign/doc.go

@@ -0,0 +1,2 @@
+// Package sign adds signatures to bootcfg responses.
+package sign

bootcfg/storage/doc.go

@@ -0,0 +1,2 @@
+// Package storage defines bootcfg's storage and object types.
+package storage

cmd/bootcfg/main.go

@@ -12,7 +12,7 @@ import (
 	"github.com/coreos/pkg/capnslog"
 	"github.com/coreos/pkg/flagutil"
 
-	"github.com/coreos/coreos-baremetal/bootcfg/api"
+	web "github.com/coreos/coreos-baremetal/bootcfg/http"
 	"github.com/coreos/coreos-baremetal/bootcfg/rpc"
 	"github.com/coreos/coreos-baremetal/bootcfg/server"
 	"github.com/coreos/coreos-baremetal/bootcfg/sign"
@@ -100,13 +100,13 @@ func main() {
 		Root: flags.dataPath,
 	})
 
-	bootcfgServer := server.NewServer(&server.Config{
+	server := server.NewServer(&server.Config{
 		Store: store,
 	})
 
 	// gRPC Server (feature hidden)
 	if flags.rpcAddress != "" {
-		grpcServer, err := rpc.NewServer(bootcfgServer)
+		grpcServer, err := rpc.NewServer(server)
 		if err != nil {
 			log.Fatal(err)
 		}
@@ -120,13 +120,13 @@ func main() {
 	}
 
 	// HTTP Server
-	config := &api.Config{
+	config := &web.Config{
 		Store:         store,
 		AssetsPath:    flags.assetsPath,
 		Signer:        signer,
 		ArmoredSigner: armoredSigner,
 	}
-	httpServer := api.NewServer(config)
+	httpServer := web.NewServer(config)
 	log.Infof("starting bootcfg HTTP server on %s", flags.address)
 	err = http.ListenAndServe(flags.address, httpServer.HTTPHandler())
 	if err != nil {

cmd/bootcmd/main.go

@@ -3,5 +3,5 @@ package main
 import "github.com/coreos/coreos-baremetal/bootcfg/cli"
 
 func main() {
-	cmd.Execute()
+	cli.Execute()
 }