Skip to content

Commit

Permalink
doc: improve cmd usage arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
neolynx committed Nov 28, 2024
1 parent 0fab36f commit f9e5e8a
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion cmd/repo_add.go
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ func aptlyRepoAdd(cmd *commander.Command, args []string) error {
func makeCmdRepoAdd() *commander.Command {
cmd := &commander.Command{
Run: aptlyRepoAdd,
UsageLine: "add <name> <package file.deb>|<directory> ...",
UsageLine: "add <name> (<package file.deb>|<directory>)...",
Short: "add packages to local repository",
Long: `
Command adds packages to local repository from .deb, .udeb (binary packages) and .dsc (source packages) files.
Expand Down
2 changes: 1 addition & 1 deletion cmd/repo_include.go
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ func aptlyRepoInclude(cmd *commander.Command, args []string) error {
func makeCmdRepoInclude() *commander.Command {
cmd := &commander.Command{
Run: aptlyRepoInclude,
UsageLine: "include <file.changes>|<directory> ...",
UsageLine: "include (<file.changes>|<directory>)...",
Short: "add packages to local repositories based on .changes files",
Long: `
Command include looks for .changes files in list of arguments or specified directories. Each
Expand Down
2 changes: 1 addition & 1 deletion cmd/snapshot_create.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ func aptlySnapshotCreate(cmd *commander.Command, args []string) error {
func makeCmdSnapshotCreate() *commander.Command {
cmd := &commander.Command{
Run: aptlySnapshotCreate,
UsageLine: "create <name> from mirror <mirror-name> | from repo <repo-name> | empty",
UsageLine: "create <name> (from mirror <mirror-name> | from repo <repo-name> | empty)",
Short: "creates snapshot of mirror (local repository) contents",
Long: `
Command create <name> from mirror makes persistent immutable snapshot of remote
Expand Down
2 changes: 1 addition & 1 deletion cmd/task_run.go
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ func formatCommands(args []string) [][]string {
func makeCmdTaskRun() *commander.Command {
cmd := &commander.Command{
Run: aptlyTaskRun,
UsageLine: "run -filename=<filename> | <command1>, <command2>, ...",
UsageLine: "run (-filename=<filename> | <commands>...)",
Short: "run aptly tasks",
Long: `
Command helps organise multiple aptly commands in one single aptly task, running as single thread.
Expand Down

0 comments on commit f9e5e8a

Please sign in to comment.