[v3,2/4] doc/howto: rename files to match new content name
Checks
Commit Message
Since the section in the "howto" has been renamed from "exceptional
path" to "exception path", we can rename the relevant files to match
this new name too.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
...ptional_path.svg => virtio_user_as_exception_path.svg} | 0
doc/guides/howto/index.rst | 2 +-
...ptional_path.rst => virtio_user_as_exception_path.rst} | 8 ++++----
3 files changed, 5 insertions(+), 5 deletions(-)
rename doc/guides/howto/img/{virtio_user_as_exceptional_path.svg => virtio_user_as_exception_path.svg} (100%)
rename doc/guides/howto/{virtio_user_as_exceptional_path.rst => virtio_user_as_exception_path.rst} (96%)
Comments
> -----Original Message-----
> From: Richardson, Bruce <bruce.richardson@intel.com>
> Sent: Friday, June 10, 2022 11:36 PM
> To: dev@dpdk.org
> Cc: Maxime Coquelin <maxime.coquelin@redhat.com>; Xia, Chenbo
> <chenbo.xia@intel.com>; Richardson, Bruce <bruce.richardson@intel.com>
> Subject: [PATCH v3 2/4] doc/howto: rename files to match new content name
>
> Since the section in the "howto" has been renamed from "exceptional
> path" to "exception path", we can rename the relevant files to match
> this new name too.
>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
> ...ptional_path.svg => virtio_user_as_exception_path.svg} | 0
> doc/guides/howto/index.rst | 2 +-
> ...ptional_path.rst => virtio_user_as_exception_path.rst} | 8 ++++----
> 3 files changed, 5 insertions(+), 5 deletions(-)
> rename doc/guides/howto/img/{virtio_user_as_exceptional_path.svg =>
> virtio_user_as_exception_path.svg} (100%)
> rename doc/guides/howto/{virtio_user_as_exceptional_path.rst =>
> virtio_user_as_exception_path.rst} (96%)
>
> diff --git a/doc/guides/howto/img/virtio_user_as_exceptional_path.svg
> b/doc/guides/howto/img/virtio_user_as_exception_path.svg
> similarity index 100%
> rename from doc/guides/howto/img/virtio_user_as_exceptional_path.svg
> rename to doc/guides/howto/img/virtio_user_as_exception_path.svg
> diff --git a/doc/guides/howto/index.rst b/doc/guides/howto/index.rst
> index c2a2c60ddb..bf6337d021 100644
> --- a/doc/guides/howto/index.rst
> +++ b/doc/guides/howto/index.rst
> @@ -15,7 +15,7 @@ HowTo Guides
> pvp_reference_benchmark
> vfd
> virtio_user_for_container_networking
> - virtio_user_as_exceptional_path
> + virtio_user_as_exception_path
> packet_capture_framework
> telemetry
> debug_troubleshoot
> diff --git a/doc/guides/howto/virtio_user_as_exceptional_path.rst
> b/doc/guides/howto/virtio_user_as_exception_path.rst
> similarity index 96%
> rename from doc/guides/howto/virtio_user_as_exceptional_path.rst
> rename to doc/guides/howto/virtio_user_as_exception_path.rst
> index 3d3d1b1219..a7f0d366fe 100644
> --- a/doc/guides/howto/virtio_user_as_exceptional_path.rst
> +++ b/doc/guides/howto/virtio_user_as_exception_path.rst
> @@ -1,7 +1,7 @@
> .. SPDX-License-Identifier: BSD-3-Clause
> Copyright(c) 2016 Intel Corporation.
>
> -.. _virtio_user_as_exceptional_path:
> +.. _virtio_user_as_exception_path:
>
> Virtio_user as Exception Path
> =============================
> @@ -39,11 +39,11 @@ This solution has a number of advantages over
> alternatives such as KNI:
> on the polling DPDK threads.
>
> The overview of an application using virtio-user as exception path is
> shown
> -in :numref:`figure_virtio_user_as_exceptional_path`.
> +in :numref:`figure_virtio_user_as_exception_path`.
>
> -.. _figure_virtio_user_as_exceptional_path:
> +.. _figure_virtio_user_as_exception_path:
>
> -.. figure:: img/virtio_user_as_exceptional_path.*
> +.. figure:: img/virtio_user_as_exception_path.*
>
> Overview of a DPDK app using virtio-user as exception path
>
> --
> 2.34.1
Acked-by: Chenbo Xia <chenbo.xia@intel.com>
On 6/10/22 17:35, Bruce Richardson wrote:
> Since the section in the "howto" has been renamed from "exceptional
> path" to "exception path", we can rename the relevant files to match
> this new name too.
>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
> ...ptional_path.svg => virtio_user_as_exception_path.svg} | 0
> doc/guides/howto/index.rst | 2 +-
> ...ptional_path.rst => virtio_user_as_exception_path.rst} | 8 ++++----
> 3 files changed, 5 insertions(+), 5 deletions(-)
> rename doc/guides/howto/img/{virtio_user_as_exceptional_path.svg => virtio_user_as_exception_path.svg} (100%)
> rename doc/guides/howto/{virtio_user_as_exceptional_path.rst => virtio_user_as_exception_path.rst} (96%)
>
Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>
Thanks,
Maxime
similarity index 100%
rename from doc/guides/howto/img/virtio_user_as_exceptional_path.svg
rename to doc/guides/howto/img/virtio_user_as_exception_path.svg
@@ -15,7 +15,7 @@ HowTo Guides
pvp_reference_benchmark
vfd
virtio_user_for_container_networking
- virtio_user_as_exceptional_path
+ virtio_user_as_exception_path
packet_capture_framework
telemetry
debug_troubleshoot
similarity index 96%
rename from doc/guides/howto/virtio_user_as_exceptional_path.rst
rename to doc/guides/howto/virtio_user_as_exception_path.rst
@@ -1,7 +1,7 @@
.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2016 Intel Corporation.
-.. _virtio_user_as_exceptional_path:
+.. _virtio_user_as_exception_path:
Virtio_user as Exception Path
=============================
@@ -39,11 +39,11 @@ This solution has a number of advantages over alternatives such as KNI:
on the polling DPDK threads.
The overview of an application using virtio-user as exception path is shown
-in :numref:`figure_virtio_user_as_exceptional_path`.
+in :numref:`figure_virtio_user_as_exception_path`.
-.. _figure_virtio_user_as_exceptional_path:
+.. _figure_virtio_user_as_exception_path:
-.. figure:: img/virtio_user_as_exceptional_path.*
+.. figure:: img/virtio_user_as_exception_path.*
Overview of a DPDK app using virtio-user as exception path