vppinfra/README

   1 Welcome to vppinfra a programming library of basic data structures.
   2
   3 vec.c           dynamic vectors
   4 bitmap.h        dynamic bitmaps
   5 heap.c          allocation heap of objects (sub-objects have variable size)
   6 pool.h          allocation pool (like heap with size always 1)
   7 hash.c          dynamic hash tables
   8 mheap.c         memory allocator (a la dlmalloc)
   9
  10 format.c        extendable printf-like thing built on top of vectors
  11 std-formats.c   formats for unix data structures, networking stuff, ...
  12 timer.c         arrange for functions to be called at given times.
  13
  14
  15 Build, Test, Install, Use...
  16 ----------------------------
  17     If this package came from the distribution tar ball, skip to the
  18     Build Section.  If this was a gentoo ebuild, after emerge/ebuild,
  19     skip to the Use Section; otherwise, start with Pre-Build.
  20
  21 Pre-Build
  22 -----------
  23     1) svn checkout svn://teaktechnologies.com/fn/trunk/clib clib
  24     2) autoreconf [-v][-f][-i]  # regenerate configuration files
  25
  26 Build
  27 -----
  28     1) cd BUILD                 #  which may be different than this SRC dir
  29     2) ${SRC}/configure [--host=CHOST]
  30     3) make
  31
  32 Test
  33 ----
  34     If not cross-compiling (i.e. CBUILD == CHOST), use "make check" to
  35     run the validation programs.
  36
  37 Install
  38 -------
  39     With the root effective user ID (i.e. su or sudo), run "make install".
  40
  41 Use
  42 ---
  43     We need to reference man pages and theory of operation.