mbox series

[v4,0/2] Improve docs on getting info on running process

Message ID 20230720110540.231342-1-bruce.richardson@intel.com (mailing list archive)
Headers
Series Improve docs on getting info on running process |

Message

Bruce Richardson July 20, 2023, 11:05 a.m. UTC 
  Add details to our documentation on how to register logging for a
component. Also provide guidelines on when to use logs vs tracing
vs telemetry.

V4: Added note to patch 1 saying not to use the old static logging method

V3: Moved new doc section on runtime info, and other minor changes flagged
    by David on review.

V2: extended second patch based on the feedback provided.

Bruce Richardson (2):
  doc/contributing: provide coding details for dynamic logging
  doc/contributing: guidelines for logging, tracing and telemetry

 doc/guides/contributing/coding_style.rst | 24 ++++++++++++
 doc/guides/contributing/design.rst       | 49 ++++++++++++++++++++++++
 doc/guides/prog_guide/telemetry_lib.rst  |  2 +
 doc/guides/prog_guide/trace_lib.rst      |  2 +
 lib/cfgfile/rte_cfgfile.c                |  2 +
 5 files changed, 79 insertions(+)

--
2.39.2

Comments

Ferruh Yigit July 20, 2023, 12:38 p.m. UTC | #1 
On 7/20/2023 12:05 PM, Bruce Richardson wrote:
> Add details to our documentation on how to register logging for a
> component. Also provide guidelines on when to use logs vs tracing
> vs telemetry.
> 
> V4: Added note to patch 1 saying not to use the old static logging method
> 
> V3: Moved new doc section on runtime info, and other minor changes flagged
>     by David on review.
> 
> V2: extended second patch based on the feedback provided.
> 
> Bruce Richardson (2):
>   doc/contributing: provide coding details for dynamic logging
>   doc/contributing: guidelines for logging, tracing and telemetry
> 

For series,
Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>