From 6c7e079d04cfbf12a7959f98445f18c57585a97e Mon Sep 17 00:00:00 2001 From: Krzysztof Karas Date: Tue, 31 Aug 2021 10:32:08 +0000 Subject: [PATCH] doc/nvmf_tracing.md: add link to nvmf target configuration page NVMe over Fabrics target page mentions nvmf traces, but nvmf traces page does not link the nvmf target guide - the need to configure target using our guide is obvious, if user follows the guide and then enters the traces page. However, if user lands on traces page first, the need to configure target first is not clearly communicated. Change-Id: If4aef1a8d061acb436ca77c3308e8dda0ab340cf Signed-off-by: Krzysztof Karas Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9345 Tested-by: SPDK CI Jenkins Reviewed-by: Tomasz Zawadzki Reviewed-by: Jim Harris --- doc/nvmf_tracing.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/nvmf_tracing.md b/doc/nvmf_tracing.md index da19ad7ac..e9caa13a9 100644 --- a/doc/nvmf_tracing.md +++ b/doc/nvmf_tracing.md @@ -6,8 +6,10 @@ SPDK has a tracing framework for capturing low-level event information at runtim Tracepoints provide a high-performance tracing mechanism that is accessible at runtime. They are implemented as a circular buffer in shared memory that is accessible from other processes. The NVMe-oF target is instrumented with tracepoints to enable analysis of -both performance and application crashes. (Note: the SPDK tracing framework should still -be considered experimental. Work to formalize and document the framework is in progress.) +both performance and application crashes and it has to be configured beforehand using +this [guide](https://spdk.io/doc/nvmf.html). +(Note: the SPDK tracing framework should still be considered experimental. +Work to formalize and document the framework is in progress.) ## Enabling Tracepoints {#enable_tracepoints}