@@ -58,7 +58,6 @@ DOC_SOURCE = \
Documentation/internals/contributing/backporting-patches.rst \
Documentation/internals/contributing/coding-style.rst \
Documentation/internals/contributing/documentation-style.rst \
- Documentation/internals/contributing/libopenvswitch-abi.rst \
Documentation/internals/contributing/submitting-patches.rst \
Documentation/requirements.txt \
$(addprefix Documentation/ref/,$(RST_MANPAGES) $(RST_MANPAGES_NOINST))
@@ -33,8 +33,8 @@ How the Documentation is Organised
The Open Virtual Network (OVN) documentation is organised into multiple sections:
- :doc:`Installation guides </intro/install/index>` guide you through
- installing Open vSwitch (OVS) and Open Virtual Network (OVN) on a variety of
- different platforms
+ installing Open Open Virtual Network (OVN) on a variety of different
+ platforms
- :doc:`Tutorials </tutorials/index>` take you through a series of steps to
configure OVS and OVN in sandboxed environments
- :doc:`Topic guides </topics/index>` provide a high level overview of OVS and
@@ -647,9 +647,3 @@ Python
When introducing new Python code, try to follow Python's `PEP 8
<https://www.python.org/dev/peps/pep-0008/>`__ style. Consider running the
``pep8`` or ``flake8`` tool against your code to find issues.
-
-Libraries
----------
-
-When introducing a new library, follow
-:doc:`Open vSwitch Library ABI guide <libopenvswitch-abi>`
@@ -34,4 +34,3 @@ The below guides provide information on contributing to OVN itself.
backporting-patches
coding-style
documentation-style
- libopenvswitch-abi
deleted file mode 100644
@@ -1,119 +0,0 @@
-..
- Copyright (c) 2017 Red Hat, Inc.
-
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in OVN documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-===================================
-Open vSwitch Library ABI Updates
-===================================
-
-This file describes the manner in which the Open vSwitch shared library
-manages different ABI and API revisions. This document aims to describe
-the background, goals, and concrete mechanisms used to export code-space
-functionality so that it may be shared between multiple applications.
-
-.. _definitions:
-
-Definitions
------------
-
-.. csv-table:: Definitions for terms appearing in this document
- :header: "Term", "Definition"
-
- "ABI", "Abbreviation of Application Binary Interface"
- "API", "Abbreviation of Application Programming Interface"
- "Application Binary Interface", "The low-level runtime interface exposed
- by an object file."
- "Application Programming Interface", "The source-code interface descriptions
- intended for use in multiple translation units when compiling."
- "Code library", "A collection of function implementations and definitions
- intended to be exported and called through a well-defined interface."
- "Shared Library", "A code library which is imported at run time."
-
-.. _overview:
-
-Overview
-----------
-
-C and C++ applications often use 'external' functionality, such as printing
-specialized data types or parsing messages, which has been exported for common
-use. There are many possible ways for applications to call such external
-functionality, for instance by including an appropriate inline definition which
-the compiler can emit as code in each function it appears. One such way of
-exporting and importing such functionality is through the use of a library
-of code.
-
-When a compiler builds object code from source files to produce object code,
-the results are binary data arranged with specific calling conventions,
-alignments, and order suitable for a run-time environment or linker. This
-result defines a specific ABI.
-
-As library of code develops and its exported interfaces change over time, the
-resulting ABI may change as well. Therefore, care must be taken to ensure the
-changes made to libraries of code are effectively communicated to applications
-which use them. This includes informing the applications when incompatible
-changes are made.
-
-The Open vSwitch project exports much of its functionality through multiple
-such libraries of code. These libraries are intended for multiple applications
-to import and use. As the Open vSwitch project continues to evolve and change,
-its exported code will evolve as well. To ensure that applications linking to
-these libraries are aware of these changes, Open vSwitch employs libtool
-version stamps.
-
-.. _policies:
-
-ABI Policy
-----------
-
-Open vSwitch will export the ABI version at the time of release, such that the
-library name will be the major.minor version, and the rest of the release
-version information will be conveyed with a libtool interface version.
-
-The intent is for Open vSwitch to maintain an ABI stability for each minor
-revision only (so that Open vSwitch release 2.5 carries a guarantee for all
-2.5.ZZ micro-releases). This means that any porting effort to stable branches
-must take not to disrupt the existing ABI.
-
-In the event that a bug must be fixed in a backwards-incompatible way,
-developers must bump the libtool 'current' version to inform the linker of the
-ABI breakage. This will signal that libraries exposed by the subsequent release
-will not maintain ABI stability with the previous version.
-
-Coding
--------
-
-At build time, if building shared libraries by passing the `--enable-shared`
-arguments to `./configure`, version information is extracted from
-the ``$PACKAGE_VERSION`` automake variable and formatted into the appropriate
-arguments. These get exported for use in Makefiles as ``$OVS_LTINFO``, and
-passed to each exported library along with other ``LDFLAGS``.
-
-Therefore, when adding a new library to the build system, these version flags
-should be included with the ``$LDFLAGS`` variable. Nothing else needs to be
-done.
-
-Changing an exported function definition (from a file in, for instance
-`lib/*.h`) is only permitted from minor release to minor release. Likewise
-changes to library data structures should only occur from minor release to
-minor release.
@@ -27,12 +27,11 @@
Patchwork
=========
-Open vSwitch and OVN use `Patchwork`__ to track the status of patches
-sent to the :doc:`ovs-dev mailing list <mailing-lists>`. Our Patchwork
-instance can be found on `ozlabs.org`__.
+OVN uses `Patchwork`__ to track the status of patches sent to the
+:doc:`ovs-dev mailing list <mailing-lists>`. Our Patchwork instance can be
+found on `ozlabs.org`__.
-Patchwork provides a number of useful features for developers working on
-Open vSwitch and OVN:
+Patchwork provides a number of useful features for developers working on OVN:
- Tracking the lifecycle of patches (accepted, rejected, under-review, ...)
- Assigning reviewers (delegates) to patches
@@ -82,7 +82,7 @@ report test failures as bugs and include the ``testsuite.log`` in your report.
.. note::
Sometimes a few tests may fail on some runs but not others. This is usually a
- bug in the testsuite, not a bug in Open vSwitch itself. If you find that a
+ bug in the testsuite, not a bug in OVN itself. If you find that a
test fails intermittently, please report it, since the developers may not
have noticed. You can make the testsuite automatically rerun tests that fail,
by adding ``RECHECK=yes`` to the ``make`` command line, e.g.::
A few still remain and need to be addressed in the future. Signed-off-by: Dumitru Ceara <dceara@redhat.com> --- Documentation/automake.mk | 1 - Documentation/index.rst | 4 +- .../internals/contributing/coding-style.rst | 6 - .../internals/contributing/index.rst | 1 - .../contributing/libopenvswitch-abi.rst | 119 ------------------ Documentation/internals/patchwork.rst | 9 +- Documentation/topics/testing.rst | 2 +- 7 files changed, 7 insertions(+), 135 deletions(-) delete mode 100644 Documentation/internals/contributing/libopenvswitch-abi.rst