summaryrefslogtreecommitdiffstats
path: root/docs/to-be-reorganized/quickstart.rst
diff options
context:
space:
mode:
authorMartin Klozik <martinx.klozik@intel.com>2015-10-12 07:15:54 +0100
committerMaryam Tahhan <maryam.tahhan@intel.com>2015-10-21 14:02:11 +0000
commitc2971871dd1380b88d58f29211a3e8478aca477a (patch)
tree043893808caaa962f77757b4d495a7b4ec9b9b3b /docs/to-be-reorganized/quickstart.rst
parent3572d56f5733592db30f0df2273fe93e731cba2d (diff)
Add Pylint to VSPERF commit gate
Initial pylint config file has been created to follow current code structure and design. A few issues have been fixed, so currently 56 of 67 files have rating 10/10. There are still issues to be fixed, mainly TODOs/FIXMEs and missing impelentation of abstract class members. Change-Id: Icf5b12c2150258f8ac657f8d50b47a697d1660a0 JIRA: VSPERF-91 Signed-off-by: Martin Klozik <martinx.klozik@intel.com> Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com> Reviewed-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com> Reviewed-by: Gene Snider <eugene.snider@huawei.com> Reviewed-by: Al Morton <acmorton@att.com> Reviewed-by: Tv Rao <tv.rao@freescale.com> Reviewed-by: Brian Castelli <brian.castelli@spirent.com>
Diffstat (limited to 'docs/to-be-reorganized/quickstart.rst')
-rw-r--r--docs/to-be-reorganized/quickstart.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/to-be-reorganized/quickstart.rst b/docs/to-be-reorganized/quickstart.rst
index c575be59..bb009fce 100644
--- a/docs/to-be-reorganized/quickstart.rst
+++ b/docs/to-be-reorganized/quickstart.rst
@@ -243,6 +243,18 @@ To run tests using Vanilla OVS:
./vsperf --conf-file <path_to_settings_py>
+Code change verification by pylint
+----------------------------------
+Every developer participating in VSPERF project should run
+pylint before his python code is submitted for review. Project
+specific configuration for pylint is available at 'pylint.rc'.
+
+Example of manual pylint invocation:
+
+ .. code-block:: console
+
+ pylint --rcfile ./pylint.rc ./vsperf
+
GOTCHAs:
--------