Skip to content

Commit

Permalink
[docs] Update the static analyzer bug reporting page
Browse files Browse the repository at this point in the history
I happened to notice this page (https://clang-analyzer.llvm.org/filing_bugs.html)
was a bit stale, so I've updated and simplified it a bit.

* The page is now explicitly in UTF-8 (NFC)
* We no longer talk about Bugzilla and Apple's bug reporting tools, but
instead link to GitHub's issues page
* We now link to the general LLVM documentation on how to submit a bug

Differential Revision: https://reviews.llvm.org/D158360
  • Loading branch information
AaronBallman committed Aug 20, 2023
1 parent 62b2b39 commit c4e4b64
Showing 1 changed file with 7 additions and 23 deletions.
30 changes: 7 additions & 23 deletions clang/www/analyzer/filing_bugs.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta charset="UTF-8">
<title>Filing Bugs and Feature Requests</title>
<link type="text/css" rel="stylesheet" href="menu.css">
<link type="text/css" rel="stylesheet" href="content.css">
Expand All @@ -21,8 +22,8 @@ <h1>Filing Bugs and Feature Requests</h1>

<ul>

<li>Include the checker build (for prebuilt Mac OS X binaries) or the SVN
revision number.</li>
<li>Include the checker build (for prebuilt Mac OS X binaries) or the git hash.
</li>

<li>Provide a self-contained, reduced test case that exhibits the issue you are
experiencing.</li>
Expand All @@ -33,28 +34,11 @@ <h1>Filing Bugs and Feature Requests</h1>

</ul>

<h2>Outside of Apple</h2>
<p>Please <a href="https://llvm.org/docs/HowToSubmitABug.html">file
bugs and feature requests</a> in
<a href="https://github.com/llvm/llvm-project/issues">LLVM's issue tracker</a>
and label the report with the <code>clang:static analyzer</code> label.</p>

<h3>Bugzilla</h3>

<p>Please <a href="https://bugs.llvm.org/enter_bug.cgi?product=clang">file
bugs</a> in LLVM's Bugzilla database against the Clang <b>Static Analyzer</b>
component.</p>

<h3>Bugreporter.apple.com</h3>

<p>If you are using the analyzer to analyze code associated with an Apple NDA
(e.g., preview versions of SDKs or seed releases of Mac OS X) please file bug
reports to Apple's <a href="https://feedbackassistant.apple.com/welcome">Feedback Assistant</a> web
site.</p>

<p>You are free to always file bugs through this website, but this option is less
attractive than filing bug reports through Bugzilla as not everyone who works on
the analyzer has access to that bug database.</p>

<h2>Apple-internal Users</h2>

<p>Please file bugs in Radar against the <b>clang - static analyzer</b> component.</p>
</div>
</div>
</body>
Expand Down

0 comments on commit c4e4b64

Please sign in to comment.