diff --git a/client/client.go b/client/client.go index fe3f9d0c52..4455b62776 100644 --- a/client/client.go +++ b/client/client.go @@ -418,12 +418,12 @@ func (r *NotaryRepository) ListTargets(roles ...string) ([]*TargetWithRole, erro return targetList, nil } -// GetTargetByName returns a target given a name. If no roles are passed +// GetTargetByName returns a target by the given name. If no roles are passed // it uses the targets role and does a search of the entire delegation // graph, finding the first entry in a breadth first search of the delegations. // If roles are passed, they should be passed in descending priority and // the target entry found in the subtree of the highest priority role -// will be returned +// will be returned. // See the IMPORTANT section on ListTargets above. Those roles also apply here. func (r *NotaryRepository) GetTargetByName(name string, roles ...string) (*TargetWithRole, error) { if err := r.Update(false); err != nil { diff --git a/client/repo.go b/client/repo.go index 1612611702..1a8702db1b 100644 --- a/client/repo.go +++ b/client/repo.go @@ -13,7 +13,8 @@ import ( // NewNotaryRepository is a helper method that returns a new notary repository. // It takes the base directory under where all the trust files will be stored -// (usually ~/.docker/trust/). +// (This is normally defaults to "~/.notary" or "~/.docker/trust" when enabling +// docker content trust). func NewNotaryRepository(baseDir, gun, baseURL string, rt http.RoundTripper, retriever passphrase.Retriever, trustPinning trustpinning.TrustPinConfig) ( *NotaryRepository, error) { diff --git a/cmd/notary-signer/main.go b/cmd/notary-signer/main.go index 87e69dfe76..864863da79 100644 --- a/cmd/notary-signer/main.go +++ b/cmd/notary-signer/main.go @@ -27,7 +27,7 @@ var ( func init() { // Setup flags flag.StringVar(&configFile, "config", "", "Path to configuration file") - flag.BoolVar(&debug, "debug", false, "show the version and exit") + flag.BoolVar(&debug, "debug", false, "Show the version and exit") flag.StringVar(&logFormat, "logf", "json", "Set the format of the logs. Only 'json' and 'logfmt' are supported at the moment.") flag.BoolVar(&doBootstrap, "bootstrap", false, "Do any necessary setup of configured backend storage services") diff --git a/cmd/notary/main.go b/cmd/notary/main.go index a97fd3a4b5..e9fd7f8f8b 100644 --- a/cmd/notary/main.go +++ b/cmd/notary/main.go @@ -152,7 +152,7 @@ func (n *notaryCommander) GetCommand() *cobra.Command { notaryCmd.AddCommand(&cobra.Command{ Use: "version", Short: "Print the version number of notary", - Long: `print the version number of notary`, + Long: "Print the version number of notary", Run: func(cmd *cobra.Command, args []string) { fmt.Printf("notary\n Version: %s\n Git commit: %s\n", version.NotaryVersion, version.GitCommit) },