src/README.md

   1 <!---
   2 This work is licensed under a Creative Commons Attribution 4.0 International License.
   3 http://creativecommons.org/licenses/by/4.0
   4 -->
   5
   6 ### Purpose of this folder - Quickview
   7
   8 1. contains place holders for upstream source code package.
   9 2. manages the package dependency
  10 3. provides simple one-button build for test developers
  11
  12 ### Motivation Explained
  13
  14 There are multiple goals for the project vswitch performance characterization.
  15 First,  it is a generic test framework that can be used to characterize any vswitch solution.
  16 Second, it is to be as CI tool to validate any change during development.
  17
  18 For the first goal, it would be nice to get all the relevant upstream source package and
  19 to provide a easy build environment for a given test developer. Obviously we don't want to
  20 rewrite the makefile system from upstream project. However we need to add a wrapper to the
  21 individual packages to manage package dependecy. For example, to test ovs-dpdk vswitch solution,
  22 the build of ovs would depend on the build result of dpdk.
  23 This dependency is never explicitly specified in the individual package.
  24
  25 For the second goal as a CI tool, it may not be needed to pull the upstream package.
  26 So this whole folder can be ignored.
  27
  28 ### Files and subfolders
  29
  30 * package-list: contains list of packages and their associated tags
  31 * mk:           contains top level makefiles
  32 * dpdk:         place holder for dpdk package
  33 * ovs:          place holder for ovs package.
  34 * l2fwd:        simple l2 forwarding kernel module