cvs commit: apache-2.0/src/os/unix os.h

[rb...@locus.apache.org]

rbb         00/08/07 21:27:41

  Modified:    src/os/unix os.h
  Log:
  Document os.h.  I am only documenting the Unix copy, because every os.h
  file has the same functions, and I don't want to duplicate docs.  When we
  generate docs, we'll just grab them from this directory.
  
  Revision  Changes    Path
  1.12      +53 -0     apache-2.0/src/os/unix/os.h
  
  Index: os.h
  ===================================================================
  RCS file: /home/cvs/apache-2.0/src/os/unix/os.h,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- os.h	2000/08/06 06:07:52	1.11
  +++ os.h	2000/08/08 04:27:40	1.12
  @@ -65,6 +65,10 @@
   #define PLATFORM "Unix"
   #endif
   
  +/**
  + * @package OS Specific Functions
  + */
  +
   /*
    * This file in included in all Apache source code. It contains definitions
    * of facilities available on _this_ operating system (HAVE_* macros),
  @@ -77,6 +81,12 @@
    */
   #define INLINE extern apr_inline
   
  +/**
  + * Is the path an absolute or relative path
  + * @param file The path to the file
  + * @return 1 if absolute, 0 otherwise
  + * @deffunc int ap_os_is_path_absolute(const char *file)
  + */
   INLINE int ap_os_is_path_absolute(const char *file);
   
   #include "os-inline.c"
  @@ -91,10 +101,53 @@
   
   /* Other ap_os_ routines not used by this platform */
   
  +/**
  + * Perform canonicalization on a given filename.  This means that files on
  + * all platforms have the same format
  + * @param p The pool to allocate the canonical filename out of
  + * @param f The filename to canonicalize
  + * @return The new filename
  + * @deffunc char *ap_os_canonical_filename(apr_pool_t *p, const char *f)
  + */
   #define ap_os_canonical_filename(p,f)  (f)
  +
  +/**
  + * Perform canonicalization on a given filename, except that the input case
  + * is preserved.
  + * @param p The pool to allocate the canonical filename out of
  + * @param f The filename to canonicalize
  + * @return The new filename
  + * @deffunc char *ap_os_case_canonical_filename(apr_pool_t *p, const char *f)
  + */
   #define ap_os_case_canonical_filename(p,f)  (f)
  +
  +/**
  + * Tries to match a filename to the existing patch, and returns the pathname
  + * in the case that is present on the existing path.  This routine also
  + * converts alias names to long names.
  + * @param p The pool to allocate out of
  + * @param f The file to match
  + * @return The matched file name with the correct case
  + * @deffunc char *ap_os_systemcase_filename(apr_pool_t *p, const char *f)
  + */
   #define ap_os_systemcase_filename(p,f)  (f)
  +
  +/**
  + * Tests for validity of a filename on the current platform.  The tests for
  + * validity are operating system specific
  + * @param f The file to test
  + * @return 1 If the filename is valid, 0 otherwise
  + * @deffunc int ap_os_is_filename_valid(const char *file)
  + */
   #define ap_os_is_filename_valid(f)          (1)
  +
  +/**
  + * Send a signal to a specified process
  + * @param pid the process to send the signal to
  + * @param sig the signal to send
  + * @return On success 0, on error -1
  + * @deffunc int ap_os_kill(pid_t pid, int sig)
  + */
   #define ap_os_kill(pid, sig)                kill(pid, sig)
   
   #endif	/* !APACHE_OS_H */