clang/docs/CommandGuide/diagtool.rst

   1 diagtool - clang diagnostics tool
   2 =================================
   3
   4 SYNOPSIS
   5 --------
   6
   7 :program:`diagtool` *command* [*args*]
   8
   9 DESCRIPTION
  10 -----------
  11
  12 :program:`diagtool` is a combination of four tools for dealing with diagnostics in :program:`clang`.
  13
  14 SUBCOMMANDS
  15 -----------
  16
  17 :program:`diagtool` is separated into several subcommands each tailored to a
  18 different purpose. A brief summary of each command follows, with more detail in
  19 the sections that follow.
  20
  21   * :ref:`find_diagnostic_id` - Print the id of the given diagnostic.
  22   * :ref:`list_warnings` - List warnings and their corresponding flags.
  23   * :ref:`show_enabled` - Show which warnings are enabled for a given command line.
  24   * :ref:`tree` - Show warning flags in a tree view.
  25
  26 .. _find_diagnostic_id:
  27
  28 find-diagnostic-id
  29 ~~~~~~~~~~~~~~~~~~
  30
  31 :program:`diagtool` find-diagnostic-id *diagnostic-name*
  32
  33 .. _list_warnings:
  34
  35 list-warnings
  36 ~~~~~~~~~~~~~
  37
  38 :program:`diagtool` list-warnings
  39
  40 .. _show_enabled:
  41
  42 show-enabled
  43 ~~~~~~~~~~~~
  44
  45 :program:`diagtool` show-enabled [*options*] *filename ...*
  46
  47 .. _tree:
  48
  49 tree
  50 ~~~~
  51
  52 :program:`diagtool` tree [*diagnostic-group*]