From 64ff81575d40764629a2884cdb9e64ece6a6a936 Mon Sep 17 00:00:00 2001 From: jkoberg Date: Wed, 30 Oct 2024 15:06:09 +0100 Subject: [PATCH] docs(postprocessing): update docs Signed-off-by: jkoberg --- services/postprocessing/README.md | 2 ++ services/postprocessing/pkg/command/postprocessing.go | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/services/postprocessing/README.md b/services/postprocessing/README.md index 687c6c02bf..8c0f7c4707 100644 --- a/services/postprocessing/README.md +++ b/services/postprocessing/README.md @@ -99,3 +99,5 @@ ocis postprocessing restart # Restarts all uploads where postproc ocis postprocessing restart -s "finished" # Equivalent to the above ocis postprocessing restart -s "virusscan" # Restart all uploads currently in virusscan step ``` + +Note: All above commands containing the word `restart` can also be replaced by `resume`. This changes behaviour slightly. When `restarting` an upload, the whole postprocessing will be (re)done. If `resuming` an upload, it will only continue from the last step that was completed. diff --git a/services/postprocessing/pkg/command/postprocessing.go b/services/postprocessing/pkg/command/postprocessing.go index b502b87c97..74af6581fa 100644 --- a/services/postprocessing/pkg/command/postprocessing.go +++ b/services/postprocessing/pkg/command/postprocessing.go @@ -17,7 +17,7 @@ func RestartPostprocessing(cfg *config.Config) *cli.Command { return &cli.Command{ Name: "resume", Aliases: []string{"restart"}, - Usage: "restart postprocessing for an uploadID", + Usage: "resume postprocessing for an uploadID", Flags: []cli.Flag{ &cli.StringFlag{ Name: "upload-id",