[cfe-dev] How to link to "more docs" for clang-tidy checks

[Manuel Klimek via cfe-dev]

RFC:
Often, clang-tidy diagnostics leave you standing in the rain - someone
claims what you just did is a bad idea, but there is neither a fixit
provided, nor do you understand why there might be a problem.

Especially as we delve into the realm of more, um, controversial checks
(cpp-core-guidelines), links to more documentation would be sometimes
beneficial.

The question is if / how we'd best link to more docs from clang-tidy
diagnostics.

Requirements are:
- for a single clang release, the docs should be static (we don't want the
docs to not reflect the checks)
- for ToT, the docs shouldn't change unless we either verify that the
updates are purely doc-fixes, or the code has changed to reflect the new
docs
- links need to be short, otherwise diags get too chatty

One possible solution would be to create a simple link-forwarding service
on llvm.org (some JS inside a doc file), that will rewrite links into which
we can encode whatever we want (revision, link-stamp, whathaveyou) to the
relevant upstream docs (mostly github pages at a certain git hash).

Thoughts? Am I crazy?
Cheers,
/Manuel
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-dev/attachments/20151006/f169c105/attachment.html>