public inbox for dev@dpdk.org
 help / color / mirror / Atom feed
From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [PATCH v2 12/12] doc: fix grammar and style in ABI versioning guide
Date: Fri, 16 Jan 2026 12:14:30 -0800	[thread overview]
Message-ID: <20260116201738.74578-13-stephen@networkplumber.org> (raw)
In-Reply-To: <20260116201738.74578-1-stephen@networkplumber.org>

Fix several issues in the ABI versioning documentation:

- Remove extra period after soname Wikipedia link
- Fix "it's" to "its" for possessive form
- Add missing "be" in "need to be carefully planned"
- Remove erroneous "is" in "it is may be required"
- Add missing "and" and "for" in ABI version support sentence
- Fix "Lets" to "Let's" contraction
- Remove stray semicolon in #include directive example
- Replace "comprised of" with "consists of"
- Fix missing period after "e.g" abbreviation
- Add missing apostrophe in "application's dependencies"
- Remove redundant "of the head" phrase
- Clarify "alias to experimental" wording

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/contributing/abi_versioning.rst | 32 +++++++++++-----------
 1 file changed, 16 insertions(+), 16 deletions(-)

diff --git a/doc/guides/contributing/abi_versioning.rst b/doc/guides/contributing/abi_versioning.rst
index 2fa2b15edc..086f3d6016 100644
--- a/doc/guides/contributing/abi_versioning.rst
+++ b/doc/guides/contributing/abi_versioning.rst
@@ -17,19 +17,19 @@ System libraries usually adopt the familiar major and minor version naming
 convention, where major versions (e.g. ``librte_eal 21.x, 22.x``) are presumed
 to be ABI incompatible with each other and minor versions (e.g. ``librte_eal
 21.1, 21.2``) are presumed to be ABI compatible. A library's `soname
-<https://en.wikipedia.org/wiki/Soname>`_. is typically used to provide backward
+<https://en.wikipedia.org/wiki/Soname>`_ is typically used to provide backward
 compatibility information about a given library, describing the lowest common
 denominator ABI supported by the library. The soname or logical name for the
-library, is typically comprised of the library's name and major version e.g.
+library typically consists of the library's name and major version e.g.
 ``librte_eal.so.21``.
 
 During an application's build process, a library's soname is noted as a runtime
 dependency of the application. This information is then used by the `dynamic
 linker <https://en.wikipedia.org/wiki/Dynamic_linker>`_ when resolving the
-applications dependencies at runtime, to load a library supporting the correct
+application's dependencies at runtime, to load a library supporting the correct
 ABI version. The library loaded at runtime therefore, may be a minor revision
 supporting the same major ABI version (e.g. ``librte_eal.21.2``), as the library
-used to link the application (e.g ``librte_eal.21.0``).
+used to link the application (e.g. ``librte_eal.21.0``).
 
 .. _major_abi_versions:
 
@@ -37,7 +37,7 @@ Major ABI versions
 ------------------
 
 An ABI version change to a given library, especially in core libraries such as
-``librte_mbuf``, may cause an implicit ripple effect on the ABI of it's
+``librte_mbuf``, may cause an implicit ripple effect on the ABI of its
 consuming libraries, causing ABI breakages. There may however be no explicit
 reason to bump a dependent library's ABI version, as there may have been no
 obvious change to the dependent library's API, even though the library's ABI
@@ -47,11 +47,11 @@ This interdependence of DPDK libraries, means that ABI versioning of libraries
 is more manageable at a project level, with all project libraries sharing a
 **single ABI version**. In addition, the need to maintain a stable ABI for some
 number of releases as described in the section :doc:`abi_policy`, means
-that ABI version increments need to carefully planned and managed at a project
+that ABI version increments need to be carefully planned and managed at a project
 level.
 
 Major ABI versions are therefore declared typically aligned with an LTS release
-and is then supported some number of subsequent releases, shared across all
+and are then supported for some number of subsequent releases, shared across all
 libraries. This means that a single project level ABI version, reflected in all
 individual library's soname, library filenames and associated version maps
 persists over multiple releases.
@@ -128,7 +128,7 @@ Versioning Macros
 When a symbol is exported from a library to provide an API, it also provides a
 calling convention (ABI) that is embodied in its name, return type and
 arguments. Occasionally that function may need to change to accommodate new
-functionality or behavior. When that occurs, it is may be required to allow for
+functionality or behavior. When that occurs, it may be required to allow for
 backward compatibility for a time with older binaries that are dynamically
 linked to the DPDK.
 
@@ -140,16 +140,16 @@ library so that older binaries need not be immediately recompiled.
 The macros are:
 
 * ``RTE_VERSION_SYMBOL(ver, type, name, args)``: Creates a symbol version table
-  entry binding symbol ``<name>@DPDK_<ver>`` to the internal function name
-  ``<name>_v<ver>``.
+  entry binding symbol ``<n>@DPDK_<ver>`` to the internal function name
+  ``<n>_v<ver>``.
 
 * ``RTE_DEFAULT_SYMBOL(ver, type, name, args)``: Creates a symbol version entry
-  instructing the linker to bind references to symbol ``<name>`` to the internal
-  symbol ``<name>_v<ver>``.
+  instructing the linker to bind references to symbol ``<n>`` to the internal
+  symbol ``<n>_v<ver>``.
 
 * ``RTE_VERSION_EXPERIMENTAL_SYMBOL(type, name, args)``:  Similar to RTE_VERSION_SYMBOL
   but for experimental API symbols. The macro is used when a symbol matures
-  to become part of the stable ABI, to provide an alias to experimental
+  to become part of the stable ABI, to provide an alias to the experimental version
   until the next major ABI version.
 
 .. _example_abi_macro_usage:
@@ -276,7 +276,7 @@ versioning, in the ``meson.build`` file we add the following
 
    use_function_versioning = true
 
-at the start of the head of the file. This will indicate to the tool-chain to
+at the start of the file. This will indicate to the tool-chain to
 enable the function version macros when building.
 
 
@@ -336,7 +336,7 @@ and ``DPDK_22`` version nodes.
 
 .. code-block:: c
 
-   #include <rte_compat.h>;
+   #include <rte_compat.h>
 
    /*
     * Create an acl context object for apps to
@@ -357,7 +357,7 @@ and ``DPDK_22`` version nodes.
 Deprecating part of a public API
 ________________________________
 
-Lets assume that you've done the above updates, and in preparation for the next
+Let's assume that you've done the above updates, and in preparation for the next
 major ABI version you decide you would like to retire the old version of the
 function. After having gone through the ABI deprecation announcement process,
 removal is easy.
-- 
2.51.0


      parent reply	other threads:[~2026-01-16 20:19 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-14 22:54 [PATCH 00/11] doc: improve contributing documentation clarity and style Stephen Hemminger
2026-01-14 22:54 ` [PATCH 01/11] doc: correct grammar and typos in design guide Stephen Hemminger
2026-01-14 22:54 ` [PATCH 02/11] doc: improve ABI policy documentation style Stephen Hemminger
2026-01-14 22:54 ` [PATCH 03/11] doc: improve coding style guide readability Stephen Hemminger
2026-01-14 22:54 ` [PATCH 04/11] doc: improve documentation guidelines style Stephen Hemminger
2026-01-14 22:54 ` [PATCH 05/11] doc: improve Linux uAPI header documentation Stephen Hemminger
2026-01-14 22:54 ` [PATCH 06/11] doc: improve new driver guide readability Stephen Hemminger
2026-01-14 22:54 ` [PATCH 07/11] doc: improve new library guide style Stephen Hemminger
2026-01-14 22:54 ` [PATCH 08/11] doc: improve patch submission guide readability Stephen Hemminger
2026-01-14 22:54 ` [PATCH 09/11] doc: improve stable releases documentation Stephen Hemminger
2026-01-14 22:54 ` [PATCH 10/11] doc: improve unit test guide readability Stephen Hemminger
2026-01-14 22:54 ` [PATCH 11/11] doc: improve vulnerability process documentation Stephen Hemminger
2026-01-16 20:14 ` [PATCH v2 00/12] doc: improve contributing documentation clarity and style Stephen Hemminger
2026-01-16 20:14   ` [PATCH v2 01/12] doc: correct grammar and typos in design guide Stephen Hemminger
2026-03-31 22:41     ` Stephen Hemminger
2026-01-16 20:14   ` [PATCH v2 02/12] doc: improve ABI policy documentation style Stephen Hemminger
2026-01-16 20:14   ` [PATCH v2 03/12] doc: improve coding style guide readability Stephen Hemminger
2026-01-16 20:14   ` [PATCH v2 04/12] doc: improve documentation guidelines style Stephen Hemminger
2026-01-16 20:14   ` [PATCH v2 05/12] doc: improve Linux uAPI header documentation Stephen Hemminger
2026-01-16 20:14   ` [PATCH v2 06/12] doc: improve new driver guide readability Stephen Hemminger
2026-01-16 20:14   ` [PATCH v2 07/12] doc: improve new library guide style Stephen Hemminger
2026-01-16 20:14   ` [PATCH v2 08/12] doc: improve patch submission guide readability Stephen Hemminger
2026-01-16 20:14   ` [PATCH v2 09/12] doc: improve stable releases documentation Stephen Hemminger
2026-01-16 20:14   ` [PATCH v2 10/12] doc: improve vulnerability process documentation Stephen Hemminger
2026-01-16 20:14   ` [PATCH v2 11/12] doc: improve unit test guide readability Stephen Hemminger
2026-01-16 20:14   ` Stephen Hemminger [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260116201738.74578-13-stephen@networkplumber.org \
    --to=stephen@networkplumber.org \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox