<div dir="ltr"><div class="gmail_quote"><div dir="ltr">On Tue, Oct 6, 2015 at 5:04 PM Gábor Horváth <<a href="mailto:xazax.hun@gmail.com">xazax.hun@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div><div><div>Hi!<br><br></div>I do agree that, it would be awesome to have direct links to docs. An alternative way of doing this would be to distribute the static documentation with the release, and have a utility script that translates the checker name to a link to the local documentation and opens it up in the browser. The downside is that the diag message would not contain the link directly, so the users might miss the possibility of looking at the documentation for the checkers unless they read about the doc viewer script first.<br><br></div><div>I think having short links in the diag messages while we want to avoid collisions might be a big challenge.<br></div></div></div></blockquote><div><br></div><div>Would you suggest to bundle external docs (cppcoreguidelines) with our release?</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div><div></div><div><br></div>Regards,<br></div>Gabor<br></div><div class="gmail_extra"><br><div class="gmail_quote"></div></div><div class="gmail_extra"><div class="gmail_quote">On 6 October 2015 at 16:53, Manuel Klimek via cfe-dev <span dir="ltr"><<a href="mailto:cfe-dev@lists.llvm.org" target="_blank">cfe-dev@lists.llvm.org</a>></span> wrote:<br></div></div><div class="gmail_extra"><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">RFC:<div>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.</div><div><br></div><div>Especially as we delve into the realm of more, um, controversial checks (cpp-core-guidelines), links to more documentation would be sometimes beneficial.</div><div><br></div><div>The question is if / how we'd best link to more docs from clang-tidy diagnostics.</div><div><br></div><div>Requirements are:</div><div>- for a single clang release, the docs should be static (we don't want the docs to not reflect the checks)</div><div>- 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</div><div>- links need to be short, otherwise diags get too chatty</div><div><br></div><div>One possible solution would be to create a simple link-forwarding service on <a href="http://llvm.org" target="_blank">llvm.org</a> (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).</div><div><br></div><div>Thoughts? Am I crazy?</div><div>Cheers,</div><div>/Manuel</div></div>
<br></blockquote></div></div><div class="gmail_extra"><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">_______________________________________________<br>
cfe-dev mailing list<br>
<a href="mailto:cfe-dev@lists.llvm.org" target="_blank">cfe-dev@lists.llvm.org</a><br>
<a href="http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-dev" rel="noreferrer" target="_blank">http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-dev</a><br>
<br></blockquote></div><br></div>
</blockquote></div></div>