diff options
Diffstat (limited to 'share/doc/gccint/User-Experience-Guidelines.html')
| -rw-r--r-- | share/doc/gccint/User-Experience-Guidelines.html | 109 |
1 files changed, 109 insertions, 0 deletions
diff --git a/share/doc/gccint/User-Experience-Guidelines.html b/share/doc/gccint/User-Experience-Guidelines.html new file mode 100644 index 0000000..ebe2695 --- /dev/null +++ b/share/doc/gccint/User-Experience-Guidelines.html @@ -0,0 +1,109 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 1988-2023 Free Software Foundation, Inc. + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with the +Invariant Sections being "Funding Free Software", the Front-Cover +Texts being (a) (see below), and with the Back-Cover Texts being (b) +(see below). A copy of the license is included in the section entitled +"GNU Free Documentation License". + +(a) The FSF's Front-Cover Text is: + +A GNU Manual + +(b) The FSF's Back-Cover Text is: + +You have freedom to copy and modify this GNU Manual, like GNU + software. Copies published by the Free Software Foundation raise + funds for GNU development. --> +<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ --> +<head> +<title>GNU Compiler Collection (GCC) Internals: User Experience Guidelines</title> + +<meta name="description" content="GNU Compiler Collection (GCC) Internals: User Experience Guidelines"> +<meta name="keywords" content="GNU Compiler Collection (GCC) Internals: User Experience Guidelines"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<link href="index.html#Top" rel="start" title="Top"> +<link href="Option-Index.html#Option-Index" rel="index" title="Option Index"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="index.html#Top" rel="up" title="Top"> +<link href="Guidelines-for-Diagnostics.html#Guidelines-for-Diagnostics" rel="next" title="Guidelines for Diagnostics"> +<link href="Debugging-the-Analyzer.html#Debugging-the-Analyzer" rel="previous" title="Debugging the Analyzer"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.smallquotation {font-size: smaller} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.indentedblock {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +div.smalldisplay {margin-left: 3.2em} +div.smallexample {margin-left: 3.2em} +div.smallindentedblock {margin-left: 3.2em; font-size: smaller} +div.smalllisp {margin-left: 3.2em} +kbd {font-style:oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +pre.smalldisplay {font-family: inherit; font-size: smaller} +pre.smallexample {font-size: smaller} +pre.smallformat {font-family: inherit; font-size: smaller} +pre.smalllisp {font-size: smaller} +span.nocodebreak {white-space:nowrap} +span.nolinebreak {white-space:nowrap} +span.roman {font-family:serif; font-weight:normal} +span.sansserif {font-family:sans-serif; font-weight:normal} +ul.no-bullet {list-style: none} +--> +</style> + + +</head> + +<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000"> +<a name="User-Experience-Guidelines"></a> +<div class="header"> +<p> +Next: <a href="Funding.html#Funding" accesskey="n" rel="next">Funding</a>, Previous: <a href="Static-Analyzer.html#Static-Analyzer" accesskey="p" rel="previous">Static Analyzer</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p> +</div> +<hr> +<a name="User-Experience-Guidelines-1"></a> +<h2 class="chapter">28 User Experience Guidelines</h2> +<a name="index-user-experience-guidelines"></a> +<a name="index-guidelines_002c-user-experience"></a> + +<p>To borrow a slogan from +<a href="https://elm-lang.org/news/compilers-as-assistants">Elm</a>, +</p> +<blockquote> +<p><strong>Compilers should be assistants, not adversaries.</strong> A compiler should +not just detect bugs, it should then help you understand why there is a bug. +It should not berate you in a robot voice, it should give you specific hints +that help you write better code. Ultimately, a compiler should make +programming faster and more fun! +</p></blockquote> +<div align="center">— <em>Evan Czaplicki</em> +</div> +<p>This chapter provides guidelines on how to implement diagnostics and +command-line options in ways that we hope achieve the above ideal. +</p> +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Guidelines-for-Diagnostics.html#Guidelines-for-Diagnostics" accesskey="1">Guidelines for Diagnostics</a>:</td><td> </td><td align="left" valign="top">How to implement diagnostics. +</td></tr> +<tr><td align="left" valign="top">• <a href="Guidelines-for-Options.html#Guidelines-for-Options" accesskey="2">Guidelines for Options</a>:</td><td> </td><td align="left" valign="top">Guidelines for command-line options. +</td></tr> +</table> + + + + + +</body> +</html> |