admin/notes/lel-TODO

   1 Some lisp/emacs-lisp/ Features and Where They Are Documented
   2
   3 Copyright (C) 2007-2014 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   obsolete -- an obsolete feature, to be removed in future
  11   todo   -- not documented but should be
  12   NODE   -- documented in or under info node NODE
  13
  14
  15 * Features
  16   advice                  (elisp) Advising Functions
  17   advice-preload          n/a
  18   assoc                   -
  19   authors                 -
  20   autoload                (elisp) Autoload
  21   avl-tree                -
  22   backquote               n/a
  23   benchmark               n/a
  24   bindat                  (elisp) Byte Packing
  25   byte-compile            (elisp) Byte Compilation
  26   byte-opt                -
  27   bytecomp                (elisp) Compilation Functions
  28   checkdoc                (elisp) Documentation Tips
  29   cl                      (cl)
  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                 obsolete
  51   lisp-float-type         -
  52   lisp-mnt                -
  53   lisp-mode               n/a
  54   lmenu                   obsolete
  55   lucid                   obsolete
  56   macroexp                (elisp) Expansion
  57   pp                      (emacs) Program Indent
  58   re-builder              -
  59   regexp-opt              (elisp) Regexp Functions
  60   regi                    -
  61   ring                    (elisp) Rings
  62   rx                      -
  63   shadow                  -
  64   sregex                  obsolete
  65   syntax                  (elisp) Position Parse
  66   testcover               -
  67   timer                   (elisp) Timers
  68   tq                      (elisp) Transaction Queues
  69   trace                   -
  70   unsafep                 (elisp) Function Safety
  71   warnings                (elisp) Warnings
  72
  73
  74 * Above list created using default directory lisp/emacs-lisp/ with
  75   (shell-command
  76     "sed '/^(provide '\\''/!d;s//  /;s/).*//' *.el | sort | uniq")
  77
  78
  79 * How to use this file to improve Emacs
  80   (loop
  81    (let* ((feature (choose-one Features))
  82           (status (feature-status feature)))
  83      (if (or (eq '- status) (not (verify status)))
  84          (update feature (current-docs feature))
  85        (case status
  86          (todo (let (doc patch feedback)
  87                  (while (not (grok feature))
  88                    (or (play-with feature)
  89                        (grep feature Internet)
  90                        (grep feature (wisdom-maybe "emacs-devel"))))
  91                  (setq doc (write-documentation feature)
  92                        patch (diff (current-docs) doc))
  93                  (while (not (and (correct doc)
  94                                   (well-placed doc)
  95                                   (well-formed patch)))
  96                    (setq doc (revise doc)
  97                          patch (diff (current-docs) doc))
  98                          feedback (wisdom-maybe "emacs-devel" patch))
  99                  (when (install patch)
 100                    (when (update feature (current-docs feature))
 101                      (job-well-done user-login-name)))))
 102          (n/a (job-well-done user-login-name))))))
 103
 104
 105 * Etc
 106
 107 This file is part of GNU Emacs.
 108
 109 GNU Emacs is free software: you can redistribute it and/or modify
 110 it under the terms of the GNU General Public License as published by
 111 the Free Software Foundation, either version 3 of the License, or
 112 (at your option) any later version.
 113
 114 GNU Emacs is distributed in the hope that it will be useful,
 115 but WITHOUT ANY WARRANTY; without even the implied warranty of
 116 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 117 GNU General Public License for more details.
 118
 119 You should have received a copy of the GNU General Public License
 120 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 121
 122   Local variables:
 123   mode: outline
 124   End: