diff --git a/cmd_mirror.go b/cmd_mirror.go index 23d351e9..73e100e2 100644 --- a/cmd_mirror.go +++ b/cmd_mirror.go @@ -156,7 +156,10 @@ func makeCmdMirrorCreate() *commander.Command { UsageLine: "create [ ...]", Short: "create new mirror of Debian repository", Long: ` -Create only stores metadata about new mirror, and fetches Release files (it doesn't download packages) +Create records information about new mirror and fetches Release file (it doesn't download packages). + +ex: + $ aptly mirror create wheezy-main http://mirror.yandex.ru/debian/ wheezy main `, Flag: *flag.NewFlagSet("aptly-mirror-create", flag.ExitOnError), } @@ -170,7 +173,7 @@ func makeCmdMirrorList() *commander.Command { UsageLine: "list", Short: "list mirrors of remote repositories", Long: ` -list shows full list of remote repositories. +List shows full list of remote repositories. ex: $ aptly mirror list @@ -188,7 +191,10 @@ func makeCmdMirrorShow() *commander.Command { UsageLine: "show ", Short: "show details about remote repository mirror", Long: ` -show shows full information about mirror. +Show shows full information about mirror. + +ex: + $ aptly mirror show wheezy-main `, Flag: *flag.NewFlagSet("aptly-mirror-show", flag.ExitOnError), } @@ -202,7 +208,10 @@ func makeCmdMirrorUpdate() *commander.Command { UsageLine: "update ", Short: "update packages from remote mirror", Long: ` -Update downloads list of packages and packages themselves. +Update downloads list of packages and package files. + +ex: + $ aptly mirror update wheezy-main `, Flag: *flag.NewFlagSet("aptly-mirror-update", flag.ExitOnError), } diff --git a/cmd_publish.go b/cmd_publish.go index 1e686a95..96851141 100644 --- a/cmd_publish.go +++ b/cmd_publish.go @@ -175,7 +175,10 @@ func makeCmdPublishSnapshot() *commander.Command { UsageLine: "snapshot []", Short: "makes Debian repository out of snapshot", Long: ` -Publishes snapshot as Debian repository ready to be used by apt tools. +Command publish oublishes snapshot as Debian repository ready to be used by apt tools. + +ex. + $ aptly publish snapshot wheezy-main `, Flag: *flag.NewFlagSet("aptly-publish-snapshot", flag.ExitOnError), } @@ -192,7 +195,10 @@ func makeCmdPublishDrop() *commander.Command { UsageLine: "drop []", Short: "removes files of published repository", Long: ` -Removes whatever has been published under specified prefix and distribution name. +Command removes whatever has been published under specified prefix and distribution name. + +ex. + $ aptly publish drop wheezy `, Flag: *flag.NewFlagSet("aptly-publish-drop", flag.ExitOnError), } @@ -206,7 +212,10 @@ func makeCmdPublishList() *commander.Command { UsageLine: "list", Short: "displays list of published repositories", Long: ` -Displays list of currently published snapshots. +Display command displays list of currently published snapshots with information about published root. + +ex. + $ aptly publish list `, Flag: *flag.NewFlagSet("aptly-publish-list", flag.ExitOnError), } diff --git a/cmd_snapshot.go b/cmd_snapshot.go index 259146b2..b9465811 100644 --- a/cmd_snapshot.go +++ b/cmd_snapshot.go @@ -505,7 +505,11 @@ func makeCmdSnapshotCreate() *commander.Command { UsageLine: "create from mirror ", Short: "creates snapshot out of any mirror", Long: ` -Create makes persistent immutable snapshot of repository mirror state in givent moment of time. +Command create makes persistent immutable snapshot of remote repository mirror. Snapshot could be +published or further modified using merge, pull and other aptly features. + +ex. + $ aptly snapshot create wheezy-main-today from mirror wheezy-main `, Flag: *flag.NewFlagSet("aptly-snapshot-create", flag.ExitOnError), } @@ -520,7 +524,7 @@ func makeCmdSnapshotList() *commander.Command { UsageLine: "list", Short: "lists snapshots", Long: ` -list shows full list of snapshots created. +Command list shows full list of snapshots created. ex: $ aptly snapshot list @@ -537,7 +541,10 @@ func makeCmdSnapshotShow() *commander.Command { UsageLine: "show ", Short: "shows details about snapshot", Long: ` -Show shows full information about snapshot. +Command show displays full information about snapshot. + +ex. + $ aptly snapshot show wheezy-main `, Flag: *flag.NewFlagSet("aptly-snapshot-show", flag.ExitOnError), } @@ -553,6 +560,9 @@ func makeCmdSnapshotVerify() *commander.Command { Long: ` Verify does depenency resolution in snapshot, possibly using additional snapshots as dependency sources. All unsatisfied dependencies are returned. + +ex. + $ aptly snapshot verify wheezy-main wheezy-contrib wheezy-non-free `, Flag: *flag.NewFlagSet("aptly-snapshot-verify", flag.ExitOnError), } @@ -566,10 +576,13 @@ func makeCmdSnapshotPull() *commander.Command { UsageLine: "pull ...", Short: "performs partial upgrades (pulls new packages) from another snapshot", Long: ` -Pulls new packages along with its dependencies in snapshot +Command pull pulls new packages along with its dependencies in snapshot from snapshot. Also can upgrade package version from one snapshot into another, once again along with dependencies. New snapshot is created as result of this -process. +process. Packages could be specified simply as 'package-name' or as dependency 'package-name (>= version)'. + +ex. + $ aptly snapshot pull wheezy-main wheezy-backports wheezy-new-xorg xorg-server-server `, Flag: *flag.NewFlagSet("aptly-snapshot-pull", flag.ExitOnError), } @@ -586,7 +599,10 @@ func makeCmdSnapshotDiff() *commander.Command { UsageLine: "diff ", Short: "calculates difference in packages between two snapshots", Long: ` -Displays list of missing and new packages, difference in package versions between two snapshots. +Command diff shows list of missing and new packages, difference in package versions between two snapshots. + +ex. + $ aptly snapshot diff -only-matching wheezy-main wheezy-backports `, Flag: *flag.NewFlagSet("aptly-snapshot-diff", flag.ExitOnError), } @@ -604,7 +620,10 @@ func makeCmdSnapshotMerge() *commander.Command { Long: ` Merge merges several snapshots into one. Merge happens from left to right. Packages with the same name-architecture pair are replaced during merge (package from latest snapshot on the list wins). -If specified with only one snapshot, merge copies source into destination. +If run with only one source snapshot, merge copies source into destination. + +ex. + $ aptly snapshot merge wheezy-w-backports wheezy-main wheezy-backports `, Flag: *flag.NewFlagSet("aptly-snapshot-merge", flag.ExitOnError), } diff --git a/main.go b/main.go index c37aa5ec..302fc379 100644 --- a/main.go +++ b/main.go @@ -22,7 +22,7 @@ func init() { UsageLine: os.Args[0], Short: "Debian repository management tool", Long: ` -aptly allows to create partial and full mirrors of remote +aptly is a tool to create partial and full mirrors of remote repositories, filter them, merge, upgrade individual packages, take snapshots and publish them back as Debian repositories.`, Flag: *flag.NewFlagSet("aptly", flag.ExitOnError), diff --git a/system/t03_help/MainHelpTest_gold b/system/t03_help/MainHelpTest_gold index 7da06ac0..f40fb253 100644 --- a/system/t03_help/MainHelpTest_gold +++ b/system/t03_help/MainHelpTest_gold @@ -1,4 +1,4 @@ -aptly allows to create partial and full mirrors of remote +aptly is a tool to create partial and full mirrors of remote repositories, filter them, merge, upgrade individual packages, take snapshots and publish them back as Debian repositories. diff --git a/system/t03_help/MirrorCreateHelpTest_gold b/system/t03_help/MirrorCreateHelpTest_gold index 50d95c7a..79e9dfaf 100644 --- a/system/t03_help/MirrorCreateHelpTest_gold +++ b/system/t03_help/MirrorCreateHelpTest_gold @@ -1,4 +1,7 @@ Usage: aptly mirror create [ ...] -Create only stores metadata about new mirror, and fetches Release files (it doesn't download packages) +Create records information about new mirror and fetches Release file (it doesn't download packages). + +ex: + $ aptly mirror create wheezy-main http://mirror.yandex.ru/debian/ wheezy main