Skip to content

Commit

Permalink
chore: improving comments based on review
Browse files Browse the repository at this point in the history
  • Loading branch information
tobehn committed Sep 5, 2024
1 parent 34c28cd commit ddd1e3a
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions core/compile.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ func CompileRecipe(recipePath string, runtime string, isRoot bool, origGid int,
return nil
}

// Build a Docker image using the specified recipe
// Build an OCI image using the specified recipe through Docker
func compileDocker(recipe api.Recipe, gid int, uid int) error {
docker, err := exec.LookPath("docker")
if err != nil {
Expand All @@ -76,7 +76,7 @@ func compileDocker(recipe api.Recipe, gid int, uid int) error {
return cmd.Run()
}

// Build a Podman image using the specified recipe
// Build an OCI image using the specified recipe through Podman
func compilePodman(recipe api.Recipe, gid int, uid int) error {
podman, err := exec.LookPath("podman")
if err != nil {
Expand Down
2 changes: 1 addition & 1 deletion core/finalize.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import (
"strings"
)

// Holds configuration for storage drivers
// Configuration for storage drivers
type StorageConf struct {
Driver string
Runroot string
Expand Down
2 changes: 1 addition & 1 deletion core/shell.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
"github.com/vanilla-os/vib/api"
)

// Holds configuration for shell modules
// Configuration for shell modules
type ShellModule struct {
Name string `json:"name"`
Type string `json:"type"`
Expand Down
10 changes: 5 additions & 5 deletions core/structs.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ package core

import "C"

// Holds configuration for a module
// Configuration for a module
type Module struct {
Name string `json:"name"`
Workdir string
Expand All @@ -11,28 +11,28 @@ type Module struct {
Content []byte // The entire module unparsed as a []byte, used by plugins
}

// Holds configuration for finalization steps
// Configuration for finalization steps
type Finalize struct {
Name string `json:"name"`
Type string `json:"type"`
Content []byte // The entire module unparsed as a []byte, used by plugins
}

// Holds configuration for including other modules or recipes
// Configuration for including other modules or recipes
type IncludesModule struct {
Name string `json:"name"`
Type string `json:"type"`
Includes []string `json:"includes"`
}

//Holds information for building a module
// Information for building a module
type ModuleCommand struct {
Name string
Command string
Workdir string
}

// Holds configuration for a plugin
// Configuration for a plugin
type Plugin struct {
Name string
BuildFunc func(*C.char, *C.char) string
Expand Down

0 comments on commit ddd1e3a

Please sign in to comment.