This is an archive of the discontinued LLVM Phabricator instance.

Differential D158360

[docs] Update the static analyzer bug reporting page
ClosedPublic

Authored by aaron.ballman on Aug 20 2023, 4:57 AM.

Details

Reviewers
NoQ
steakhal
zaks.anna
xazax.hun
Commits
rGc4e4b64c1249: [docs] Update the static analyzer bug reporting page
Summary

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.

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

Diff Detail

Event Timeline

aaron.ballman created this revision.Aug 20 2023, 4:57 AM
Herald added a project: Restricted Project. · View Herald TranscriptAug 20 2023, 4:57 AM
Herald added subscribers: manas, ASDenysPetrov, dkrupp and 4 others. · View Herald Transcript
aaron.ballman requested review of this revision.Aug 20 2023, 4:57 AM
Herald added a project: Restricted Project. · View Herald TranscriptAug 20 2023, 4:57 AM
steakhal added a comment.Aug 20 2023, 5:20 AM
This comment was removed by steakhal.
Harbormaster completed remote builds in B253706: Diff 551817.Aug 20 2023, 5:21 AM
steakhal accepted this revision.Aug 20 2023, 5:25 AM

Makes sense to me, thanks!

I'm not sure though how much we wanna invest into maintaining these handwritten htmls. I would prefer moving away from these. It would likely also fit more nicely with how the other tools look like in terms of styling.
No actions expected, this is more of just expressing my position on these analyzer HTML files.

This revision is now accepted and ready to land.Aug 20 2023, 5:25 AM
This revision was landed with ongoing or failed builds.Aug 20 2023, 7:49 AM
Closed by commit rGc4e4b64c1249: [docs] Update the static analyzer bug reporting page (authored by aaron.ballman). · Explain Why
This revision was automatically updated to reflect the committed changes.
aaron.ballman added a commit: rGc4e4b64c1249: [docs] Update the static analyzer bug reporting page.

Revision Contents

PathSize
clang/
www/
analyzer/
30 lines

Diff 551838

clang/www/analyzer/filing_bugs.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd"> "http://www.w3.org/TR/html4/strict.dtd">
<html> <html>
<head> <head>
<meta charset="UTF-8">
<title>Filing Bugs and Feature Requests</title> <title>Filing Bugs and Feature Requests</title>
<link type="text/css" rel="stylesheet" href="menu.css"> <link type="text/css" rel="stylesheet" href="menu.css">
<link type="text/css" rel="stylesheet" href="content.css"> <link type="text/css" rel="stylesheet" href="content.css">
<script type="text/javascript" src="scripts/menu.js"></script> <script type="text/javascript" src="scripts/menu.js"></script>
</head> </head>
<body> <body>
<div id="page"> <div id="page">
<!--#include virtual="menu.html.incl"--> <!--#include virtual="menu.html.incl"-->
<div id="content"> <div id="content">
<h1>Filing Bugs and Feature Requests</h1> <h1>Filing Bugs and Feature Requests</h1>
<p>We encourage users to file bug reports for any problems that they encounter. <p>We encourage users to file bug reports for any problems that they encounter.
We also welcome feature requests. When filing a bug report, please do the We also welcome feature requests. When filing a bug report, please do the
following:</p> following:</p>
<ul> <ul>
<li>Include the checker build (for prebuilt Mac OS X binaries) or the SVN <li>Include the checker build (for prebuilt Mac OS X binaries) or the git hash.
revision number.</li> </li>
<li>Provide a self-contained, reduced test case that exhibits the issue you are <li>Provide a self-contained, reduced test case that exhibits the issue you are
experiencing.</li> experiencing.</li>
<li>Test cases don't tell us everything. Please briefly describe the problem you <li>Test cases don't tell us everything. Please briefly describe the problem you
are seeing, including what you thought should have been the expected behavior are seeing, including what you thought should have been the expected behavior
and why.</li> and why.</li>
</ul> </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>
</div> </div>
</body> </body>
</html> </html>