diff options
Diffstat (limited to 'debputy.pod')
| -rw-r--r-- | debputy.pod | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/debputy.pod b/debputy.pod index 3687398..f27c15f 100644 --- a/debputy.pod +++ b/debputy.pod @@ -248,6 +248,30 @@ 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<--lint-report-format> I<term|junit-xml> + +Choose the output format of the resulting report. The B<term> report is a terminal output report. +The B<junit-xml> writes the output to an XML in a JUnit 4 format (should be compatible with +the xunit2 family of JUnit4 style input). This is useful for GitLab CI pipelines to get the +results imported via GitLab's B<junit> CI pipeline feature. + +=item B<--report-output> I<DEST> + +For reports that generate file system artifacts, choose where the output should be placed. + +Ignored with a warning for formats that do not generate file system outputs such as the +B<term> report format. + +=item B<--warn-about-check-manifest>, B<--no-warn-about-check-manifest> + +Whether B<debputy lint> should remind you that it has short comings in regards to validating +the B<debian/debputy.manifest> file. The warning will only appear if the manifest file exists. +That is, the options have no effect either way when the file is not present. + +The B<--no-warn-about-check-manifest> is mostly used for generic pipelines that separately +call B<debputy check-manifest> to ensure that the manifest is also validated or for cases +where the limitation is known and accepted. + =back A short comparison of B<debputy lint> vs. other tools: @@ -324,36 +348,12 @@ known variations such as B<debian-control> (as used by B<eglot> from B<emacs>) a B<debcontrol> (as used by B<vim>). See B<debputy lsp features> for a list of known language IDs along with their aliases. -When properly set up, the language server will offer a variety of features such as: - -=over 4 - -=item - - -Completion suggestion such as field names or values in deb822 based files. - -=item - - -Hover documentation for fields in deb822-based files. - -=item - - -Diagnostics ("linting"). In many cases, B<debputy> will also provide quickfixes for the issues. - -This feature is also (partly) available via the B<debputy lint> command. The primary limitation -in B<debputy lint> is that you cannot interactively choose which quickfix to apply. - -=item - - -On save actions (currently only "prune trailing whitespace"). - -=item - - -Folding ranges (multi-line comments). - -=back +When properly set up, the language server will offer a variety of features such as completion +suggestions, hover documentation, "as you type" diagnostics, quickfixes, etc. Please see +B<debputy lsp features> for the full list of features per format. That command will also +help identify mandatory and optional dependencies for the B<debputy lsp server> command. -Note these features are subject to the editor supporting them, correct language IDs being +Note many of the features are subject to the editor supporting them, correct language IDs being passed to B<debputy>, etc. Options for this subcommand |