aboutsummaryrefslogtreecommitdiffstats
path: root/src/vppinfra/README
diff options
context:
space:
mode:
authorDave Barach <dave@barachs.net>2018-04-30 10:50:13 -0400
committerFlorin Coras <florin.coras@gmail.com>2018-04-30 16:23:59 +0000
commit300f2f4ddb9fe4c39bb225477e4979d56964b41a (patch)
tree86f2fd406ab3c148b6ef7180e6038e94e696f1b3 /src/vppinfra/README
parent56f949b9d3d1c3ba6816169fff852a51bbe47a15 (diff)
Remove historical README file
Change-Id: I54a00686a7f3a61f583a5f701a0ab6c5480a455b Signed-off-by: Dave Barach <dave@barachs.net>
Diffstat (limited to 'src/vppinfra/README')
-rw-r--r--src/vppinfra/README43
1 files changed, 0 insertions, 43 deletions
diff --git a/src/vppinfra/README b/src/vppinfra/README
deleted file mode 100644
index 579696b6e05..00000000000
--- a/src/vppinfra/README
+++ /dev/null
@@ -1,43 +0,0 @@
-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.