runtime/doc/code_check.txt

   1 *code_check.txt*   For Vim version 7.2.  Last change: 2008 Aug 18
   2
   3
   4                   VIM REFERENCE MANUAL    by Bram Moolenaar
   5
   6
   7 CodeCheck [version 0.1]                 *codecheck* *CodeCheck* *code_check*
   8
   9 1. What is CodeCheck                    |intro|
  10 2. Using :ccadd                         |ccadd|
  11 3. Using :ccrem                         |ccrem|
  12 4. Progress                             |progress|
  13
  14 ==============================================================================
  15 1. What is CodeCheck                                            *intro*
  16
  17 *** CodeCheck is sponsored by Google under Google Summer of Code program,
  18 mentored by Bram Moolenaar and implemented by Birgi Tamersoy. ***
  19
  20 CodeCheck is an on-the-fly syntax checking tool implemented for Vim. It mimics
  21 the similar feature in Eclipse IDE. Whenever the user delays for a specified
  22 amount of time, a background thread:
  23         - creates a temporary copy of the current buffer,
  24         - compiles this temporary copy,
  25         - parses the compiler output, and
  26         - highlights the related lines in the buffer.
  27
  28 As of today (last change date), CodeCheck is highly platform-dependent. It
  29 will work only on Linux with Pthreads. Current supported file types are; C/C++
  30 independent source files.
  31
  32 ==============================================================================
  33 2. Using :ccadd                                                 *ccadd*
  34
  35 Usage:
  36 :ccadd <compile command>        Adds current buffer to the CodeCheck
  37                                 watchlist. <compile command> is required.
  38                                 <compile command> must include the full path
  39                                 of the corresponding buffer.
  40
  41 Example:
  42 :ccadd gcc -Wall -c /home/birgi/tmp/a/b/main.c
  43
  44 ==============================================================================
  45 3. Using :ccrem                                                 *ccrem*
  46
  47 Usage:
  48 :ccrem                          Removes current buffer from the CodeCheck
  49                                 watchlist. This command does not take any
  50                                 arguments. If the buffer is not being watched,
  51                                 the command is simply ignored.
  52
  53 ==============================================================================
  54 4. Progress                                                     *progress*
  55
  56 As of today (last change date) the maintainer works on the following issues:
  57 - Porting to Windows.
  58 - Specific parts highlighting rather than line highlighting.
  59 - Implementing a mechanism that would make new compiler/language support
  60   easier.
  61
  62 ==============================================================================