admin/notes/lel-TODO

   1 Some lisp/emacs-lisp/ Features and Where They Are Documented
   2 Copyright (C) 2007 Free Software Foundation, Inc.
   3
   4
   5 * Status Key
   6   -      -- as yet unknown
   7   n/a    -- not applicable (internal, uninteresting, etc)
   8   todo   -- not documented but should be
   9   "NODE" -- documented in or under info node NODE
  10
  11
  12 * Features
  13   advice                  -
  14   advice-preload          n/a
  15   assoc                   -
  16   authors                 -
  17   autoload                -
  18   avl-tree                -
  19   backquote               n/a
  20   benchmark               -
  21   bindat                  "(elisp) Byte Packing"
  22   byte-compile            -
  23   byte-opt                -
  24   bytecomp                -
  25   checkdoc                -
  26   cl                      "(cl)"
  27   cl-19                   n/a
  28   cl-compat               n/a
  29   cl-specs                n/a
  30   copyright               -
  31   crm                     -
  32   cust-print              -
  33   debug                   -
  34   derived                 -
  35   disass                  -
  36   easy-mmode              -
  37   easymenu                -
  38   edebug                  -
  39   eldoc                   -
  40   elint                   -
  41   elp                     -
  42   ewoc                    "(elisp) Separated Rendering"
  43   find-func               -
  44   find-gc                 -
  45   generic                 -
  46   gulp                    n/a
  47   helper                  -
  48   levents                 -
  49   lisp-float-type         -
  50   lisp-mnt                -
  51   lisp-mode               -
  52   lmenu                   -
  53   lselect                 -
  54   lucid                   -
  55   macroexp                -
  56   pp                      -
  57   re-builder              -
  58   regexp-opt              -
  59   regi                    -
  60   ring                    "(elisp) Rings"
  61   rx                      -
  62   shadow                  -
  63   sregex                  -
  64   syntax                  -
  65   testcover               -
  66   timer                   -
  67   tq                      "(elisp) Transaction Queues"
  68   trace                   -
  69   unsafep                 -
  70   warnings                -
  71
  72
  73 * Above list created using default directory lisp/emacs-lisp/ with
  74   (shell-command
  75     "sed '/^(provide '\\''/!d;s//  /;s/).*//' *.el | sort | uniq")
  76
  77
  78 * How to use this file to improve Emacs
  79   (loop
  80    (let* ((feature (choose-one Features))
  81           (status (feature-status feature)))
  82      (if (or (eq '- status) (not (verify status)))
  83          (update feature (current-docs feature))
  84        (case status
  85          (todo (let (doc patch feedback)
  86                  (while (not (grok feature))
  87                    (or (play-with feature)
  88                        (grep feature Internet)
  89                        (grep feature (wisdom-maybe "emacs-devel"))))
  90                  (setq doc (write-documentation feature)
  91                        patch (diff (current-docs) doc))
  92                  (while (not (and (correct doc)
  93                                   (well-placed doc)
  94                                   (well-formed patch)))
  95                    (setq doc (revise doc)
  96                          patch (diff (current-docs) doc))
  97                          feedback (wisdom-maybe "emacs-devel" patch))
  98                  (when (install patch)
  99                    (when (update feature (current-docs feature))
 100                      (job-well-done user-login-name)))))
 101          (n/a (job-well-done user-login-name))))))
 102
 103
 104 * Etc
 105   Local variables:
 106   mode: outline
 107   End: