spiegel_podman/cmd/podman/networks/prune.go
Erik Sjölund de92db0c81 man pages and command help: clean up descriptions
Short description in man pages:
* Use imperative form

Command help (cobra.Command.Short):
* Capitalize first letter
* Use imperative form
* Remove ending full stop when the short description
  only contains one sentence without any commas

Command help (cobra.Command.Long):
* Capitalize first letter unless the sentence starts
  with a command "podman command ..."
* Use imperative form when the long description is
  identical or almost identical to the short description.
  This modification was only done in a few places.

Command tables:
* Use imperative form in the "Description" column

[NO NEW TESTS NEEDED]

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-05-28 18:57:43 +02:00

78 lines
2.2 KiB
Go

package network
import (
"bufio"
"fmt"
"os"
"strings"
"github.com/containers/podman/v4/cmd/podman/common"
"github.com/containers/podman/v4/cmd/podman/parse"
"github.com/containers/podman/v4/cmd/podman/registry"
"github.com/containers/podman/v4/cmd/podman/utils"
"github.com/containers/podman/v4/cmd/podman/validate"
"github.com/containers/podman/v4/pkg/domain/entities"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
)
var (
networkPruneDescription = `Prune unused networks`
networkPruneCommand = &cobra.Command{
Use: "prune [options]",
Short: "Prune unused networks",
Long: networkPruneDescription,
RunE: networkPrune,
Example: `podman network prune`,
Args: validate.NoArgs,
ValidArgsFunction: common.AutocompleteNetworks,
}
)
var (
networkPruneOptions entities.NetworkPruneOptions
force bool
filter = []string{}
)
func networkPruneFlags(cmd *cobra.Command, flags *pflag.FlagSet) {
flags.BoolVarP(&force, "force", "f", false, "do not prompt for confirmation")
filterFlagName := "filter"
flags.StringArrayVar(&filter, filterFlagName, []string{}, "Provide filter values (e.g. 'label=<key>=<value>')")
_ = cmd.RegisterFlagCompletionFunc(filterFlagName, common.AutocompletePruneFilters)
}
func init() {
registry.Commands = append(registry.Commands, registry.CliCommand{
Command: networkPruneCommand,
Parent: networkCmd,
})
flags := networkPruneCommand.Flags()
networkPruneFlags(networkPruneCommand, flags)
}
func networkPrune(cmd *cobra.Command, _ []string) error {
var err error
if !force {
reader := bufio.NewReader(os.Stdin)
fmt.Println("WARNING! This will remove all networks not used by at least one container.")
fmt.Print("Are you sure you want to continue? [y/N] ")
answer, err := reader.ReadString('\n')
if err != nil {
return err
}
if strings.ToLower(answer)[0] != 'y' {
return nil
}
}
networkPruneOptions.Filters, err = parse.FilterArgumentsIntoFilters(filter)
if err != nil {
return err
}
responses, err := registry.ContainerEngine().NetworkPrune(registry.Context(), networkPruneOptions)
if err != nil {
setExitCode(err)
return err
}
return utils.PrintNetworkPruneResults(responses, false)
}