mirror of
https://github.com/capstone-engine/llvm-capstone.git
synced 2025-04-17 05:40:48 +00:00
b48447a1d6
Although not very well known, diagtool is an incredibly convenient utility for dealing with diagnostics. Particularly useful are the "tree" and "show-enabled" commands: - The former prints the hierarchy of diagnostic (warning) flags and which of them are enabled by default. - The latter can be used to replace an invocation to clang and will print which diagnostics are disabled, warnings or errors. For instance: `diagtool show-enabled -Wall -Werror /tmp/test.c` will print that -Wunused-variable (warn_unused_variable) will be treated as an error. This patch adds them to the install target so it gets shipped with the LLVM release. It also adds a very basic man page and mentions this change in the release notes. Differential revision: https://reviews.llvm.org/D46694 llvm-svn: 332448
53 lines
1.1 KiB
ReStructuredText
53 lines
1.1 KiB
ReStructuredText
diagtool - clang diagnostics tool
|
|
=================================
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
:program:`diagtool` *command* [*args*]
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
:program:`diagtool` is a combination of four tool for dealing with diagnostics in :program:`clang`.
|
|
|
|
SUBCOMMANDS
|
|
-----------
|
|
|
|
:program:`diagtool` is separated into several subcommands each tailored to a
|
|
different purpose. A brief summary of each command follows, with more detail in
|
|
the sections that follow.
|
|
|
|
* :ref:`find_diagnostic_id` - Print the id of the given diagnostic.
|
|
* :ref:`list_warnings` - List warnings and their corresponding flags.
|
|
* :ref:`show_enabled` - Show which warnings are enabled for a given command line.
|
|
* :ref:`tree` - Show warning flags in a tree view.
|
|
|
|
.. _find_diagnostic_id:
|
|
|
|
find-diagnostic-id
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
:program:`diagtool` find-diagnostic-id *diagnostic-name*
|
|
|
|
.. _list_warnings:
|
|
|
|
list-warnings
|
|
~~~~~~~~~~~~~
|
|
|
|
:program:`diagtool` list-warnings
|
|
|
|
.. _show_enabled:
|
|
|
|
show-enabled
|
|
~~~~~~~~~~~~
|
|
|
|
:program:`diagtool` show-enabled [*options*] *filename ...*
|
|
|
|
.. _tree:
|
|
|
|
tree
|
|
~~~~
|
|
|
|
:program:`diagtool` tree [*diagnostic-group*]
|