aboutsummaryrefslogtreecommitdiffstats
path: root/src/vppinfra/README
blob: 579696b6e05c622b3c9c6ca7d9ac662391272224 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
Welcome to vppinfra a programming library of basic data structures.

vec.c		dynamic vectors
bitmap.h	dynamic bitmaps
heap.c		allocation heap of objects (sub-objects have variable size)
pool.h		allocation pool (like heap with size always 1)
hash.c		dynamic hash tables
mheap.c		memory allocator (a la dlmalloc)

format.c	extendable printf-like thing built on top of vectors
std-formats.c	formats for unix data structures, networking stuff, ...
timer.c		arrange for functions to be called at given times.


Build, Test, Install, Use...
----------------------------
    If this package came from the distribution tar ball, skip to the
    Build Section.  If this was a gentoo ebuild, after emerge/ebuild,
    skip to the Use Section; otherwise, start with Pre-Build.

Pre-Build
-----------
    1) svn checkout svn://teaktechnologies.com/fn/trunk/clib clib
    2) autoreconf [-v][-f][-i]	# regenerate configuration files

Build
-----
    1) cd BUILD			#  which may be different than this SRC dir
    2) ${SRC}/configure [--host=CHOST]
    3) make

Test
----
    If not cross-compiling (i.e. CBUILD == CHOST), use "make check" to
    run the validation programs.

Install
-------
    With the root effective user ID (i.e. su or sudo), run "make install".

Use
---
    We need to reference man pages and theory of operation.