diagtool.rst 1.1 KB

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