Commit 6c7e079d authored by Krzysztof Karas's avatar Krzysztof Karas Committed by Tomasz Zawadzki
Browse files

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: default avatarKrzysztof Karas <krzysztof.karas@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9345


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent caa1f84e

doc/nvmf_tracing.md

+4 −2
Original line number Diff line number Diff line
@@ -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}