vpp/vppinfra
Chris Luke d4024f5862 VPP-346 More VPP doc fixes
- Fix issue in Doxy dependency check when nothing needs to be installed.
  'set -e' and plain '[]' logic don't mix well.
- Fix Makefile snafu when building Doxy output for a single file.
- Include only one of vnet/vnet/buffer.c/dpdk_buffer.c in docs depending on
  DPDKness. This could do with some improvement in future, eg to properly
  align the pre-doxy steps with what Doxy does.
- Fix rendering of 'inline' tag in Doxygen by having it interpret
  always_inline as "inline static".
- Bunch of duplicate CLI command structure names that confused docs and may
  one day have caused debugging issues.
- Several other Doxygen syntax issues fixed, like documenting non-existant
  parameters (usually just the wrong parameter name, typos, etc)

Change-Id: Ia8cca545e5de9f8750602bffa3c4548acc8971aa
Signed-off-by: Chris Luke <chrisy@flirble.org>
2016-09-06 20:35:28 +00:00
..
2016-09-06 20:35:28 +00:00

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.