cvs commit: apache-apr/docs apr-function.txt

[rb...@hyperreal.org]

rbb         99/02/16 05:11:01

  Modified:    docs     apr-function.txt
  Log:
  Added some Design principles to this document.  These are important things
  that nobody has mentioned yet.
  
  Revision  Changes    Path
  1.6       +11 -0     apache-apr/docs/apr-function.txt
  
  Index: apr-function.txt
  ===================================================================
  RCS file: /home/cvs/apache-apr/docs/apr-function.txt,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- apr-function.txt	1999/01/25 16:30:40	1.5
  +++ apr-function.txt	1999/02/16 13:11:00	1.6
  @@ -2,6 +2,17 @@
   
   <h1>Design Principles</h1>
   
  +Internal representations should be kept hidden as much as possible.  Accessor
  +functions should be provided to get at the fields within each structure, 
  +because the actual internals should be different on each OS.
  +
  +When creating a function for any OS, please keep in mind that this is being
  +designed as a PORTABLE run-time.  If there is a function that only one OS
  +implements, and it is IMPOSSIBLE to emulate on any other system.  Make a note
  +about it in the comments, but please do not add the function.  When other OS's
  +can implement the same function, it should be added to APR.  We do not want 
  +functions to do different things on different platforms from the get-go though.
  +
   We try to look like POSIX where possible, but the first design goal is a
   clean API without a lot of overhead.