From 7dd48a69963b3634d1117d9a7d2bbb757626e173 Mon Sep 17 00:00:00 2001 From: tommy shem Date: Sun, 10 Nov 2024 22:30:10 +0000 Subject: [PATCH] updated comments Signed-off-by: tommy shem --- cmd/bbolt/command_buckets.go | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/cmd/bbolt/command_buckets.go b/cmd/bbolt/command_buckets.go index af189204f..18153850f 100644 --- a/cmd/bbolt/command_buckets.go +++ b/cmd/bbolt/command_buckets.go @@ -8,24 +8,28 @@ import ( bolt "go.etcd.io/bbolt" ) -// bucketsCmd represents the buckets command +// newBucketsCommand creates a new command that prints a list of buckets in the given Bolt database. +// +// The path to a Bolt database must be specified as an argument. func newBucketsCommand() *cobra.Command { var bucketsCmd = &cobra.Command{ Use: "buckets ", Short: "Print a list of buckets", + Long: "Print a list of buckets in the given Bolt database\nThe path to a Bolt database must be specified as an argument", Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { - return bucketsfunc(args[0]) + return printBucketsList(args[0]) }, } return bucketsCmd } -// Run executes the command. -func bucketsfunc(path string) error { - // Require database path. +// printBucketsList prints a list of buckets in the given Bolt database. +func printBucketsList(path string) error { + // Required database path. if path == "" { return ErrPathRequired + // Verify if the specified database file exists. } else if _, err := os.Stat(path); os.IsNotExist(err) { return ErrFileNotFound } @@ -37,7 +41,7 @@ func bucketsfunc(path string) error { } defer db.Close() - // Print buckets. + // Print the list of buckets in the database. return db.View(func(tx *bolt.Tx) error { return tx.ForEach(func(name []byte, _ *bolt.Bucket) error { fmt.Fprintln(os.Stdout, string(name))