flycheck-doc 31-1 / usr / share / doc / elpa-flycheck / html / index.html

This file is indexed.

/usr/share/doc/elpa-flycheck/html/index.html is in flycheck-doc 31-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Flycheck — Syntax checking for GNU Emacs &#8212; Flycheck 31 documentation</title>
    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '31',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true,
        SOURCELINK_SUFFIX: '.txt'
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="shortcut icon" href="_static/favicon.ico"/>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Installation" href="user/installation.html" />
<script type="text/javascript">
  /* Prevent injected analytics from running with a no-op, but
     let other scripts be injected (we need that for the readthedocs
     widget at the bottom-right of the screen) */
  (function(){
    var props = Object.getOwnPropertyDescriptor(HTMLScriptElement.prototype, 'src');
    var _set = props.set;
    Object.defineProperty(HTMLScriptElement.prototype, 'src', {
      configurable: false, /* Prevent further redefinition of this property */
      set: function(url) {
        if (url.indexOf('google-analytics.com') > -1) return;
        else _set.apply(this, arguments);
      }
    });
  }())
</script>

  </head>
  <body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="flycheck-syntax-checking-for-gnu-emacs">
<h1>Flycheck — Syntax checking for GNU Emacs<a class="headerlink" href="#flycheck-syntax-checking-for-gnu-emacs" title="Permalink to this headline"></a></h1>
<p><strong>Flycheck</strong> is a modern on-the-fly syntax checking extension for GNU Emacs,
intended as replacement for the older Flymake extension which is part of GNU
Emacs.  For a detailed comparison to Flymake see <a class="reference internal" href="user/flycheck-versus-flymake.html#flycheck-versus-flymake"><span class="std std-ref">Flycheck versus Flymake</span></a>.</p>
<p>It uses various syntax checking and linting tools to <a class="reference internal" href="user/syntax-checks.html#flycheck-syntax-checks"><span class="std std-ref">automatically check
the contents of buffers</span></a> while you type, and reports
warnings and errors directly in the buffer, or in an optional <a class="reference internal" href="user/error-list.html#flycheck-error-list"><span class="std std-ref">error list</span></a>:</p>
<img alt="_images/flycheck-annotated.png" src="_images/flycheck-annotated.png" />
<p>Out of the box Flycheck supports over <a class="reference internal" href="languages.html#flycheck-languages"><span class="std std-ref">40 different programming languages</span></a> with more than 80 different syntax checking tools, and
comes with a <a class="reference internal" href="developer/developing.html#flycheck-developers-guide"><span class="std std-ref">simple interface</span></a> to define new
syntax checkers.</p>
<p>Many <a class="reference internal" href="community/extensions.html#flycheck-extensions"><span class="std std-ref">3rd party extensions</span></a> provide new syntax
checkers and other features like alternative error displays or mode line
indicators.</p>
<div class="section" id="try-out">
<h2>Try out<a class="headerlink" href="#try-out" title="Permalink to this headline"></a></h2>
<p>Flycheck needs GNU Emacs 24.3 or newer, and works best on Unix systems.
<strong>Windows users</strong>, please be aware that Flycheck does not support Windows
officially, although it should mostly work fine on Windows.  See <a class="reference internal" href="user/installation.html#flycheck-windows-support"><span class="std std-ref">Windows
support</span></a> and watch out for <a class="reference external" href="https://github.com/flycheck/flycheck/labels/B-Windows%20only">known Windows issues</a>!</p>
<p>To try Flycheck in your Emacs session install some <a class="reference internal" href="languages.html#flycheck-languages"><span class="std std-ref">syntax checker tools</span></a> and type the following in your <code class="docutils literal"><span class="pre">*scratch*</span></code> buffer and
run <code class="docutils literal"><span class="pre">M-x</span> <span class="pre">eval-buffer</span></code>:</p>
<div class="highlight-cl"><div class="highlight"><pre><span></span><span class="p">(</span><span class="nb">require</span> <span class="ss">&#39;package</span><span class="p">)</span>
<span class="p">(</span><span class="nv">add-to-list</span> <span class="ss">&#39;package-archives</span>
             <span class="o">&#39;</span><span class="p">(</span><span class="s">&quot;MELPA Stable&quot;</span> <span class="o">.</span> <span class="s">&quot;http://stable.melpa.org/packages/&quot;</span><span class="p">)</span> <span class="no">t</span><span class="p">)</span>
<span class="p">(</span><span class="nv">package-initialize</span><span class="p">)</span>
<span class="p">(</span><span class="nv">package-refresh-contents</span><span class="p">)</span>

<span class="p">(</span><span class="nv">package-install</span> <span class="ss">&#39;flycheck</span><span class="p">)</span>

<span class="p">(</span><span class="nv">global-flycheck-mode</span><span class="p">)</span>
</pre></div>
</div>
<p><em>On MacOS</em> also add the following to <a class="reference internal" href="user/troubleshooting.html#flycheck-macos-exec-path-from-shell"><span class="std std-ref">fix your $PATH environment variable</span></a>:</p>
<div class="highlight-cl"><div class="highlight"><pre><span></span><span class="p">(</span><span class="nv">package-install</span> <span class="ss">&#39;exec-path-from-shell</span><span class="p">)</span>
<span class="p">(</span><span class="nv">exec-path-from-shell-initialize</span><span class="p">)</span>
</pre></div>
</div>
<p>For a permanent installation of Flycheck follow the <a class="reference internal" href="user/installation.html#flycheck-installation"><span class="std std-ref">Installation</span></a> instructions.  For a gentle introduction into Flycheck
features go through <a class="reference internal" href="user/quickstart.html#flycheck-quickstart"><span class="std std-ref">Quickstart</span></a> guide.</p>
<div class="admonition important">
<p class="first admonition-title">Important</p>
<p class="last">If Flycheck fails to run properly or gives you any error messages please take
a look at the <a class="reference internal" href="user/troubleshooting.html#flycheck-troubleshooting"><span class="std std-ref">troubleshooting section</span></a> which
covers some common setup issues and helps you debug and fix problems with
Flycheck.</p>
</div>
</div>
<div class="section" id="the-user-guide">
<span id="flycheck-user-guide"></span><h2>The User Guide<a class="headerlink" href="#the-user-guide" title="Permalink to this headline"></a></h2>
<p>The User Guide provides installation and usage help for Flycheck.  It starts
with installation instructions and a quick start tutorial and then focuses on an
in-depth references of all parts of Flycheck.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="user/installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user/installation.html#prerequisites">Prerequisites</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user/installation.html#windows-support">Windows support</a></li>
<li class="toctree-l3"><a class="reference internal" href="user/installation.html#syntax-checking-tools">Syntax checking tools</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user/installation.html#package-installation">Package installation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user/installation.html#use-package">use-package</a></li>
<li class="toctree-l3"><a class="reference internal" href="user/installation.html#distribution-packages">Distribution packages</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user/installation.html#legacy-installation-methods">Legacy installation methods</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user/quickstart.html">Quickstart</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user/quickstart.html#enable-flycheck">Enable Flycheck</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/quickstart.html#install-syntax-checker-programs">Install syntax checker programs</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/quickstart.html#check-syntax-in-a-buffer">Check syntax in a buffer</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/quickstart.html#navigate-and-list-errors">Navigate and list errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/quickstart.html#more-features">More features</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user/troubleshooting.html">Troubleshooting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user/troubleshooting.html#common-issues">Common issues</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user/troubleshooting.html#flycheck-cant-find-any-programs-in-gui-emacs-on-macos">Flycheck can’t find any programs in GUI Emacs on MacOS</a></li>
<li class="toctree-l3"><a class="reference internal" href="user/troubleshooting.html#flycheck-warns-about-non-zero-exit-code-but-no-errors">Flycheck warns about “non-zero exit code, but no errors”</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user/troubleshooting.html#verify-your-setup">Verify your setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/troubleshooting.html#debug-syntax-checkers">Debug syntax checkers</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/troubleshooting.html#if-all-else-fails">If all else fails…</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user/syntax-checks.html">Check buffers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user/syntax-checks.html#check-automatically">Check automatically</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/syntax-checks.html#check-manually">Check manually</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user/syntax-checkers.html">Syntax checkers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user/syntax-checkers.html#select-syntax-checkers-automatically">Select syntax checkers automatically</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/syntax-checkers.html#select-syntax-checkers-manually">Select syntax checkers manually</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/syntax-checkers.html#disable-syntax-checkers">Disable syntax checkers</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/syntax-checkers.html#configure-syntax-checkers">Configure syntax checkers</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user/syntax-checkers.html#configuration-files">Configuration files</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="user/syntax-checkers.html#change-syntax-checker-executables">Change syntax checker executables</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user/error-reports.html">See errors in buffers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user/error-reports.html#error-levels">Error levels</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/error-reports.html#error-highlights">Error highlights</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/error-reports.html#fringe-icons">Fringe icons</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/error-reports.html#mode-line">Mode line</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/error-reports.html#error-thresholds">Error thresholds</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/error-reports.html#clear-results">Clear results</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user/error-list.html">List all errors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user/error-list.html#filter-the-list">Filter the list</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/error-list.html#sort-the-list">Sort the list</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/error-list.html#tune-error-list-display">Tune error list display</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user/error-interaction.html">Interact with errors</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user/error-interaction.html#navigate-errors">Navigate errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/error-interaction.html#display-errors">Display errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/error-interaction.html#explain-errors">Explain errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/error-interaction.html#kill-errors">Kill errors</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user/flycheck-versus-flymake.html">Flycheck versus Flymake</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user/flycheck-versus-flymake.html#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="user/flycheck-versus-flymake.html#detailed-review">Detailed review</a><ul>
<li class="toctree-l3"><a class="reference internal" href="user/flycheck-versus-flymake.html#relation-to-emacs">Relation to Emacs</a></li>
<li class="toctree-l3"><a class="reference internal" href="user/flycheck-versus-flymake.html#enabling-syntax-checking">Enabling syntax checking</a></li>
<li class="toctree-l3"><a class="reference internal" href="user/flycheck-versus-flymake.html#syntax-checkers">Syntax checkers</a><ul>
<li class="toctree-l4"><a class="reference internal" href="user/flycheck-versus-flymake.html#definition-of-new-syntax-checkers">Definition of new syntax checkers</a></li>
<li class="toctree-l4"><a class="reference internal" href="user/flycheck-versus-flymake.html#functions-as-syntax-checkers">Functions as syntax checkers</a></li>
<li class="toctree-l4"><a class="reference internal" href="user/flycheck-versus-flymake.html#customization-of-syntax-checkers">Customization of syntax checkers</a></li>
<li class="toctree-l4"><a class="reference internal" href="user/flycheck-versus-flymake.html#executables-of-syntax-checkers">Executables of syntax checkers</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="user/flycheck-versus-flymake.html#syntax-checker-selection">Syntax checker selection</a><ul>
<li class="toctree-l4"><a class="reference internal" href="user/flycheck-versus-flymake.html#custom-predicates">Custom predicates</a></li>
<li class="toctree-l4"><a class="reference internal" href="user/flycheck-versus-flymake.html#manual-selection">Manual selection</a></li>
<li class="toctree-l4"><a class="reference internal" href="user/flycheck-versus-flymake.html#multiple-syntax-checkers-per-buffer">Multiple syntax checkers per buffer</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="user/flycheck-versus-flymake.html#errors">Errors</a><ul>
<li class="toctree-l4"><a class="reference internal" href="user/flycheck-versus-flymake.html#error-levels">Error levels</a></li>
<li class="toctree-l4"><a class="reference internal" href="user/flycheck-versus-flymake.html#error-identifiers">Error identifiers</a></li>
<li class="toctree-l4"><a class="reference internal" href="user/flycheck-versus-flymake.html#error-parsing">Error parsing</a></li>
<li class="toctree-l4"><a class="reference internal" href="user/flycheck-versus-flymake.html#error-message-display">Error message display</a></li>
<li class="toctree-l4"><a class="reference internal" href="user/flycheck-versus-flymake.html#error-list">Error list</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="user/flycheck-versus-flymake.html#resource-consumption">Resource consumption</a><ul>
<li class="toctree-l4"><a class="reference internal" href="user/flycheck-versus-flymake.html#syntax-checking">Syntax checking</a></li>
<li class="toctree-l4"><a class="reference internal" href="user/flycheck-versus-flymake.html#checking-for-changes">Checking for changes</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="user/flycheck-versus-flymake.html#unit-tests">Unit tests</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="the-community-guide">
<span id="flycheck-community-guide"></span><h2>The Community Guide<a class="headerlink" href="#the-community-guide" title="Permalink to this headline"></a></h2>
<p>The Community Guide provides information about Flycheck’s&nbsp;ecosystem and
community.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="community/conduct.html">Flycheck Code of Conduct</a><ul>
<li class="toctree-l2"><a class="reference internal" href="community/conduct.html#conduct">Conduct</a></li>
<li class="toctree-l2"><a class="reference internal" href="community/conduct.html#moderation">Moderation</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="community/extensions.html">Recommended extensions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="community/extensions.html#user-interface">User interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="community/extensions.html#language-support">Language support</a><ul>
<li class="toctree-l3"><a class="reference internal" href="community/extensions.html#cadence">Cadence</a></li>
<li class="toctree-l3"><a class="reference internal" href="community/extensions.html#clojure">Clojure</a></li>
<li class="toctree-l3"><a class="reference internal" href="community/extensions.html#c-c-objective-c">C/C++/Objective C</a></li>
<li class="toctree-l3"><a class="reference internal" href="community/extensions.html#d">D</a></li>
<li class="toctree-l3"><a class="reference internal" href="community/extensions.html#elixir">Elixir</a></li>
<li class="toctree-l3"><a class="reference internal" href="community/extensions.html#emacs-lisp">Emacs Lisp</a></li>
<li class="toctree-l3"><a class="reference internal" href="community/extensions.html#julia">Julia</a></li>
<li class="toctree-l3"><a class="reference internal" href="community/extensions.html#haskell">Haskell</a></li>
<li class="toctree-l3"><a class="reference internal" href="community/extensions.html#ledger">Ledger</a></li>
<li class="toctree-l3"><a class="reference internal" href="community/extensions.html#mercury">Mercury</a></li>
<li class="toctree-l3"><a class="reference internal" href="community/extensions.html#ocaml">OCaml</a></li>
<li class="toctree-l3"><a class="reference internal" href="community/extensions.html#python">Python</a></li>
<li class="toctree-l3"><a class="reference internal" href="community/extensions.html#rust">Rust</a></li>
<li class="toctree-l3"><a class="reference internal" href="community/extensions.html#shell-scripts">Shell scripts</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="community/get-help.html">Get help</a></li>
<li class="toctree-l1"><a class="reference internal" href="community/people.html">People</a><ul>
<li class="toctree-l2"><a class="reference internal" href="community/people.html#teams">Teams</a><ul>
<li class="toctree-l3"><a class="reference internal" href="community/people.html#maintainers">Maintainers</a></li>
<li class="toctree-l3"><a class="reference internal" href="community/people.html#moderators">Moderators</a></li>
<li class="toctree-l3"><a class="reference internal" href="community/people.html#language-teams">Language teams</a><ul>
<li class="toctree-l4"><a class="reference internal" href="community/people.html#elixir">Elixir</a></li>
<li class="toctree-l4"><a class="reference internal" href="community/people.html#go">Go</a></li>
<li class="toctree-l4"><a class="reference internal" href="community/people.html#haskell">Haskell</a></li>
<li class="toctree-l4"><a class="reference internal" href="community/people.html#javascript">Javascript</a></li>
<li class="toctree-l4"><a class="reference internal" href="community/people.html#lua">Lua</a></li>
<li class="toctree-l4"><a class="reference internal" href="community/people.html#puppet">Puppet</a></li>
<li class="toctree-l4"><a class="reference internal" href="community/people.html#rust">Rust</a></li>
<li class="toctree-l4"><a class="reference internal" href="community/people.html#typescript">TypeScript</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="community/people.html#packagers">Packagers</a></li>
<li class="toctree-l2"><a class="reference internal" href="community/people.html#acknowledgements">Acknowledgements</a></li>
<li class="toctree-l2"><a class="reference internal" href="community/people.html#contributors">Contributors</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="the-developer-guide">
<span id="flycheck-developer-guide"></span><h2>The Developer Guide<a class="headerlink" href="#the-developer-guide" title="Permalink to this headline"></a></h2>
<p>The Developer Guide shows how extend Flycheck and how to write syntax checkers
for Flycheck.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="developer/developing.html">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="developer/developing.html#an-overview-of-flycheck-internals">An overview of Flycheck internals</a></li>
<li class="toctree-l2"><a class="reference internal" href="developer/developing.html#adding-a-syntax-checker-to-flycheck">Adding a syntax checker to Flycheck</a><ul>
<li class="toctree-l3"><a class="reference internal" href="developer/developing.html#writing-the-checker">Writing the checker</a></li>
<li class="toctree-l3"><a class="reference internal" href="developer/developing.html#registering-the-checker">Registering the checker</a></li>
<li class="toctree-l3"><a class="reference internal" href="developer/developing.html#a-more-complex-example">A more complex example</a></li>
<li class="toctree-l3"><a class="reference internal" href="developer/developing.html#sharing-your-checker">Sharing your checker</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="the-contributor-guide">
<span id="flycheck-contributor-guide"></span><h2>The Contributor Guide<a class="headerlink" href="#the-contributor-guide" title="Permalink to this headline"></a></h2>
<p>The Contributor Guide explains how to contribute to Flycheck.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="contributor/contributing.html">Contributor’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contributor/contributing.html#bug-reports">Bug reports</a><ul>
<li class="toctree-l3"><a class="reference internal" href="contributor/contributing.html#windows-only-issues">Windows-only issues</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="contributor/contributing.html#feature-requests">Feature requests</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributor/contributing.html#the-build-system">The Build system</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributor/contributing.html#pull-requests">Pull requests</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributor/contributing.html#writing-documentation">Writing documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributor/contributing.html#issue-management">Issue management</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributor/contributing.html#out-of-tree-contributions">Out of tree contributions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributor/style-guide.html">Style Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contributor/style-guide.html#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributor/style-guide.html#style">Style</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributor/style-guide.html#libraries">Libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributor/style-guide.html#tests">Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributor/style-guide.html#documentation">Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributor/style-guide.html#commits">Commits</a><ul>
<li class="toctree-l3"><a class="reference internal" href="contributor/style-guide.html#commit-message-style">Commit message style</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="contributor/maintaining.html">Maintainer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="contributor/maintaining.html#issue-triage">Issue triage</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributor/maintaining.html#git-workflow">Git workflow</a><ul>
<li class="toctree-l3"><a class="reference internal" href="contributor/maintaining.html#branch-rules">Branch rules</a></li>
<li class="toctree-l3"><a class="reference internal" href="contributor/maintaining.html#pull-requests-reviews">Pull requests reviews</a><ul>
<li class="toctree-l4"><a class="reference internal" href="contributor/maintaining.html#as-a-maintainer">As a maintainer</a></li>
<li class="toctree-l4"><a class="reference internal" href="contributor/maintaining.html#as-a-contributor">As a contributor</a></li>
<li class="toctree-l4"><a class="reference internal" href="contributor/maintaining.html#merge-guidelines">Merge guidelines</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="contributor/maintaining.html#signatures-for-commits-and-tags">Signatures for commits and tags</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="contributor/maintaining.html#tooling-and-services">Tooling and Services</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributor/maintaining.html#maintenance-scripts">Maintenance scripts</a></li>
<li class="toctree-l2"><a class="reference internal" href="contributor/maintaining.html#versioning-and-releases">Versioning and releases</a><ul>
<li class="toctree-l3"><a class="reference internal" href="contributor/maintaining.html#release-process">Release process</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="contributor/maintaining.html#new-maintainers">New maintainers</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and Tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><a class="reference internal" href="languages.html#flycheck-languages"><span class="std std-ref">Supported Languages</span></a></li>
<li><a class="reference internal" href="glossary.html"><span class="doc">Glossary</span></a></li>
<li><a class="reference internal" href="changes.html"><span class="doc">Changes</span></a></li>
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
<div class="toctree-wrapper compound">
</div>
</div>
<div class="section" id="licensing">
<h2>Licensing<a class="headerlink" href="#licensing" title="Permalink to this headline"></a></h2>
<p>Flycheck is free software; you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.</p>
<p>Flycheck is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>See <a class="reference internal" href="licenses.html#flycheck-gpl"><span class="std std-ref">GNU General Public License 3</span></a> for a copy of the GNU General Public License.</p>
<p>You may copy, distribute and/or modify the Flycheck documentation under the
terms of the Creative Commons Attribution-ShareAlike 4.0 International Public
License.  See <a class="reference internal" href="licenses.html#flycheck-cc-by-sa"><span class="std std-ref">Creative Commons Attribution-ShareAlike 4.0 International</span></a> for a copy of the license.</p>
<p>Permission is granted to copy, distribute and/or modify the Flycheck logo under
the terms of the Creative Commons Attribution-ShareAlike 4.0 International
Public License.  See <a class="reference internal" href="licenses.html#flycheck-cc-by-sa"><span class="std std-ref">Creative Commons Attribution-ShareAlike 4.0 International</span></a> for a copy of the license.</p>
<div class="toctree-wrapper compound">
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<p class="logo">
    <a href="#">
        <img class="logo" src="_static/logo.png" alt="Logo"/>
        
    </a>
</p>



<p class="blurb">Syntax checking for GNU Emacs</p>






<h4>Tables</h4>
<ul>
    <li><a href="languages.html">Supported languages</a></li>
    <li><a href="changes.html">List of changes</a></li>
    <li><a href="genindex.html">Index</a></li>
</ul><h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="user/installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="user/quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="user/troubleshooting.html">Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="user/syntax-checks.html">Check buffers</a></li>
<li class="toctree-l1"><a class="reference internal" href="user/syntax-checkers.html">Syntax checkers</a></li>
<li class="toctree-l1"><a class="reference internal" href="user/error-reports.html">See errors in buffers</a></li>
<li class="toctree-l1"><a class="reference internal" href="user/error-list.html">List all errors</a></li>
<li class="toctree-l1"><a class="reference internal" href="user/error-interaction.html">Interact with errors</a></li>
<li class="toctree-l1"><a class="reference internal" href="user/flycheck-versus-flymake.html">Flycheck versus Flymake</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="community/conduct.html">Flycheck Code of Conduct</a></li>
<li class="toctree-l1"><a class="reference internal" href="community/extensions.html">Recommended extensions</a></li>
<li class="toctree-l1"><a class="reference internal" href="community/get-help.html">Get help</a></li>
<li class="toctree-l1"><a class="reference internal" href="community/people.html">People</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="developer/developing.html">Developer’s Guide</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="contributor/contributing.html">Contributor’s Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributor/style-guide.html">Style Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributor/maintaining.html">Maintainer’s Guide</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="languages.html">Supported Languages</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="changes.html">Changes</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="licenses.html">Flycheck licenses</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="#">Documentation overview</a><ul>
      <li>Next: <a href="user/installation.html" title="next chapter">Installation</a></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy; 2014-2017, Sebastian Wiesner and Flycheck contributors.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.5</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
      
      |
      <a href="_sources/index.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>

APT Browse - Built by Thomas Orozco.