From 83f7c869f0db7992f7b7940c2ab3bacc4153d592 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Roth?= Date: Thu, 28 Nov 2024 12:03:42 +0100 Subject: [PATCH] doc: improve cmd usage arguments --- cmd/repo_add.go | 2 +- cmd/repo_include.go | 2 +- cmd/snapshot_create.go | 2 +- cmd/task_run.go | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/cmd/repo_add.go b/cmd/repo_add.go index 8189e783..e7ccfac7 100644 --- a/cmd/repo_add.go +++ b/cmd/repo_add.go @@ -91,7 +91,7 @@ func aptlyRepoAdd(cmd *commander.Command, args []string) error { func makeCmdRepoAdd() *commander.Command { cmd := &commander.Command{ Run: aptlyRepoAdd, - UsageLine: "add | ...", + UsageLine: "add (|)...", Short: "add packages to local repository", Long: ` Command adds packages to local repository from .deb, .udeb (binary packages) and .dsc (source packages) files. diff --git a/cmd/repo_include.go b/cmd/repo_include.go index 72e24c6d..cba3fb30 100644 --- a/cmd/repo_include.go +++ b/cmd/repo_include.go @@ -86,7 +86,7 @@ func aptlyRepoInclude(cmd *commander.Command, args []string) error { func makeCmdRepoInclude() *commander.Command { cmd := &commander.Command{ Run: aptlyRepoInclude, - UsageLine: "include | ...", + UsageLine: "include (|)...", 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 diff --git a/cmd/snapshot_create.go b/cmd/snapshot_create.go index 000a78d9..74e3c966 100644 --- a/cmd/snapshot_create.go +++ b/cmd/snapshot_create.go @@ -84,7 +84,7 @@ func aptlySnapshotCreate(cmd *commander.Command, args []string) error { func makeCmdSnapshotCreate() *commander.Command { cmd := &commander.Command{ Run: aptlySnapshotCreate, - UsageLine: "create from mirror | from repo | empty", + UsageLine: "create (from mirror | from repo | empty)", Short: "creates snapshot of mirror (local repository) contents", Long: ` Command create from mirror makes persistent immutable snapshot of remote diff --git a/cmd/task_run.go b/cmd/task_run.go index ff0e1dd6..50519fe8 100644 --- a/cmd/task_run.go +++ b/cmd/task_run.go @@ -131,7 +131,7 @@ func formatCommands(args []string) [][]string { func makeCmdTaskRun() *commander.Command { cmd := &commander.Command{ Run: aptlyTaskRun, - UsageLine: "run -filename= | , , ...", + UsageLine: "run (-filename= | ...)", Short: "run aptly tasks", Long: ` Command helps organise multiple aptly commands in one single aptly task, running as single thread.