docs: clearer deprecation message for --file (#3310)

It's not clear to users that they shoudl use --output FORMAT=PATH instead of --file. Directly suggest the FORMAT=PATH syntax. Signed-off-by: Will Murphy <[email protected]>
anchore · Oct 10, 2024 · 0c71bf2 · 0c71bf2
1 parent b62b0cb
commit 0c71bf2
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/cmd/syft/internal/options/output_file.go b/cmd/syft/internal/options/output_file.go
@@ -28,7 +28,7 @@ func (o *OutputFile) AddFlags(flags clio.FlagSet) {
 
 		if pfp, ok := flags.(fangs.PFlagSetProvider); ok {
 			flagSet := pfp.PFlagSet()
-			flagSet.Lookup("file").Deprecated = "use: output"
+			flagSet.Lookup("file").Deprecated = "use: --output FORMAT=PATH"
 		}
 	}
 }