Return to LIBRARY_RULES CVS log

Up to [Research Unix] / researchv9 / cmd / emacs / macros

Annotation of researchv9/cmd/emacs/macros/LIBRARY_RULES, revision 1.1.1.1

1.1       root        1: This directory contains a library of emacs macros for various purposes.
                      2: Any macros submitted to this library should follow these rules:
                      3: 
                      4: 
                      5:        Name and description (the first word of the comment on the
                      6:        first line of a macro should be a unique macro name, right
                      7:        after the ^\).
                      8:        
                      9:        A block of comments before any of the code describing in
                     10:        more detail what the macro did, who wrote it, what version
                     11:        of EMACS is needed to run it, and ways in which the user may
                     12:        wish to customize it.
                     13:        
                     14:        Comments on any lines that do something non-obvious (i.e.
                     15:        what is in the kill stack when it is used to supply a
                     16:        parameter to something.
                     17:        
                     18:        When one macro calls another, use M-x.  Do not just invoke
                     19:        them with a character sequence, so that a user can re-define
                     20:        which character yours macros are on without screwing up the
                     21:        macros. 
                     22:        
                     23:        Any macro that is not intended to be invoked by a character
                     24:        sequence should be assigned to ^X^[ (control-x escape),
                     25:        which is a highly improbable sequence to be useful for
                     26:        anything else.
                     27: 
                     28:        
                     29: I am sure that we will be developing and using lots of macros, and
                     30: that a lot of people will be looking at our macros, thus I think
                     31: that this kind of detail is essential to try to avoid problems.
                     32: 
                     33: Warren

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.