doc: fix typos 'depreciated' instead of 'deprecated'
Checks
Commit Message
From 1871ee6f7b98ef89b7c4893d90b5ea264660c201 Mon Sep 17 00:00:00 2001
From: youcai <omegacoleman@gmail.com>
Date: Tue, 19 Apr 2022 14:38:36 +0800
Subject: [PATCH] doc: fix typos 'depreciated' instead of 'deprecated'
Cc: Ray Kinsella <mdr@ashroe.eu>
Same issue was fixed in ABI policy in ec5c0f8, but more of this
misuse persist in comments and docs. 'depreciated' means diminish
in value over a period of time. It should not appear here.
Signed-off-by: youcai <omegacoleman@gmail.com>
---
doc/guides/contributing/abi_policy.rst | 2 +-
doc/guides/contributing/abi_versioning.rst | 2 +-
lib/kni/rte_kni.h | 4 ++--
3 files changed, 4 insertions(+), 4 deletions(-)
Comments
Stephen Coleman <omegacoleman@gmail.com> writes:
> From 1871ee6f7b98ef89b7c4893d90b5ea264660c201 Mon Sep 17 00:00:00 2001
> From: youcai <omegacoleman@gmail.com>
> Date: Tue, 19 Apr 2022 14:38:36 +0800
> Subject: [PATCH] doc: fix typos 'depreciated' instead of 'deprecated'
> Cc: Ray Kinsella <mdr@ashroe.eu>
>
> Same issue was fixed in ABI policy in ec5c0f8, but more of this
> misuse persist in comments and docs. 'depreciated' means diminish
> in value over a period of time. It should not appear here.
>
> Signed-off-by: youcai <omegacoleman@gmail.com>
> ---
> doc/guides/contributing/abi_policy.rst | 2 +-
> doc/guides/contributing/abi_versioning.rst | 2 +-
> lib/kni/rte_kni.h | 4 ++--
> 3 files changed, 4 insertions(+), 4 deletions(-)
>
Acked-by: Ray Kinsella <mdr@ashroe.eu>
19/04/2022 17:44, Ray Kinsella:
>
> Stephen Coleman <omegacoleman@gmail.com> writes:
>
> > From 1871ee6f7b98ef89b7c4893d90b5ea264660c201 Mon Sep 17 00:00:00 2001
> > From: youcai <omegacoleman@gmail.com>
> > Date: Tue, 19 Apr 2022 14:38:36 +0800
> > Subject: [PATCH] doc: fix typos 'depreciated' instead of 'deprecated'
> > Cc: Ray Kinsella <mdr@ashroe.eu>
> >
> > Same issue was fixed in ABI policy in ec5c0f8, but more of this
> > misuse persist in comments and docs. 'depreciated' means diminish
> > in value over a period of time. It should not appear here.
> >
> > Signed-off-by: youcai <omegacoleman@gmail.com>
> > ---
> > doc/guides/contributing/abi_policy.rst | 2 +-
> > doc/guides/contributing/abi_versioning.rst | 2 +-
> > lib/kni/rte_kni.h | 4 ++--
> > 3 files changed, 4 insertions(+), 4 deletions(-)
> >
> Acked-by: Ray Kinsella <mdr@ashroe.eu>
Applied, sorry for the delay, the patch was corrupted.
b/doc/guides/contributing/abi_policy.rst
@@ -167,7 +167,7 @@ The requirements for changing the ABI are:
API becomes non-experimental, then the old one is marked with
``__rte_deprecated``.
- - The depreciated API should follow the notification process to be removed,
+ - The deprecated API should follow the notification process to be removed,
see :ref:`deprecation_notices`.
- At the declaration of the next major ABI version, those ABI changes then
b/doc/guides/contributing/abi_versioning.rst
@@ -94,7 +94,7 @@ that library.
...
However when a new ABI version is declared, for example DPDK ``22``, old
-depreciated functions may be safely removed at this point and the entire old
+deprecated functions may be safely removed at this point and the entire old
major ABI version removed, see the section :ref:`deprecating_entire_abi` on
how this may be done.
@@ -64,8 +64,8 @@ struct rte_kni_conf {
uint32_t core_id; /* Core ID to bind kernel thread on */
uint16_t group_id; /* Group ID */
unsigned mbuf_size; /* mbuf size */
- struct rte_pci_addr addr; /* depreciated */
- struct rte_pci_id id; /* depreciated */
+ struct rte_pci_addr addr; /* deprecated */
+ struct rte_pci_id id; /* deprecated */
__extension__
uint8_t force_bind : 1; /* Flag to bind kernel thread */