Clarify hotReloadCapable field

Author: feloy

pkg/apis/workspaces/v1alpha1/commands.go

@@ -139,8 +139,11 @@ type ExecCommand struct {
 	Env []EnvVar `json:"env,omitempty" patchStrategy:"merge" patchMergeKey:"name"`
 
 	// +optional
-	// Whether the command is capable to reload itself when source code changes.
-	// If set to `true` the command won't be restarted and it is expected to handle file changes on its own.
+	// Whether the command is restarted when source code changes.
+	// If set to `true` the command won't be restarted.
+	// A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted.
+	// A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again.
+	// This field is ignored for commands other than `build`, `run` or `debug`.
 	//
 	// Default value is `false`
 	HotReloadCapable bool `json:"hotReloadCapable,omitempty"`

pkg/apis/workspaces/v1alpha2/commands.go

@@ -144,8 +144,11 @@ type ExecCommand struct {
 	Env []EnvVar `json:"env,omitempty" patchStrategy:"merge" patchMergeKey:"name"`
 
 	// +optional
-	// Whether the command is capable to reload itself when source code changes.
-	// If set to `true` the command won't be restarted and it is expected to handle file changes on its own.
+	// Whether the command is restarted when source code changes.
+	// If set to `true` the command won't be restarted.
+	// A *hotReloadCapable* `run` or `debug` command is expected to handle file changes on its own and won't be restarted.
+	// A *hotReloadCapable* `build` command is expected to be executed only once and won't be executed again.
+	// This field is ignored for commands other than `build`, `run` or `debug`.
 	//
 	// Default value is `false`
 	// +devfile:default:value=false