Skip to content

Commit 99fc201

Browse files
austinvazquezKern--
authored andcommitted
Update SOCI rebuild DB CLI help text and doc
Removes rpull command reference from help text which support has been removed. Aligns help text in CLI and documentation to match. Signed-off-by: Austin Vazquez <[email protected]>
1 parent 95695e2 commit 99fc201

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

cmd/soci/commands/rebuild_db.go

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,13 @@ import (
2727

2828
var RebuildDBCommand = cli.Command{
2929
Name: "rebuild-db",
30-
Usage: `rebuild the artifacts database. You should use this command after "rpull" so that indices/ztocs can be discovered by commands like "soci index list", and after "index rm" when using the containerd content store so that deleted orphaned zTOCs will be forgotten`,
30+
Usage: "rebuilds the artifacts database",
31+
UsageText: `
32+
soci [global options] rebuild-db
33+
34+
Use after pulling an image to discover SOCI indices/ztocs or after "index rm"
35+
when using the containerd content store to clear the database of removed zTOCs.
36+
`,
3137
Action: func(cliContext *cli.Context) error {
3238
client, ctx, cancel, err := internal.NewClient(cliContext)
3339
if err != nil {

docs/cli-usage.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ soci push public.ecr.aws/soci-workshop-examples/ffmpeg:latest
6161
```
6262

6363
### soci rebuild_db
64-
Use this command after image pull so that indices/ztocs can be discovered by commands like "```soci index list```", and after "```index rm```" when using the containerd content store so that deleted orphaned zTOCs will be forgotten
64+
Use after pulling an image to discover SOCI indices/ztocs or after "```index rm```"
65+
when using the containerd content store to clear the database of removed zTOCs.
6566

6667
**Example:**
6768
```

0 commit comments

Comments
 (0)