Skip to content

Commit a01e79e

Browse files
authored
Merge pull request #114 from shiv-tyagi/fix-gerund
Use 'failed to' prefix for top-level CLI error messages
2 parents f5db41e + 2836d78 commit a01e79e

9 files changed

Lines changed: 25 additions & 25 deletions

File tree

cmd/amd-ctk/cdi/generate/generate.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,19 +72,19 @@ func validateGenOptions(c *cli.Context, genOptions *generateOptions) error {
7272
func performAction(c *cli.Context, genOptions *generateOptions) error {
7373
cdi, err := cdi.New(genOptions.output)
7474
if err != nil {
75-
return fmt.Errorf("creating CDI handler: %w", err)
75+
return fmt.Errorf("failed to create CDI handler: %w", err)
7676
}
7777

7878
// Generate CDI spec
7979
err = cdi.GenerateSpec()
8080
if err != nil {
81-
return fmt.Errorf("generating CDI spec: %w", err)
81+
return fmt.Errorf("failed to generate CDI spec: %w", err)
8282
}
8383

8484
// Write updated CDI spec
8585
err = cdi.WriteSpec()
8686
if err != nil {
87-
return fmt.Errorf("writing CDI spec: %w", err)
87+
return fmt.Errorf("failed to write CDI spec: %w", err)
8888
}
8989

9090
fmt.Printf("Generated CDI spec: %v\n", genOptions.output)

cmd/amd-ctk/cdi/validate/validate.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,14 @@ func validateValOptions(c *cli.Context, valOptions *validateOptions) error {
7272
func performAction(c *cli.Context, valOptions *validateOptions) error {
7373
cdi, err := cdi.New(valOptions.cdiSpecPath)
7474
if err != nil {
75-
return fmt.Errorf("creating CDI handler: %w", err)
75+
return fmt.Errorf("failed to create CDI handler: %w", err)
7676
}
7777

7878
// Validate CDI spec
7979
fmt.Printf("Validating CDI spec: %v\n", valOptions.cdiSpecPath)
8080
result, err := cdi.ValidateSpec()
8181
if err != nil {
82-
return fmt.Errorf("validating CDI spec: %w", err)
82+
return fmt.Errorf("failed to validate CDI spec: %w", err)
8383
}
8484
if result {
8585
fmt.Println("CDI spec is valid")

cmd/amd-ctk/gpu-tracker/disable/disable.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,12 @@ func validateGenOptions(c *cli.Context) error {
5353
func performAction(c *cli.Context) error {
5454
gpuTracker, err := gpuTracker.New()
5555
if err != nil {
56-
return fmt.Errorf("creating GPU tracker: %w", err)
56+
return fmt.Errorf("failed to create GPU Tracker: %w", err)
5757
}
5858

5959
enabled, err := gpuTracker.IsEnabled()
6060
if err != nil {
61-
return fmt.Errorf("checking GPU Tracker status: %w", err)
61+
return fmt.Errorf("failed to check GPU Tracker status: %w", err)
6262
}
6363
if !enabled {
6464
fmt.Println("GPU Tracker is already disabled")
@@ -67,7 +67,7 @@ func performAction(c *cli.Context) error {
6767

6868
err = gpuTracker.Disable()
6969
if err != nil {
70-
return fmt.Errorf("disabling GPU Tracker: %w", err)
70+
return fmt.Errorf("failed to disable GPU Tracker: %w", err)
7171
}
7272

7373
fmt.Println("GPU Tracker has been disabled")

cmd/amd-ctk/gpu-tracker/enable/enable.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,12 @@ func validateGenOptions(c *cli.Context) error {
5353
func performAction(c *cli.Context) error {
5454
gpuTracker, err := gpuTracker.New()
5555
if err != nil {
56-
return fmt.Errorf("creating GPU tracker: %w", err)
56+
return fmt.Errorf("failed to create GPU Tracker: %w", err)
5757
}
5858

5959
enabled, err := gpuTracker.IsEnabled()
6060
if err != nil {
61-
return fmt.Errorf("checking GPU Tracker status: %w", err)
61+
return fmt.Errorf("failed to check GPU Tracker status: %w", err)
6262
}
6363
if enabled {
6464
fmt.Println("GPU Tracker is already enabled")
@@ -67,7 +67,7 @@ func performAction(c *cli.Context) error {
6767

6868
err = gpuTracker.Enable()
6969
if err != nil {
70-
return fmt.Errorf("enabling GPU Tracker: %w", err)
70+
return fmt.Errorf("failed to enable GPU Tracker: %w", err)
7171
}
7272

7373
fmt.Println("GPU Tracker has been enabled")

cmd/amd-ctk/gpu-tracker/gpu-tracker.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,12 +91,12 @@ func performAction(c *cli.Context) error {
9191

9292
gpuTracker, err := gpuTrackerLib.New()
9393
if err != nil {
94-
return fmt.Errorf("creating GPU tracker: %w", err)
94+
return fmt.Errorf("failed to create GPU Tracker: %w", err)
9595
}
9696

9797
enabled, err := gpuTracker.IsEnabled()
9898
if err != nil {
99-
return fmt.Errorf("checking GPU Tracker status: %w", err)
99+
return fmt.Errorf("failed to check GPU Tracker status: %w", err)
100100
}
101101
if !enabled {
102102
fmt.Println("GPU Tracker is disabled")
@@ -108,7 +108,7 @@ func performAction(c *cli.Context) error {
108108
case "exclusive":
109109
res, err = gpuTracker.MakeGPUsExclusive(gpuIDs)
110110
if err != nil {
111-
return fmt.Errorf("making GPUs %s exclusive: %w", gpuIDs, err)
111+
return fmt.Errorf("failed to make GPUs %s exclusive: %w", gpuIDs, err)
112112
}
113113
if len(res.Changed) > 0 {
114114
fmt.Printf("GPUs %v have been made exclusive\n", res.Changed)
@@ -119,7 +119,7 @@ func performAction(c *cli.Context) error {
119119
case "shared":
120120
res, err = gpuTracker.MakeGPUsShared(gpuIDs)
121121
if err != nil {
122-
return fmt.Errorf("making GPUs %s shared: %w", gpuIDs, err)
122+
return fmt.Errorf("failed to make GPUs %s shared: %w", gpuIDs, err)
123123
}
124124
if len(res.Changed) > 0 {
125125
fmt.Printf("GPUs %v have been made shared\n", res.Changed)

cmd/amd-ctk/gpu-tracker/initialize/initialize.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,12 @@ func validateGenOptions(c *cli.Context) error {
5454
func performAction(c *cli.Context) error {
5555
gpuTracker, err := gpuTracker.New()
5656
if err != nil {
57-
return fmt.Errorf("creating GPU tracker: %w", err)
57+
return fmt.Errorf("failed to create GPU Tracker: %w", err)
5858
}
5959

6060
err = gpuTracker.Init()
6161
if err != nil {
62-
return fmt.Errorf("initializing GPU Tracker: %w", err)
62+
return fmt.Errorf("failed to initialize GPU Tracker: %w", err)
6363
}
6464

6565
return nil

cmd/amd-ctk/gpu-tracker/release/release.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,13 @@ func performAction(c *cli.Context) error {
6464

6565
gpuTracker, err := gpuTracker.New()
6666
if err != nil {
67-
return fmt.Errorf("creating GPU tracker: %w", err)
67+
return fmt.Errorf("failed to create GPU Tracker: %w", err)
6868
}
6969

7070
containerId := c.Args().Get(0)
7171
err = gpuTracker.ReleaseGPUs(containerId)
7272
if err != nil {
73-
return fmt.Errorf("releasing GPUs for container %s: %w", containerId, err)
73+
return fmt.Errorf("failed to release GPUs for container %s: %w", containerId, err)
7474
}
7575

7676
return nil

cmd/amd-ctk/gpu-tracker/reset/reset.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,17 +53,17 @@ func validateGenOptions(c *cli.Context) error {
5353
func performAction(c *cli.Context) error {
5454
gpuTracker, err := gpuTracker.New()
5555
if err != nil {
56-
return fmt.Errorf("creating GPU tracker: %w", err)
56+
return fmt.Errorf("failed to create GPU Tracker: %w", err)
5757
}
5858

5959
wasEnabled, err := gpuTracker.IsEnabled()
6060
if err != nil {
61-
return fmt.Errorf("checking GPU Tracker status: %w", err)
61+
return fmt.Errorf("failed to check GPU Tracker status: %w", err)
6262
}
6363

6464
err = gpuTracker.Reset()
6565
if err != nil {
66-
return fmt.Errorf("resetting GPU Tracker: %w", err)
66+
return fmt.Errorf("failed to reset GPU Tracker: %w", err)
6767
}
6868

6969
fmt.Println("GPU Tracker has been reset")

cmd/amd-ctk/gpu-tracker/status/status.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,12 @@ func validateGenOptions(c *cli.Context) error {
5454
func performAction(c *cli.Context) error {
5555
tracker, err := gpuTracker.New()
5656
if err != nil {
57-
return fmt.Errorf("creating GPU tracker: %w", err)
57+
return fmt.Errorf("failed to create GPU Tracker: %w", err)
5858
}
5959

6060
enabled, err := tracker.IsEnabled()
6161
if err != nil {
62-
return fmt.Errorf("checking GPU Tracker status: %w", err)
62+
return fmt.Errorf("failed to check GPU Tracker status: %w", err)
6363
}
6464
if !enabled {
6565
fmt.Println("GPU Tracker is disabled")
@@ -68,7 +68,7 @@ func performAction(c *cli.Context) error {
6868

6969
entries, err := tracker.ShowStatus()
7070
if err != nil {
71-
return fmt.Errorf("showing GPU status: %w", err)
71+
return fmt.Errorf("failed to show GPU Tracker status: %w", err)
7272
}
7373

7474
fmt.Println(strings.Repeat("-", 120))

0 commit comments

Comments
 (0)