<div dir="ltr"><div class="gmail_quote"><div dir="ltr">On Tue, Oct 6, 2015 at 4:18 PM Aaron Ballman <<a href="mailto:aaron.ballman@gmail.com">aaron.ballman@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">On Tue, Oct 6, 2015 at 10:15 AM, Manuel Klimek <<a href="mailto:klimek@google.com" target="_blank">klimek@google.com</a>> wrote:<br>
> On Tue, Oct 6, 2015 at 4:12 PM Aaron Ballman <<a href="mailto:aaron.ballman@gmail.com" target="_blank">aaron.ballman@gmail.com</a>><br>
> wrote:<br>
>><br>
>> aaron.ballman added a comment.<br>
>><br>
>> In <a href="http://reviews.llvm.org/D13368#260672" rel="noreferrer" target="_blank">http://reviews.llvm.org/D13368#260672</a>, @klimek wrote:<br>
>><br>
>> > In <a href="http://reviews.llvm.org/D13368#260669" rel="noreferrer" target="_blank">http://reviews.llvm.org/D13368#260669</a>, @aaron.ballman wrote:<br>
>> ><br>
>> > > This wasn't a comment on the rule so much as a comment on the<br>
>> > > diagnostic not being very helpful.In this case, you're telling the user to<br>
>> > > not do something, but it is unclear how the user would structure their code<br>
>> > > to silence this diagnostic. Perhaps there is no way to word this to give the<br>
>> > > user a clue, but we should at least try. If I got this diagnostic as it is<br>
>> > > now, I would scratch my head and quickly decide to ignore it.<br>
>> ><br>
>> ><br>
>> > The cpp core guidelines are written in a way that they should be<br>
>> > referenceable by links - do we want to add links to the relevant portions of<br>
>> > the core guidelines from the clang-tidy checks?<br>
>><br>
>><br>
>> I'd be hesitant to do that. It would add a lot of verbiage to diagnostics<br>
>> that are likely to be chatty, and if the links ever go dead mid-release<br>
>> cycle for us, we're stuck looking bad with no way to fix it. CERT's<br>
>> guidelines are also linkable in the same fashion (as would be hypothetical<br>
>> checks for MISRA, JSF, etc), and I would have the same hesitation for those<br>
>> as well due to the potential dead link issue.<br>
>><br>
>> I think that having the links within the user-facing documentation is a<br>
>> must-have though (and something we've been pretty good about thus far)<br>
>> because those can be updated live from ToT. So perhaps a permanent short<br>
>> link to our own documentation might be useful (if a bit obtuse since our<br>
>> docs mostly just point to other docs elsewhere)? I'd still be a bit worried<br>
>> about expired short links or something, but maybe we already host a service<br>
>> for this sort of thing?<br>
><br>
><br>
> I'll postulate that a) github will not go away anytime soon and b) github<br>
> will have a hard time changing their link structure so linking into revision<br>
> N in branch M doesn't work any more.<br>
> Thus, I think if we link into the github release of the core guildelines,<br>
> we'll be fine.<br>
<br>
Github's structure and stability isn't what I'm worried about. The C++<br>
Core Guidelines internal structure is what I am worried about. They<br>
currently use anchors to navigate around CppCoreGuidelines.md, and<br>
those anchor names may or may not be stable. Even with the best of<br>
intentions on stability, links change.<br></blockquote><div><br></div><div>Can't we link it to one specific version in time, and update the base revision when we did QA on the links?</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<br>
~Aaron<br>
</blockquote></div></div>