admin/notes/lel-TODO

   1 Some lisp/emacs-lisp/ Features and Where They Are Documented
   2
   3 Copyright (C) 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
   4 See the end of the file for license conditions.
   5
   6
   7 * Status Key
   8   -      -- as yet unknown
   9   n/a    -- not applicable (internal, uninteresting, etc)
  10   todo   -- not documented but should be
  11   NODE   -- documented in or under info node NODE
  12
  13
  14 * Features
  15   advice                  (elisp) Advising Functions
  16   advice-preload          n/a
  17   assoc                   -
  18   authors                 -
  19   autoload                (elisp) Autoload
  20   avl-tree                -
  21   backquote               n/a
  22   benchmark               n/a
  23   bindat                  (elisp) Byte Packing
  24   byte-compile            (elisp) Byte Compilation
  25   byte-opt                -
  26   bytecomp                (elisp) Compilation Functions
  27   checkdoc                (elisp) Documentation Tips
  28   cl                      (cl)
  29   cl-19                   n/a
  30   cl-compat               n/a
  31   cl-specs                n/a
  32   copyright               -
  33   crm                     -
  34   cust-print              (elisp) Printing in Edebug
  35   debug                   (elisp) Debugger
  36   derived                 (elisp) Derived Modes
  37   disass                  (elisp) Disassembly
  38   easy-mmode              (elisp) Defining Minor Modes
  39   easymenu                -
  40   edebug                  (elisp) Edebug
  41   eldoc                   -
  42   elint                   -
  43   elp                     n/a
  44   ewoc                    (elisp) Separated Rendering
  45   find-func               -
  46   find-gc                 -
  47   generic                 (elisp) Generic Modes
  48   gulp                    n/a
  49   helper                  -
  50   levents                 -
  51   lisp-float-type         -
  52   lisp-mnt                -
  53   lisp-mode               n/a
  54   lmenu                   -
  55   lselect                 -
  56   lucid                   -
  57   macroexp                (elisp) Expansion
  58   pp                      (emacs) Program Indent
  59   re-builder              -
  60   regexp-opt              (elisp) Regexp Functions
  61   regi                    -
  62   ring                    (elisp) Rings
  63   rx                      -
  64   shadow                  -
  65   sregex                  -
  66   syntax                  (elisp) Position Parse
  67   testcover               -
  68   timer                   (elisp) Timers
  69   tq                      (elisp) Transaction Queues
  70   trace                   -
  71   unsafep                 (elisp) Function Safety
  72   warnings                (elisp) Warnings
  73
  74
  75 * Above list created using default directory lisp/emacs-lisp/ with
  76   (shell-command
  77     "sed '/^(provide '\\''/!d;s//  /;s/).*//' *.el | sort | uniq")
  78
  79
  80 * How to use this file to improve Emacs
  81   (loop
  82    (let* ((feature (choose-one Features))
  83           (status (feature-status feature)))
  84      (if (or (eq '- status) (not (verify status)))
  85          (update feature (current-docs feature))
  86        (case status
  87          (todo (let (doc patch feedback)
  88                  (while (not (grok feature))
  89                    (or (play-with feature)
  90                        (grep feature Internet)
  91                        (grep feature (wisdom-maybe "emacs-devel"))))
  92                  (setq doc (write-documentation feature)
  93                        patch (diff (current-docs) doc))
  94                  (while (not (and (correct doc)
  95                                   (well-placed doc)
  96                                   (well-formed patch)))
  97                    (setq doc (revise doc)
  98                          patch (diff (current-docs) doc))
  99                          feedback (wisdom-maybe "emacs-devel" patch))
 100                  (when (install patch)
 101                    (when (update feature (current-docs feature))
 102                      (job-well-done user-login-name)))))
 103          (n/a (job-well-done user-login-name))))))
 104
 105
 106 * Etc
 107
 108 This file is part of GNU Emacs.
 109
 110 GNU Emacs is free software: you can redistribute it and/or modify
 111 it under the terms of the GNU General Public License as published by
 112 the Free Software Foundation, either version 3 of the License, or
 113 (at your option) any later version.
 114
 115 GNU Emacs is distributed in the hope that it will be useful,
 116 but WITHOUT ANY WARRANTY; without even the implied warranty of
 117 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 118 GNU General Public License for more details.
 119
 120 You should have received a copy of the GNU General Public License
 121 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 122
 123   Local variables:
 124   mode: outline
 125   End: