Commit 82d31967 authored by Sebastian Wiesner's avatar Sebastian Wiesner

Improve mentions of 3rd party extensions

Add more extensions, and mention all extensions in an appropriate
context throughout the manual.
parent 6cf383ad
This source diff could not be displayed because it is too large. You can view the blob instead.
......@@ -45,8 +45,10 @@ The following extensions provide additional cool features for Flycheck:
packages.
- flycheck-hdevtools_ adds a Flycheck syntax checker for Haskell based on
hdevtools_.
- flycheck-ledger_ adds a syntax checker for the Ledger_ accounting tool.
- flycheck-mercury_ adds a Flycheck syntax checker for the `Mercury Language`_.
- flycheck-pos-tip_ shows Flycheck error messages in a popup.
- flycheck-pyflakes_ adds a Python syntax checker using Pyflakes.
- flycheck-rust_ improves Rust support in Flycheck, by configuring Flycheck
according to Cargo settings and layouts.
......@@ -58,7 +60,10 @@ The following extensions provide additional cool features for Flycheck:
.. _flycheck-haskell: https://github.com/flycheck/flycheck-haskell
.. _flycheck-hdevtools: https://github.com/flycheck/flycheck-hdevtools
.. _hdevtools: https://github.com/bitc/hdevtools/
.. _flycheck-ledger: https://github.com/purcell/flycheck-ledger
.. _Ledger: http://ledger-cli.org/
.. _flycheck-mercury: https://github.com/flycheck/flycheck-mercury
.. _Mercury language: http://mercurylang.org/
.. _flycheck-pos-tip: https://github.com/flycheck/flycheck-pos-tip
.. _flycheck-pyflakes: https://github.com/Wilfred/flycheck-pyflakes
.. _flycheck-rust: https://github.com/flycheck/flycheck-rust
......@@ -14,9 +14,15 @@ Each language has one or more syntax checkers, whose names follow a
programming language supported by this syntax checker, and :var:`tool` the
specific syntax checker tool.
This document provides just a brief overview, use
:el:command:`flycheck-describe-checker` to see comprehensive documenation about
a syntax checker.
There are some 3rd party extensions which add support for more languages:
- flycheck-ledger_ adds a syntax checker for the Ledger_ accounting tool.
- flycheck-mercury_ adds a syntax checker for the Mercury_ language.
.. _flycheck-ledger: https://github.com/purcell/flycheck-ledger
.. _Ledger: http://ledger-cli.org/
.. _flycheck-mercury: https://github.com/flycheck/flycheck-mercury
.. _Mercury: http://mercurylang.org/
.. contents:: Supported languages
:local:
......@@ -119,6 +125,13 @@ C/C++
.. option:: flycheck-cppcheck-inconclusive
:auto:
.. seealso::
The flycheck-google-cpplint_ extension adds a syntax checker using Google's
C++ style checker.
.. _flycheck-google-cpplint: https://github.com/flycheck/flycheck-google-cpplint
CFEngine
========
......@@ -166,6 +179,13 @@ D
.. option:: flycheck-dmd-include-path
:auto:
.. seealso::
The flycheck-d-unittest_ extension adds a syntax checker that runs D unit
tests on the fly.
.. _flycheck-d-unittest: https://github.com/flycheck/flycheck-d-unittest
Elixir
======
......@@ -191,6 +211,11 @@ Emacs Lisp
.. option:: flycheck-emacs-lisp-package-user-dir
:auto:
.. seealso::
With the flycheck-cask_ extension this syntax checker automatically uses
packages from Cask_ projects.
.. flyc-checker:: emacs-lisp-checkdoc
:auto:
......@@ -198,6 +223,8 @@ Emacs Lisp
.. _Emacs: http://www.gnu.org/software/emacs/
.. _Emacs Lisp reference: http://www.gnu.org/software/emacs/manual/html_node/elisp/index.html
.. _flycheck-cask: https://github.com/flycheck/flycheck-cask
.. _Cask: https://github.com/cask/cask
Erlang
======
......@@ -287,9 +314,23 @@ Haskell
.. option:: flycheck-ghc-search-path
:auto:
.. seealso::
The flycheck-haskell_ extension configures this syntax checker according
to the corresponding Cabal project, and adds Cabal sandboxes.
.. flyc-checker:: haskell-hlint
:auto:
.. seealso::
The flycheck-hdevtools_ extension adds a Haskell syntax checker using
hdevtools_.
.. _flycheck-haskell: https://github.com/flycheck/flycheck-haskell
.. _flycheck-hdevtools: https://github.com/flycheck/flycheck-hdevtools
.. _hdevtools: https://github.com/bitc/hdevtools/
HTML
====
......@@ -436,6 +477,12 @@ Python
.. option:: flycheck-pylintrc
:auto:
.. seealso::
flycheck-pyflakes_ adds a Python syntax checker using Pyflakes.
.. _flycheck-pyflakes: https://github.com/Wilfred/flycheck-pyflakes
Racket
======
......@@ -510,6 +557,13 @@ Rust
.. option:: flycheck-rust-library-path
:auto:
.. seealso::
The flycheck-rust_ extension customizes this syntax checker according to
the Cargo project layout and settings.
.. _flycheck-rust: https://github.com/flycheck/flycheck-rust
Sass
====
......
......@@ -357,6 +357,13 @@ The error is displayed via :option:`flycheck-display-errors-function`:
.. option:: flycheck-display-errors-function
:auto:
.. seealso::
The `flycheck-pos-tip`_ extension provides a display function to show
errors at point in a graphical popup.
.. _flycheck-pos-tip: https://github.com/flycheck/flycheck-pos-tip
The default function displays the error messages in the echo area:
.. function:: flycheck-display-error-messages
......@@ -510,3 +517,10 @@ Change :option:`flycheck-mode-line` to customize the mode line reporting:
.. option:: flycheck-mode-line
:auto:
.. seealso::
The flycheck-color-mode-line_ extension changes the background colour of the
mode line according to the result of the last syntax check.
.. _flycheck-color-mode-line: https://github.com/flycheck/flycheck-color-mode-line
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment