chiark / gitweb /
Merge branch 'work'
[mLib] / sub.c
diff --git a/sub.c b/sub.c
index f065f9d0e2bab4dd68fc9de0d841473017f098ce..06570b609b0e629e68198faf04b6aaeefa99ff75 100644 (file)
--- a/sub.c
+++ b/sub.c
@@ -1,13 +1,13 @@
 /* -*-c-*-
  *
- * $Id: sub.c,v 1.8 2003/10/12 14:44:46 mdw Exp $
+ * $Id: sub.c,v 1.9 2004/04/08 01:36:13 mdw Exp $
  *
  * Allocation of known-size blocks
  *
  * (c) 1998 Straylight/Edgeware
  */
 
-/*----- Licensing notice --------------------------------------------------* 
+/*----- Licensing notice --------------------------------------------------*
  *
  * This file is part of the mLib utilities library.
  *
  * it under the terms of the GNU Library General Public License as
  * published by the Free Software Foundation; either version 2 of the
  * License, or (at your option) any later version.
- * 
+ *
  * mLib 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 Library General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU Library General Public
  * License along with mLib; if not, write to the Free
  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  * MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------*
- *
- * $Log: sub.c,v $
- * Revision 1.8  2003/10/12 14:44:46  mdw
- * Various fixes.
- *
- * Revision 1.7  2003/05/18 15:10:20  mdw
- * Add debugging mode which just uses the underlying arena.
- *
- * Revision 1.6  2000/06/17 10:35:51  mdw
- * Major overhaul for arena support.
- *
- * Revision 1.5  1999/05/19 20:27:11  mdw
- * Change naming to match newer mLib conventions.
- *
- * Revision 1.4  1999/05/13 22:48:55  mdw
- * Change `-ise' to `-ize' throughout.
- *
- * Revision 1.3  1999/05/06 19:51:35  mdw
- * Reformatted the LGPL notice a little bit.
- *
- * Revision 1.2  1999/05/05 18:50:31  mdw
- * Change licensing conditions to LGPL.
- *
- * Revision 1.1.1.1  1998/06/17 23:44:42  mdw
- * Initial version of mLib
- *
- */
-
 /*----- The big idea ------------------------------------------------------*
  *
  * This file provides an extra layer over @malloc@.  It provides fast
@@ -190,12 +161,12 @@ void subarena_destroy(subarena *s)
 
 /* --- @subarena_alloc@ --- *
  *
- * Arguments:   @subarena *s@ = pointer to arena
+ * Arguments:  @subarena *s@ = pointer to arena
  *             @size_t s@ = size of chunk wanted
  *
- * Returns:     Pointer to a block at least as large as the one wanted.
+ * Returns:    Pointer to a block at least as large as the one wanted.
  *
- * Use:         Allocates a small block of memory from the given pool.  The
+ * Use:                Allocates a small block of memory from the given pool.  The
  *             exception @EXC_NOMEM@ is raised if the underlying arena is
  *             full.
  */
@@ -276,13 +247,13 @@ void *subarena_alloc(subarena *s, size_t sz)
 
 /* --- @subarena_free@ --- *
  *
- * Arguments:   @subarena *s@ = pointer to arena
+ * Arguments:  @subarena *s@ = pointer to arena
  *             @void *p@ = address of block to free
- *              @size_t s@ = size of block
+ *             @size_t s@ = size of block
  *
- * Returns:     ---
+ * Returns:    ---
  *
- * Use:         Frees a block allocated by @subarena_alloc@.
+ * Use:                Frees a block allocated by @subarena_alloc@.
  */
 
 void subarena_free(subarena *s, void *p, size_t sz)
@@ -319,34 +290,34 @@ void subarena_free(subarena *s, void *p, size_t sz)
 
 /* --- @sub_alloc@ --- *
  *
- * Arguments:   @size_t s@ = size of chunk wanted
+ * Arguments:  @size_t s@ = size of chunk wanted
  *
- * Returns:     Pointer to a block at least as large as the one wanted.
+ * Returns:    Pointer to a block at least as large as the one wanted.
  *
- * Use:         Allocates a small block of memory from the @sub_global@ pool.
+ * Use:                Allocates a small block of memory from the @sub_global@ pool.
  */
 
 void *(sub_alloc)(size_t sz) { return sub_alloc(sz); }
 
 /* --- @sub_free@ --- *
  *
- * Arguments:   @void *p@ = address of block to free
- *              @size_t s@ = size of block
+ * Arguments:  @void *p@ = address of block to free
+ *             @size_t s@ = size of block
  *
- * Returns:     ---
+ * Returns:    ---
  *
- * Use:         Frees a block allocated by @sub_alloc@.
+ * Use:                Frees a block allocated by @sub_alloc@.
  */
 
 void (sub_free)(void *p, size_t sz) { sub_free(p, sz); }
 
 /* --- @sub_init@ --- *
  *
- * Arguments:   ---
+ * Arguments:  ---
  *
- * Returns:     ---
+ * Returns:    ---
  *
- * Use:         Initializes the magic allocator.
+ * Use:                Initializes the magic allocator.
  */
 
 void sub_init(void)