[AUCTeX-diffs] [elpa] externals/auctex 5592c69 35/43: Improve flymake documentation

[Tassilo Horn]

branch: externals/auctex
commit 5592c69435c03110e207ef05feed96741cb94d1b
Author: Alex Branham <address@hidden>
Commit: Arash Esbati <address@hidden>

    Improve flymake documentation
    
    * doc/changes.texi:
    * doc/auctex.texi (Checking): Add Flymake support to manual.
    
    * latex-flymake.el: Add copyright notice and fix a quote.
    
    Signed-off-by: Arash Esbati <address@hidden>
---
 doc/auctex.texi  | 21 +++++++++++++++++----
 doc/changes.texi |  9 +++++++++
 latex-flymake.el | 27 ++++++++++++++++++++++++++-
 3 files changed, 52 insertions(+), 5 deletions(-)

diff --git a/doc/auctex.texi b/doc/auctex.texi
index 08cfe04..39451c7 100644
--- a/doc/auctex.texi
+++ b/doc/auctex.texi
@@ -3831,6 +3831,8 @@ will be used regardless of the value of this variable.
 @cindex Running @code{chktex}
 @cindex Style
 @cindex Problems
address@hidden Flymake
address@hidden Running Flymake
 
 Running @TeX{} or @LaTeX{} will only find regular errors in the
 document, not examples of bad style.  Furthermore, description of the
@@ -3844,10 +3846,21 @@ escape the space after an abbreviation or using 
@samp{...} instead of
 @kbd{C-x `} (@code{next-error}, @pxref{Compilation,,,emacs,The Emacs
 Editor}), which will move point to the location of the next error.
 
-Each of the two utilities will find some errors the other doesn't, but
address@hidden is more configurable, allowing you to create your own
-errors.  You may need to install the programs before using them.  You
-can get @code{lacheck} from
+Alternatively, you may want in-buffer notation.  @AUCTeX{} provides
+support for this using the Flymake package in Emacs 26 or newer
+(@xref{Using Flymake,,,Flymake,GNU Flymake} for details).  To enable,
+call @kbd{M-x flymake-mode RET} in the buffer or enable it in all
+buffers by adding this to your init file:
address@hidden
+(add-hook 'LaTeX-mode-hook #'flymake-mode)
address@hidden lisp
+Note that @AUCTeX{} currently only provides support for using
address@hidden as the flymake backend.
+
+Each of the two utilities @code{lacheck} and @code{chktex} will find
+some errors the other doesn't, but @code{chktex} is more configurable,
+allowing you to create your own errors.  You may need to install the
+programs before using them.  You can get @code{lacheck} from
 @file{<URL:ftp://ftp.ctan.org/tex-archive/support/lacheck/>} and
 @code{chktex} from
 @file{<URL:ftp://ftp.ctan.org/tex-archive/support/chktex/>}.
diff --git a/doc/changes.texi b/doc/changes.texi
index ea3e4e8..bddec6a 100644
--- a/doc/changes.texi
+++ b/doc/changes.texi
@@ -18,6 +18,15 @@ been dropped.
 @item
 Besides the change in the supported version of Emacs, there has been no
 functional change in this release, which is equivalent to version 11.92.
+
address@hidden
address@hidden has support for the Flymake package in Emacs 26 or newer.  To
+enable, call @kbd{M-x flymake-mode RET} or add this to your
address@hidden file:
address@hidden
+(add-hook 'LaTeX-mode-hook #'flymake-mode)
address@hidden lisp
+
 @end itemize
 
 @heading News in 11.92
diff --git a/latex-flymake.el b/latex-flymake.el
index e77e059..b06149c 100644
--- a/latex-flymake.el
+++ b/latex-flymake.el
@@ -1,11 +1,36 @@
 ;;; latex-flymake.el --- Flymake integration  -*- lexical-binding: t; -*-
 
+;; Copyright (C), 2018 Free Software Foundation, Inc.
+
+;; Author: Alex Branham <address@hidden>
+;; Maintainer: address@hidden
+;; Created: 2018-02-11
+;; Keywords: tex
+
+;; This file is part of AUCTeX.
+
+;; AUCTeX 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, or (at your option)
+;; any later version.
+
+;; AUCTeX 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.
+
+;; You should have received a copy of the GNU General Public License
+;; along with AUCTeX; see the file COPYING.  If not, write to the Free
+;; Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
+;; 02110-1301, USA.
+
 ;;; Commentary:
+
 ;; This file provides flymake integration for latex documents using
 ;; "chktex" as a backend.  You must be running Emacs 26 or newer.
 ;; Enable it by adding the following to your init file:
 
-;; (add-hook 'LaTeX-mode-hook flymake-mode)
+;;   (add-hook 'LaTeX-mode-hook #'flymake-mode)
 
 ;;; Code: