summaryrefslogtreecommitdiffstats
path: root/src/README.md
diff options
context:
space:
mode:
authorgoldammx <martinx.goldammer@intel.com>2017-02-15 10:15:11 -0500
committergoldammx <martinx.goldammer@intel.com>2017-02-17 10:51:08 -0500
commit681dd54cd02cc9e89f26f2799680bfe6eac5ef51 (patch)
treea384d122ca32801b8d0fe351129ec0890a228a43 /src/README.md
parentba1f2ace691c0564965770855b1128eec2f0cb9b (diff)
license: Add license info to all project files
All files were updated with license header. In case of binary files is license stored in LICENSE file stored in the same directory. Packages.txt was removed, because file has not been used.List of packages differs according OS distribution, all of neccesary packages are include in instalation scripts JIRA: VSPERF-489 Change-Id: I6ecae21b8db2a0f22fa5a66f9525352080f1fcc0 Signed-off-by: Martin Goldammer <martinx.goldammer@intel.com> Reviewed-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Christian Trautman <ctrautma@redhat.com> Reviewed-by: Bill Michalowski <bmichalo@redhat.com> Reviewed-by: Antonio Fischetti <antonio.fischetti@intel.com> Reviewed-by: Sridhar Rao <sridhar.rao@spirent.com>
Diffstat (limited to 'src/README.md')
-rw-r--r--src/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/src/README.md b/src/README.md
new file mode 100644
index 00000000..0aeea04f
--- /dev/null
+++ b/src/README.md
@@ -0,0 +1,34 @@
+<!---
+This work is licensed under a Creative Commons Attribution 4.0 International License.
+http://creativecommons.org/licenses/by/4.0
+-->
+
+### Purpose of this folder - Quickview
+
+1. contains place holders for upstream source code package.
+2. manages the package dependency
+3. provides simple one-button build for test developers
+
+### Motivation Explained
+
+There are multiple goals for the project vswitch performance characterization.
+First, it is a generic test framework that can be used to characterize any vswitch solution.
+Second, it is to be as CI tool to validate any change during development.
+
+For the first goal, it would be nice to get all the relevant upstream source package and
+to provide a easy build environment for a given test developer. Obviously we don't want to
+rewrite the makefile system from upstream project. However we need to add a wrapper to the
+individual packages to manage package dependecy. For example, to test ovs-dpdk vswitch solution,
+the build of ovs would depend on the build result of dpdk.
+This dependency is never explicitly specified in the individual package.
+
+For the second goal as a CI tool, it may not be needed to pull the upstream package.
+So this whole folder can be ignored.
+
+### Files and subfolders
+
+* package-list: contains list of packages and their associated tags
+* mk: contains top level makefiles
+* dpdk: place holder for dpdk package
+* ovs: place holder for ovs package.
+* l2fwd: simple l2 forwarding kernel module