<div dir="ltr">Yup, consider me convinced. </div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Sat, 20 Apr 2019 at 04:45, Artem Dergachev <<a href="mailto:noqnoqneo@gmail.com">noqnoqneo@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
  
    
  
  <div bgcolor="#FFFFFF">
    I don't fully understand this either, but it's pretty hard to
    imagine that somebody from outside would be able to quickly
    understand how Static Analyzer works and uses this understanding
    solely for describing how it works. Even a GSoC student doesn't
    necessarily gather enough understanding throughout a summer of
    practical work on the analyzer to write such docs. On the other
    hand, about the docs that are scattered around - it's bad that
    they're scattered around, but they themselves aren't that bad (well,
    at least, i arrogantly believe they aren't that bad), just hard to
    find. I mean, they don't look like something that somebody should
    write for us; we'll probably do a better job writing in-depth docs
    because we're writing it for ourselves and we know what we need.<br>
    <br>
    On 4/19/19 6:58 PM, Devin Coughlin wrote:<br>
    <blockquote type="cite">
      
      I think we should try to focus the Google Summer of Documentation
      project on documenting aspects of the analyzer that would benefit
      our users. There are a lot more of them than there are of us
      analyzer developers! 
      <div><br>
      </div>
      <div>One area that would be great to improve on is
        describing for our important checkers:</div>
      <div>* What bugs does the checker find?</div>
      <div>* Why are the bugs important?</div>
      <div>* How should the bugs be fixed?</div>
      <div>* How should false positives be suppressed?</div>
      <div><br>
      </div>
      <div>The GSoD project is an amazing resource — we should
        take advantage of it to improve our users’ experience of the
        analyzer.</div>
      <div><br>
      </div>
      <div>Devin</div>
      <div>
        <div><br>
          <blockquote type="cite">
            <div>On Apr 19, 2019, at 4:37 PM, Kristóf Umann
              <<a href="mailto:dkszelethus@gmail.com" target="_blank">dkszelethus@gmail.com</a>>
              wrote:</div>
            <br class="gmail-m_6479204421280816455Apple-interchange-newline">
            <div>
              <div dir="ltr">
                <div dir="ltr">Sounds like the thing we always
                  needed in my opinion! The analyzer could really use
                  some better docs in certain areas -- speaking from
                  personal experience, I always thought that I just need
                  more time to learning about the codebase before being
                  able to understand patches related to, for example,
                  liveness analysis. It wasn't until I attended Gábor
                  Horváth's advanced compilers lectures at my
                  university, when I understood that that is in fact
                  something that exists in the literature, and the thing
                  that we have in the analyzer is "merely" an
                  implementation of it. I really liked what he said
                  during the Birds of a Feather meeting on EuroLLVM, is
                  that we do have many things documented, but it's
                  scattered all over the place in youtube videos,
                  cfe-dev mails, patch review discussions, bugzilla
                  reports (especially before 2012) and the like. If
                  under GSoD we could get this sorted out, get rid of
                  most of HTML files we have on <a href="https://clang-analyzer.llvm.org/" target="_blank">https://clang-analyzer.llvm.org/</a>,
                  and have an easy-to-navigate, easy-to-extend
                  documentation for the long term, it would be far more
                  inviting for newcomers as well. I might be biased, but
                  the Clang Static Analyzer is very cool project, and I
                  think if we made the transition from writing your
                  first checker to making changes in the actual
                  infrastructure a little easier, we would have a a lot
                  easier time building a community around it.</div>
                <div dir="ltr"><br>
                </div>
                <div>Couple thoughts of mine, I haven't read
                  through the entire GSoD procedure thought.</div>
              </div>
              <br>
              <div class="gmail_quote">
                <div dir="ltr" class="gmail_attr">On Sat, 20 Apr 2019 at
                  03:12, Artem Dergachev <<a href="mailto:noqnoqneo@gmail.com" target="_blank">noqnoqneo@gmail.com</a>>
                  wrote:<br>
                </div>
                <blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Tanya made this
                  call for Google thing of Docs, which is like summer of
                  <br>
                  code just for docs <br>
                  (<a href="http://lists.llvm.org/pipermail/cfe-dev/2019-April/062121.html" rel="noreferrer" target="_blank">http://lists.llvm.org/pipermail/cfe-dev/2019-April/062121.html</a>).
                  <br>
                  There's been a lot of work on checker docs in the
                  Analyzer recently. Do <br>
                  we want to take this opportunity?<br>
                  <br>
                  Like, if it gives us a nice, stylish,
                  easy-to-understand, on-point <br>
                  description of what the checker thinks the user's code
                  is doing and how <br>
                  bad does it think it is, it might be pretty neat.<br>
                </blockquote>
              </div>
            </div>
          </blockquote>
        </div>
        <br>
      </div>
    </blockquote>
    <br>
  </div>

</blockquote></div>