[dpdk-dev] [PATCH v3] doc: add more detail to telemetry guides

Power, Ciara ciara.power at intel.com
Fri Jul 24 13:45:10 CEST 2020


>-----Original Message-----
>From: Power, Ciara <ciara.power at intel.com>
>Sent: Friday 24 July 2020 12:21
>To: Laatz, Kevin <kevin.laatz at intel.com>
>Cc: dev at dpdk.org; Richardson, Bruce <bruce.richardson at intel.com>;
>thomas at monjalon.net; Power, Ciara <ciara.power at intel.com>
>Subject: [PATCH v3] doc: add more detail to telemetry guides
>
>This patch adds examples to the Telemetry HowTo guide, to demonstrate
>commands that use parameters. The programmer's guide is also modified to
>include details on writing a callback function for a new command.
>
>Signed-off-by: Ciara Power <ciara.power at intel.com>
>
>---
>v3:
>  - Replaced direct code examples with generic examples.
>  - Replaced ref label with :doc: syntax to link guides.
>  - Replaced console code-block label with :: on previous lines.
>  - Added links to API doc.
>  - Modified some formatting.
>v2:
>  - Replaced examples of using commands in the programmer's guide with
>    a link to the HowTo guide.
>  - Added an example showing the use of a single string value.
>  - Replaced inline functions with a synthetic example function below
>    the list of parameters.
>---
> doc/guides/howto/telemetry.rst          |  67 ++++++----
> doc/guides/prog_guide/telemetry_lib.rst | 160 +++++++++++++++++++-----
> 2 files changed, 172 insertions(+), 55 deletions(-)
>
>diff --git a/doc/guides/howto/telemetry.rst
>b/doc/guides/howto/telemetry.rst index b4a34ed674..e7b5434152 100644
>--- a/doc/guides/howto/telemetry.rst
>+++ b/doc/guides/howto/telemetry.rst
>@@ -29,17 +29,13 @@ Telemetry Initialization
>

<snip>

I forgot to preserve the Ack from v2.

Acked-by: Bruce Richardson <bruce.richardson at intel.com>


More information about the dev mailing list