summaryrefslogtreecommitdiff
path: root/INSTALL.md
Commit message (Collapse)AuthorAgeFilesLines
* doc: Convert INSTALL to rSTStephen Finucane2016-10-181-823/+0
| | | | | Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
* INSTALL.md: Add details about kernel module preference.Gurucharan Shetty2016-09-291-1/+22
| | | | | Signed-off-by: Gurucharan Shetty <guru@ovn.org> Acked-by: Darrell Ball <dlu998@gmail.com>
* travis: Fix flake8 failures from flake8 3.0.Russell Bryant2016-07-291-5/+7
| | | | | | | | | The "hacking" plugin for flake8 is not currently compatible with flake8 3.0. Ensure that we install flake8 2.x on travis-ci. Also update the docs to indicate this incompatibility. Signed-off-by: Russell Bryant <russell@ovn.org> Acked-by: Andy Zhou <azhou@ovn.org>
* INSTALL.md: Update configure section for built-in intrinsics.Bhanuprakash Bodireddy2016-07-271-0/+15
| | | | | | | | Built-in CRC32 intrinsics can be used for efficient hash computation on processors with SSE4.2 support. Signed-off-by: Bhanuprakash Bodireddy <bhanuprakash.bodireddy@intel.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* INSTALL.md: Update missing hyperlink for Windows install guide.Bhanuprakash Bodireddy2016-07-271-0/+1
| | | | | Signed-off-by: Bhanuprakash Bodireddy <bhanuprakash.bodireddy@intel.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* Makefile.am: Add clang static analysis supportBhanuprakash Bodireddy2016-07-261-0/+22
| | | | | | | | | | | | | | | | Clang Static Analyzer is a source code analysis tool to find bugs. This patch adds make target to trigger static analysis using below commands. ./boot.sh For Clang: ./configure CC=clang --with-dpdk For GCC: ./configure CC=gcc --with-dpdk CFLAGS="-std=gnu99" make clang-analyze Run 'scan-view <results dir>' command to examine the bug report. Signed-off-by: Bhanuprakash Bodireddy <bhanuprakash.bodireddy@intel.com> Acked-By: Lance Richardson <lrichard@redhat.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* INSTALL.md: Note use of "hacking" flake8 plugin.Russell Bryant2016-06-071-1/+5
| | | | | | | | | | The automatic flake8 check that runs against Python code has some warnings enabled that come from the "hacking" flake8 plugin. If it's not installed, the warnings just won't occur until it's run on a system with "hacking" installed. Signed-off-by: Russell Bryant <russell@ovn.org> Acked-by: Ben Pfaff <blp@ovn.org>
* INSTALL.md: Document system-traffic tests.Joe Stringer2016-06-031-12/+76
| | | | | Signed-off-by: Joe Stringer <joe@ovn.org> Acked-by: Ben Pfaff <blp@ovn.org>
* vagrant: Update default box to Fedora-23.Joe Stringer2016-05-251-1/+1
| | | | | | | | This brings a newer kernel (4.2) and newer iproute2, allowing more of the tests to run by default. Signed-off-by: Joe Stringer <joe@ovn.org> Acked-by: Andy Zhou <azhou@ovn.org>
* INSTALL.md: Explain the effect of using different configure options.Gurucharan Shetty2016-03-301-5/+14
| | | | | | | | | | Over the years, I have seen multiple users inadvertantly end up with 2 copies of OVS executables in their filesystem. In all the cases, it was because of using different configure options while installing a new version of Open vSwitch. Signed-off-by: Gurucharan Shetty <guru@ovn.org> Acked-by: Ben Pfaff <blp@ovn.org>
* tests: enable basic lcov code coverage reporting supportLance Richardson2016-03-181-0/+6
| | | | | | | | Add "check-lcov" target to generate an HTML code coverage report for testsuite execution using lcov and genhtml. Signed-off-by: Lance Richardson <lrichard@redhat.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* INSTALL.md: Suggest jemalloc memory allocator.Rodriguez Betancourt, Esteban2016-03-161-0/+7
| | | | | | | | | | | Change installing documentation to suggest to use jemalloc memory allocator. This memory allocator showed great performance gains when used at ovsdb-server and other components. Signed-off-by: Esteban Rodriguez Betancourt <estebarb@hpe.com> Signed-off-by: Ben Pfaff <blp@ovn.org>
* datapath: Drop support for kernel older than 3.10Pravin B Shelar2016-03-141-41/+2
| | | | | | | | | | | | | | | | Currently OVS out of tree datapath supports a large number of kernel versions. From 2.6.32 to 4.3 and various distribution-specific kernels. But at this point major features are only available on more recent kernels. For example, stateful services are only available starting in kernel 3.10 and STT is available on starting with 3.5. Since these features are becoming essential to many OVS deployments, and the effort of maintaining the backports is high. We have decided to drop support for older kernel. Following patch drops supports for kernel older than 3.10. Signed-off-by: Pravin B Shelar <pshelar@ovn.org> Acked-by: Jesse Gross <jesse@kernel.org>
* tests: Add ability to automatically rerun failed tests.Ben Pfaff2016-02-241-1/+4
| | | | | | | | A lot of packaging was doing this already, so this simplifies their implementation. Signed-off-by: Ben Pfaff <blp@ovn.org> Acked-by: Andy Zhou <azhou@ovn.org>
* INSTALL.md: Fix shell command line formatting.Jarno Rajahalme2016-02-221-11/+13
| | | | | | | | Some shell command lines were quoted inconsistently from others. Signed-off-by: Jarno Rajahalme <jarno@ovn.org> Acked-by: Justin Pettit <jpettit@ovn.org> Signed-off-by: Ben Pfaff <blp@ovn.org>
* python: Fix xmlrpclib imports.Russell Bryant2016-01-201-1/+3
| | | | | | | | | | | | | | Fix imports of xmlrpclib to be compatible with Python 3. Python 2 had xmlrpclib (client) and SimpleXMLRPCServer (server). In Python 3, these have been renamed to xmlrpc.client and xmlrpc.server. The solution implemented here is to use the six library. It may seem excessive for this particular issue, but the six library provides helpers for Python 2 and 3 compatibility for many different issues. This is just the first of many uses of the six library. Signed-off-by: Russell Bryant <russell@ovn.org> Acked-by: Ben Pfaff <blp@ovn.org>
* python: Run flake8 at build time.Russell Bryant2016-01-051-0/+2
| | | | | | | | | | | | If flake8 is installed, run it at build time. Similar to most Makefile targets, run it once and then only run again if the files change. flake8 is set to ignore all error and warning types that currently occur. Future patches will remove items from the ignore list as they are resolved. Signed-off-by: Russell Bryant <russell@ovn.org> Acked-by: Ben Pfaff <blp@ovn.org>
* configure: add configuration options for libcap-ngAndy Zhou2015-09-301-0/+5
| | | | | | | | | | | | | | | | | | | Add configuration option for enabling or disabling linking with libcap-ng. Since capabilities are a security feature, the libcapng option is handled as follows: - no option: use libcapng if it's present --disable-libcapng: do not use libcapng --enable-libcapng: do use libcapng and fail configuration if it's missing On Linux, not linking with libcapng makes all OVS daemons fail when --user option is specified. Signed-off-by: Andy Zhou <azhou@nicira.com> Acked-by: Ben Pfaff <blp@nicira.com>
* Vagrantfile: Add test_ovs_system_userspace provision.Daniele Di Proietto2015-08-071-0/+7
| | | | | | | | | | | | | | Add 'test_ovs_system_userspace' provision. Command: # vagrant provision --provision-with=test_ovs_system_userspace will run "make check-system-userspace" in the vagrant launched VM. It may be more convenient to run this tests inside a vm rather than in the host, because they interact with system networking. Suggested-by: Joe Stringer <joestringer@nicira.com> Signed-off-by: Daniele Di Proietto <diproiettod@vmware.com> Acked-by: Joe Stringer <joestringer@nicira.com>
* Increase prerequisite from Python 2.4 to Python 2.7.Ben Pfaff2015-06-231-3/+1
| | | | | | | This means that users of XenServer 6.5 and earlier will need to install Python 2.7. Signed-off-by: Ben Pfaff <blp@nicira.com>
* testsuite: Don't apply the testsuite.patch on non-Windows platforms.Gurucharan Shetty2015-04-231-2/+0
| | | | | | | | | On CentOS machines which use autoconf version 2.63, the patch application would fail. Reported-by: Ian Stokes <ian.stokes@intel.com> Tested-by: Ian Stokes <ian.stokes@intel.com> Signed-off-by: Gurucharan Shetty <gshetty@nicira.com>
* INSTALL.md: Add note about EXTRA_CFLAGS.Russell Bryant2015-04-021-0/+6
| | | | | | | | | | | | | | Add a note about the use of EXTRA_CFLAGS to provide custom CFLAGS for the build of the Linux kernel module. This addition is technically in the "configuring the sources" section of the document. However, it's the spot where custom CFLAGS is discussed already, so that seemed like the best place to put it. Alternatively, it could go in the "Building the Sources" section instead. Signed-off-by: Russell Bryant <rbryant@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* INSTALL.md: Document how to add custom compiler flags.Ben Pfaff2015-04-021-0/+8
| | | | | | CC: Mark B Kavanagh <mark.b.kavanagh@intel.com> Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Russell Bryant <rbryant@redhat.com>
* INSTALL.md: Note that Clang and ccache aren't completely compatible.Ben Pfaff2015-03-171-0/+4
| | | | | | CC: Russell Bryant <rbryant@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Russell Bryant <rbryant@redhat.com>
* INSTALL.md: Add a few notes for Windows builds.Ben Pfaff2015-03-171-0/+4
| | | | | Signed-off-by: Ben Pfaff <blp@nicira.com> Acked-by: Gurucharan Shetty <gshetty@nicira.com>
* tests: Enable running parallel unit tests for Windows.Gurucharan Shetty2015-02-131-0/+2
| | | | | | | | | | | | | | | | | | testsuite uses mkfifo in its job dispatcher that manages parallel unit tests. MinGW does not have a mkfifo. This results in unit tests running serially on Windows. Right now it takes up to approximately 40 minutes to run all the unit tests on Windows. This commit provides a job dispatcher for MinGW that uses temporary files instead of mkfifo to manage parallel jobs. With this commit, on a Windows machine with 4 cores and with 8 parallel unit test sessions, it takes approximately 8 minutes to finish a unit test run. Signed-off-by: Gurucharan Shetty <gshetty@nicira.com> Acked-by: Eitan Eliahu <eliahue@vmware.com> Acked-by: Ben Pfaff <blp@nicira.com>
* vagrant: switch to use out of tree buildAndy Zhou2015-01-081-4/+17
| | | | | | | | | | | | | | | | Vagrant shared folder, at least on the default virtual box, does not support the creation of the socket files. If one were to build OVS under /vagrant, 'make check' would not work. Out of tree builds can be used to work around this issue. See Install.md for instructions. Since out of tree builds requires a clean source tree, Vagrantfile can not be a generated file. This commit removes Vagrantfile.in, commit Vagrantfile instead. Signed-off-by: Andy Zhou <azhou@nicira.com> Acked-by: Thomas Graf <tgraf@noironetworks.com>
* INSTALL.md: Split building steps to allow refsFlavio Leitner2015-01-071-60/+78
| | | | | | | | | | There are other parts of the document that needs to reference some building steps. Instead of copying and explaining again, this patch splits the building section in three sections that can be referenced. Signed-off-by: Flavio Leitner <fbl@redhat.com> Signed-off-by: Thomas Graf <tgraf@noironetworks.com>
* vagrant: Provide basic VagrantfileThomas Graf2015-01-051-0/+18
| | | | | | | | | | | | | | | This is a basic Vagrantfile which compiles and provisions the local OVS source tree in a Fedora 20 VM. The Vagrantfile.in can be extended to support additional distributions. To use this Vagrantfile: 1. Install Vagrant plus a compatible hypervisor 2. Run configure to translate Vagrantfile.in to Vagrantfile 3. Run `vagrant up` to create & provision the VM 4. Run `vagrant ssh` to log into the VM Signed-off-by: Thomas Graf <tgraf@noironetworks.com> Acked-by: Kyle Mestery <mestery@mestery.com>
* lib: Document --enable-shared configure switchThomas Graf2014-11-121-0/+5
| | | | | | Signed-off-by: Thomas Graf <tgraf@noironetworks.com> Acked-by: Flavio Leitner <fbl@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* doc: Add more cross references between docsThomas Graf2014-10-301-12/+22
| | | | | | | Suggested-by: Lori Jakab <lojakab@cisco.com> Signed-off-by: Thomas Graf <tgraf@noironetworks.com> Reviewed-by: Flavio Leitner <fbl@redhat.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
* doc: Convert docs to Markdown languageThomas Graf2014-10-281-0/+606
Converts the majority of docs over to use the Markdown language for pretty printing on GitHub. It's a rough first convertion without exploiting the full potential of Markdown at this point. Section titles and indentation are fixed as needed. Minimal docs interlinking is added. Signed-off-by: Thomas Graf <tgraf@noironetworks.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
View Lorry Controller Status