Skip to content

Commit

Permalink
specs-go: add missing deprecation comment for Hooks.Prestart
Browse files Browse the repository at this point in the history
Hooks.Prestart was deprecated in c166268
(v1.0.2), but the field did not have a correctly formatted deprecation comment.

This patch updates the field's GoDoc to have a correctly formatted deprecation
comment, which will allow linters and IDEs to detect the deprecation status
of this feature.

Signed-off-by: Sebastiaan van Stijn <[email protected]>
  • Loading branch information
thaJeztah committed Sep 29, 2023
1 parent c0e9043 commit 4005c81
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions specs-go/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,10 @@ type Hook struct {
type Hooks struct {
// Prestart is Deprecated. Prestart is a list of hooks to be run before the container process is executed.
// It is called in the Runtime Namespace
//
// Deprecated: use [Hooks.CreateRuntime], [Hooks.CreateContainer], and
// [Hooks.StartContainer] instead, which allow more granular hook control
// during the create and start phase.
Prestart []Hook `json:"prestart,omitempty"`
// CreateRuntime is a list of hooks to be run after the container has been created but before pivot_root or any equivalent operation has been called
// It is called in the Runtime Namespace
Expand Down

0 comments on commit 4005c81

Please sign in to comment.