<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="Generator" content="Microsoft Word 15 (filtered medium)">
<style><!--
/* Font Definitions */
@font-face
{font-family:"Cambria Math";
panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
{font-family:Calibri;
panose-1:2 15 5 2 2 2 4 3 2 4;}
@font-face
{font-family:"Segoe UI";
panose-1:2 11 5 2 4 2 4 2 2 3;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0in;
margin-bottom:.0001pt;
font-size:11.0pt;
font-family:"Calibri",sans-serif;}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:#0563C1;
text-decoration:underline;}
a:visited, span.MsoHyperlinkFollowed
{mso-style-priority:99;
color:#954F72;
text-decoration:underline;}
span.EmailStyle17
{mso-style-type:personal-compose;
font-family:"Calibri",sans-serif;
color:windowtext;}
.MsoChpDefault
{mso-style-type:export-only;
font-family:"Calibri",sans-serif;}
@page WordSection1
{size:8.5in 11.0in;
margin:1.0in 1.0in 1.0in 1.0in;}
div.WordSection1
{page:WordSection1;}
/* List Definitions */
@list l0
{mso-list-id:290400215;
mso-list-template-ids:1365173268;}
@list l0:level1
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l0:level2
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:1.0in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l0:level3
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:1.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l0:level4
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:2.0in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l0:level5
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:2.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l0:level6
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:3.0in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l0:level7
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:3.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l0:level8
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:4.0in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
@list l0:level9
{mso-level-number-format:bullet;
mso-level-text:\F0B7;
mso-level-tab-stop:4.5in;
mso-level-number-position:left;
text-indent:-.25in;
mso-ansi-font-size:10.0pt;
font-family:Symbol;}
ol
{margin-bottom:0in;}
ul
{margin-bottom:0in;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]-->
</head>
<body lang="EN-US" link="#0563C1" vlink="#954F72">
<div class="WordSection1">
<p class="MsoNormal">Dear Analyzer Community,<o:p></o:p></p>
<p class="MsoNormal"><o:p> </o:p></p>
<p style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:9.0pt;margin-left:0in;background:white">
<span style="font-size:10.0pt;font-family:"Segoe UI",sans-serif;color:black">Most standard Clang tools (ThreadSanitizer, MemorySanitizer, DataFlowSanitizer etc.)<br>
have documentation delivered with Clang and build using Sphinx tool at <a href="https://clang.llvm.org/docs/" target="_blank"><span style="color:#136CB2">https://clang.llvm.org/docs/</span></a>.<br>
I thought it would be great to have the ClangSA docs there too in sphinx markup.<o:p></o:p></span></p>
<p style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:9.0pt;margin-left:0in;background:white;font-variant-ligatures: normal;font-variant-caps: normal;orphans: 2;widows: 2;-webkit-text-stroke-width: 0px;text-decoration-style: initial;text-decoration-color: initial;word-spacing:0px">
<span style="font-size:10.0pt;font-family:"Segoe UI",sans-serif;color:black">I created a patch
<a href="https://reviews.llvm.org/D54429">https://reviews.llvm.org/D54429</a> where analyzer's documentation main page and the checker sub-pages are<br>
transformed into Sphinx RST.<o:p></o:p></span></p>
<p style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:9.0pt;margin-left:0in;background:white">
<span style="font-size:10.0pt;font-family:"Segoe UI",sans-serif;color:black">This is how it looks like now:<o:p></o:p></span></p>
<p style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:9.0pt;margin-left:0in;background:white">
<span style="font-size:10.0pt;font-family:"Segoe UI",sans-serif;color:black"><a href="http://cc.elte.hu/clang-docs/docs/html/ClangStaticAnalyzer.html" target="_blank"><span style="color:#136CB2">http://cc.elte.hu/clang-docs/docs/html/ClangStaticAnalyzer.html</span></a><o:p></o:p></span></p>
<p style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:9.0pt;margin-left:0in;background:white;font-variant-ligatures: normal;font-variant-caps: normal;orphans: 2;widows: 2;-webkit-text-stroke-width: 0px;text-decoration-style: initial;text-decoration-color: initial;word-spacing:0px">
<span style="font-size:10.0pt;font-family:"Segoe UI",sans-serif;color:black">Advantages:<o:p></o:p></span></p>
<p class="MsoNormal" style="margin-left:22.5pt;text-indent:-.25in;line-height:20.4pt;mso-list:l0 level1 lfo1;background:white">
<![if !supportLists]><span style="font-size:10.0pt;font-family:Symbol;color:black"><span style="mso-list:Ignore">·<span style="font:7.0pt "Times New Roman"">
</span></span></span><![endif]><span style="font-size:10.0pt;font-family:"Segoe UI",sans-serif;color:black">The documentation is easier to be maintained in Sphinx markup compared to raw HTML<o:p></o:p></span></p>
<p class="MsoNormal" style="margin-left:22.5pt;text-indent:-.25in;line-height:20.4pt;mso-list:l0 level1 lfo1;background:white">
<![if !supportLists]><span style="font-size:10.0pt;font-family:Symbol;color:black"><span style="mso-list:Ignore">·<span style="font:7.0pt "Times New Roman"">
</span></span></span><![endif]><span style="font-size:10.0pt;font-family:"Segoe UI",sans-serif;color:black">The documentation is easier found in the standard clang doc tree<o:p></o:p></span></p>
<p class="MsoNormal" style="margin-left:22.5pt;text-indent:-.25in;line-height:20.4pt;mso-list:l0 level1 lfo1;background:white">
<![if !supportLists]><span style="font-size:10.0pt;font-family:Symbol;color:black"><span style="mso-list:Ignore">·<span style="font:7.0pt "Times New Roman"">
</span></span></span><![endif]><span style="font-size:10.0pt;font-family:"Segoe UI",sans-serif;color:black">The generated documentation looks nicer ;)<o:p></o:p></span></p>
<p class="MsoNormal"><br>
What was also missing (for many users) is the documentation of the checkers. Similar to the one-pagers what we have for clang-tidy:
<a href="http://clang.llvm.org/extra/clang-tidy/checks/list.html">http://clang.llvm.org/extra/clang-tidy/checks/list.html</a><br>
<br>
<span style="font-size:10.0pt;font-family:"Segoe UI",sans-serif;color:black">So a similar listing page is created:
<a href="http://cc.elte.hu/clang-docs/docs/html/analyzer/checkers.html">http://cc.elte.hu/clang-docs/docs/html/analyzer/checkers.html</a><br>
With a specific one-pager example: <a href="http://cc.elte.hu/clang-docs/docs/html/analyzer/checkers/UninitializedObject.html" target="_blank">
<span style="color:#136CB2">http://cc.elte.hu/clang-docs/docs/html/analyzer/checkers/UninitializedObject.html</span></a></span><o:p></o:p></p>
<p style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:9.0pt;margin-left:0in;background:white">
<span style="font-size:10.0pt;font-family:"Segoe UI",sans-serif;color:black"><br>
In practice the pages can be migrated one by one (after sanitizing them) and at end a redirection can be set up at
<a href="https://clang-analyzer.llvm.org/">https://clang-analyzer.llvm.org/</a></span><span style="font-size:10.0pt;font-family:"Segoe UI",sans-serif">.<span style="color:black"><o:p></o:p></span></span></p>
<p style="mso-margin-top-alt:0in;margin-right:0in;margin-bottom:9.0pt;margin-left:0in;background:white">
<span style="font-size:10.0pt;font-family:"Segoe UI",sans-serif;color:black">I wonder what you guys think about this approach?<br>
</span><br>
Thanks,<br>
Daniel<o:p></o:p></p>
</div>
</body>
</html>