Remove some admin/notes files

* admin/notes/lel-TODO: Remove.  This has not turned out to be a
useful way to get things documented.

* admin/notes/exit-value, admin/notes/iftc: Remove.
These don't seem to have any particular relationship to Emacs development.
This commit is contained in:
Glenn Morris 2014-10-15 00:07:29 -07:00
parent 0b29869290
commit 12e8ede75c
3 changed files with 0 additions and 178 deletions

View file

@ -1,28 +0,0 @@
ttn 2004-05-09
The exit value of a program returning to the shell on unixoid systems
is typically 0 for success, and non-0 (such as 1) for failure. This is
not always the case on other systems.
From the point of view of the program stdlib.h provides macros
`EXIT_SUCCESS' and `EXIT_FAILURE' that should DTRT. N.B. The
numerical values of these macros DO NOT need to fulfill the exit value
requirements outlined in the first paragraph! That is the job of the
`exit' function. Thus, this kind of construct shows misunderstanding:
#ifdef WEIRD_OS
exit (1);
#else
exit (0);
#endif
Values aside from EXIT_SUCCESS and EXIT_FAILURE are tricky, but can be
used to indicate finer gradations of failure. If this is the only
information available to the caller, clamping such values to
EXIT_FAILURE loses information. If there are other ways to indicate
the problem to the caller (such as a message to stderr) it may be ok
to clamp. In all cases, it is the relationship between the program
and its caller that must be examined.
[Insert ZAMM quote here.] <-- I presume this refers to ``Zen and the
Art of Motorcycle Maintenance'' - Reuben Thomas <rrt@sc3d.org>.

View file

@ -1,26 +0,0 @@
Iso-Functional Type Contour
This is a term coined to describe "column int->float" change approach, and can
be used whenever low-level types need to change (hopefully not often!) but the
meanings of the values (whose type has changed) do not.
The premise is that changing a low-level type potentially means lots of code
needs to be changed as well, and the question is how to do this incrementally,
which is the preferred way to change things.
Say LOW and HIGH are C functions:
int LOW (void) { return 1; }
void HIGH (void) { int value = LOW (); }
We want to convert LOW to return float, so we cast HIGH usage:
float LOW (void) { return 1.0; }
void HIGH (void) { int value = (int) LOW (); } /* iftc */
The comment /* iftc */ is used to mark this type of casting to differentiate
it from other casting. We commit the changes and can now go about modifying
LOW and HIGH separately. When HIGH is ready to handle the type change, the
cast can be removed.

View file

@ -1,124 +0,0 @@
Some lisp/emacs-lisp/ Features and Where They Are Documented
Copyright (C) 2007-2014 Free Software Foundation, Inc.
See the end of the file for license conditions.
* Status Key
- -- as yet unknown
n/a -- not applicable (internal, uninteresting, etc)
obsolete -- an obsolete feature, to be removed in future
todo -- not documented but should be
NODE -- documented in or under info node NODE
* Features
advice (elisp) Advising Functions
advice-preload n/a
assoc -
authors -
autoload (elisp) Autoload
avl-tree -
backquote n/a
benchmark n/a
bindat (elisp) Byte Packing
byte-compile (elisp) Byte Compilation
byte-opt -
bytecomp (elisp) Compilation Functions
checkdoc (elisp) Documentation Tips
cl (cl)
cl-compat n/a
cl-specs n/a
copyright -
crm -
cust-print (elisp) Printing in Edebug
debug (elisp) Debugger
derived (elisp) Derived Modes
disass (elisp) Disassembly
easy-mmode (elisp) Defining Minor Modes
easymenu -
edebug (elisp) Edebug
eldoc -
elint -
elp n/a
ewoc (elisp) Separated Rendering
find-func -
find-gc -
generic (elisp) Generic Modes
gulp n/a
helper -
levents obsolete
lisp-float-type -
lisp-mnt -
lisp-mode n/a
lmenu obsolete
lucid obsolete
macroexp (elisp) Expansion
pp (emacs) Program Indent
re-builder -
regexp-opt (elisp) Regexp Functions
regi -
ring (elisp) Rings
rx -
shadow -
sregex obsolete
syntax (elisp) Position Parse
testcover -
timer (elisp) Timers
tq (elisp) Transaction Queues
trace -
unsafep (elisp) Function Safety
warnings (elisp) Warnings
* Above list created using default directory lisp/emacs-lisp/ with
(shell-command
"sed '/^(provide '\\''/!d;s// /;s/).*//' *.el | sort | uniq")
* How to use this file to improve Emacs
(loop
(let* ((feature (choose-one Features))
(status (feature-status feature)))
(if (or (eq '- status) (not (verify status)))
(update feature (current-docs feature))
(case status
(todo (let (doc patch feedback)
(while (not (grok feature))
(or (play-with feature)
(grep feature Internet)
(grep feature (wisdom-maybe "emacs-devel"))))
(setq doc (write-documentation feature)
patch (diff (current-docs) doc))
(while (not (and (correct doc)
(well-placed doc)
(well-formed patch)))
(setq doc (revise doc)
patch (diff (current-docs) doc))
feedback (wisdom-maybe "emacs-devel" patch))
(when (install patch)
(when (update feature (current-docs feature))
(job-well-done user-login-name)))))
(n/a (job-well-done user-login-name))))))
* Etc
This file is part of GNU Emacs.
GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
Local variables:
mode: outline
End: