X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/932614621659e0d590c594e362cf9fbd6ca650cf..86ab1238440991ec6edf0ee1861818e8429d613b:/man/flymake.texi diff --git a/man/flymake.texi b/man/flymake.texi index 9db7551b18..3861fe7081 100644 --- a/man/flymake.texi +++ b/man/flymake.texi @@ -11,13 +11,13 @@ This manual is for GNU Flymake (version @value{VERSION}, @value{UPDATED}), which is a universal on-the-fly syntax checker for GNU Emacs. -Copyright @copyright{} 2004 Free Software Foundation, Inc. +Copyright @copyright{} 2004, 2005, 2006 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.1 or +under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no -Invariant Sections, with the Front-Cover texts being ``A GNU Manual'', +Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License'' in the Emacs manual. @@ -55,7 +55,6 @@ license to the document, as described in section 6 of the license. @menu * Overview of Flymake:: -* Obtaining Flymake:: * Installing Flymake:: * Using Flymake:: * Configuring Flymake:: @@ -104,16 +103,6 @@ Flymake is a universal syntax checker in the sense that it's easily extended to support new syntax check tools and error message patterns. @xref{Configuring Flymake}. -@node Obtaining Flymake -@chapter Obtaining Flymake -@cindex Getting Flymake - -Release versions of Flymake can be downloaded from -@* @url{https://sourceforge.net/project/showfiles.php?group_id=77501}. -You can also try current version available via CVS at @url{https://}. - -Flymake's homepage is at @url{http://flymake.sourceforge.net}. - @node Installing Flymake @chapter Installing @cindex Installing Flymake @@ -292,7 +281,7 @@ check tools and error message patterns. @section Customizable variables @cindex Customizable variables -This section summarises variables used for Flymake +This section summarizes variables used for Flymake configuration. @table @code @@ -378,7 +367,7 @@ first item with @code{filename-regexp} matching buffer filename is selected. If no match is found, @code{flymake-mode} is switched off. @item init-function -@code{init-function} is required to initialise the syntax check, +@code{init-function} is required to initialize the syntax check, usually by creating a temporary copy of the buffer contents. The function must return @code{(list cmd-name arg-list)}. If @code{init-function} returns null, syntax check is aborted, by @@ -422,7 +411,7 @@ First, we write the @code{init-function}: (defun flymake-perl-init (buffer) (let* ((temp-file (flymake-init-create-temp-buffer-copy buffer 'flymake-create-temp-inplace)) - (local-file (concat (flymake-build-relative-path + (local-file (concat (flymake-build-relative-filename (file-name-directory (buffer-file-name (current-buffer))) @@ -639,7 +628,7 @@ and project include directories. The former is just the contents of the and the way it can be obtained can vary greatly for different projects. Therefore, a customizable variable @code{flymake-get-project-include-dirs-function} is used to provide the -way to implement the desired behaviour. +way to implement the desired behavior. The default implementation, @code{flymake-get-project-include-dirs-imp}, uses a @code{make} call. This requires a correct base directory, that is, a @@ -658,7 +647,7 @@ of every syntax check attempt. Flymake can be configured to use different tools for performing syntax checks. For example, it can use direct compiler call to syntax check a perl script or a call to @code{make} for a more complicated case of a -@code{C/C++} source. The general idea is that simple files, like perl +@code{C/C++} source. The general idea is that simple files, like perl scripts and html pages, can be checked by directly invoking a corresponding tool. Files that are usually more complex and generally used as part of larger projects, might require non-trivial options to