summaryrefslogtreecommitdiffstats
path: root/debputy.pod
diff options
context:
space:
mode:
Diffstat (limited to 'debputy.pod')
-rw-r--r--debputy.pod15
1 files changed, 15 insertions, 0 deletions
diff --git a/debputy.pod b/debputy.pod
index 0cee740..c53fa23 100644
--- a/debputy.pod
+++ b/debputy.pod
@@ -171,6 +171,21 @@ providing the results.
If you rely on the exit code, you are recommended to explicitly pass the relevant variant of the
flag even if the current default matches your wishes.
+=item B<--missing-style-is-ok>
+
+By default, B<debputy reformat> will exit with an error when it cannot determine which style to
+use. This is generally what you want for "per package" CI or other lint checks to inform you that
+the reformatting will not work.
+
+However, for "cross package" pipelines, like the default Debian Salsa CI pipeline, having
+B<debputy reformat> automatically work when a style is set and doing nothing otherwise is
+preferable, since the pipeline can then provide a B<debputy reformat> job for all consumers
+without worrying about breaking their pipelines.
+
+It can also be useful for scripts or automated mass-edits where you want B<debputy> to fixup
+the changes you did if there is a known style without being hampered by the packages that
+have no known style.
+
=back
=item lint