Changeset 16

Show
Ignore:
Timestamp:
05/13/06 20:37:27 (7 years ago)
Author:
richdawe
Message:

Use doxygen to build docs; generate spec file using configure; use tar.bz2 instead of tar.gz

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/Makefile.am

    r13 r16  
    1 EXTRA_DIST = COPYRIGHT OPENSOLARIS.LICENSE umem.spec 
     1EXTRA_DIST = COPYRIGHT OPENSOLARIS.LICENSE umem.spec Doxyfile 
    22 
    33lib_LTLIBRARIES = libumem.la 
    …… 
    3434TESTS = umem_test 
    3535 
     36html-local: 
     37        mkdir -p docs 
     38        doxygen Doxyfile 
     39 
     40clean-local: 
     41        rm -rf docs 
     42 
     43.PHONY: rpm 
     44rpm:    $(distdir).tar.bz2 
     45        rpmbuild -ta $< 
     46 
    3647# malloc.c 
    3748 

  • trunk/TODO

    r11 r16  
    1111* ec_debug_vprintf -> something else? 
    1212 
    13 * doxygen'ate the headers/code, to produce reference docs. 
    14  
    15 * rpm spec file. 
    16  
    1713* test suite. 
    1814 
    1915* static library support. 
     16 
     17* doxygen'ate the headers/code, to produce reference docs. 
     18 
     19* HAVE_DOT in Doxyfile.in should be detected by configure. 

  • trunk/configure.ac

    r6 r16  
    11AC_INIT([umem], [1.0], [], [umem]) 
    2 AM_INIT_AUTOMAKE 
     2AM_INIT_AUTOMAKE([dist-bzip2]) 
    33 
    44AC_PROG_CC 
    …… 
    1111 
    1212AC_CONFIG_HEADERS([config.h]) 
    13 AC_CONFIG_FILES([Makefile]) 
     13AC_CONFIG_FILES([Makefile Doxyfile umem.spec]) 
    1414 
    1515AC_OUTPUT 

  • trunk/umem.c

    r2 r16  
    3030/* #pragma ident        "@(#)umem.c     1.11    05/06/08 SMI" */ 
    3131 
    32 /* 
     32/*! 
     33 * \mainpage Main Page 
     34 * 
     35 * \section README 
     36 * 
     37 * \include README 
     38 * 
     39 * \section Nuances 
     40 * 
     41 * There is a nuance in the behaviour of the umem port compared 
     42 * with umem on Solaris. 
     43 * 
     44 * On Linux umem will not return memory back to the OS until umem fails 
     45 * to allocate a chunk. On failure, umem_reap() will be called automatically, 
     46 * to return memory to the OS. If your code is going to be running 
     47 * for a long time on Linux and mixes calls to different memory allocators 
     48 * (e.g.: malloc()) and umem, your code will need to call 
     49 * umem_reap() periodically. 
     50 * 
     51 * This doesn't happen on Solaris, because malloc is replaced 
     52 * with umem calls, meaning that umem_reap() is called automatically. 
     53 * 
     54 * \section References 
     55 * 
     56 * http://docs.sun.com/app/docs/doc/816-5173/6mbb8advq?a=view 
     57 * 
     58 * http://access1.sun.com/techarticles/libumem.html 
     59 * 
     60 * \section Overview 
     61 * 
     62 * \code 
    3363 * based on usr/src/uts/common/os/kmem.c r1.64 from 2001/12/18 
    3464 * 
    …… 
    333363 *      the nofail callback does a non-local exit, we will leak the 
    334364 *      partially-constructed buffer. 
     365 * \endcode 
    335366 */ 
    336367 

  • trunk/umem.h

    r2 r16  
    4949extern void umem_free_align(void *, size_t); 
    5050 
    51 /* 
     51/*! 
    5252 * Flags for umem_cache_create() 
    5353 */ 
     54/*@{*/ 
    5455#define UMC_NOTOUCH     0x00010000 
    5556#define UMC_NODEBUG     0x00020000 
    5657#define UMC_NOMAGAZINE  0x00040000 
    5758#define UMC_NOHASH      0x00080000 
     59/*@}*/ 
    5860 
    5961struct umem_cache;              /* cache structure is opaque to umem clients */