Commit 2f2acf4e authored by Jim Harris's avatar Jim Harris Committed by Jim Harris
Browse files

doc: move nvmf_tracing.md to tracing.md 



This does not need to nvmf specific, tracing is a general concept
that applies to SPDK as a whole. It is still fine to continue using
the nvmf target as the primary example though.

Signed-off-by: default avatarJim Harris <jim.harris@samsung.com>
Change-Id: I72bb92b7a08822366ab1d3db4c6baff26eab389e
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/24123


Reviewed-by: default avatarShuhei Matsumoto <smatsumoto@nvidia.com>
Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarAleksey Marchuk <alexeymar@nvidia.com>
Reviewed-by: default avatarGangCao <gang.cao@intel.com>
Community-CI: Community CI Samsung <spdk.community.ci.samsung@gmail.com>
parent 5592070b

doc/Doxyfile

+1 −1
Original line number Diff line number Diff line
@@ -835,7 +835,6 @@ INPUT += \ 
                         nvme_spec.md \

                         nvmf.md \

                         nvmf_tgt_pg.md \

                         nvmf_tracing.md \

                         nvmf_multipath_howto.md \

                         overview.md \

                         peer_2_peer.md \
@@ -849,6 +848,7 @@ INPUT += \ 
                         spdk_top.md \

                         ssd_internals.md \

                         system_configuration.md \

                         tracing.md \

                         ublk.md \

                         usdt.md \

                         userspace.md \

doc/jsonrpc.md

+2 −2
Original line number Diff line number Diff line
@@ -1157,7 +1157,7 @@ Enable tracepoint mask on a specific tpoint group. For example "bdev" for bdev t 
and 0x1 to enable the first tracepoint inside the group (BDEV_IO_START). This command will not

disable already active tracepoints or those not specified in the mask. For a full description

of all available trace groups, see

[tracepoint documentation](https://spdk.io/doc/nvmf_tgt_tracepoints.html).

[tracepoint documentation](https://spdk.io/doc/tracepoints.html).



#### Parameters
@@ -1197,7 +1197,7 @@ Example response: 
Disable tracepoint mask on a specific tpoint group. For example "bdev" for bdev trace group,

and 0x1 to disable the first tracepoint inside the group (BDEV_IO_START). For a full description

of all available trace groups, see

[tracepoint documentation](https://spdk.io/doc/nvmf_tgt_tracepoints.html).

[tracepoint documentation](https://spdk.io/doc/tracepoints.html).



#### Parameters

doc/nvmf.md

+2 −2
Original line number Diff line number Diff line 
# NVMe over Fabrics Target {#nvmf}



@sa @ref nvme_fabrics_host

@sa @ref nvmf_tgt_tracepoints

@sa @ref tracepoints



## NVMe-oF Target Getting Started Guide {#nvmf_getting_started}
@@ -267,7 +267,7 @@ nvme disconnect -n "nqn.2016-06.io.spdk:cnode1" 
## Enabling NVMe-oF target tracepoints for offline analysis and debug {#nvmf_trace}



SPDK has a tracing framework for capturing low-level event information at runtime.

@ref nvmf_tgt_tracepoints enable analysis of both performance and application crashes.

@ref tracepoints enable analysis of both performance and application crashes.



## Enabling NVMe-oF Multipath

doc/nvmf_tracing.md→doc/tracing.md

+1 −1
Original line number Diff line number Diff line 
# NVMe-oF Target Tracepoints {#nvmf_tgt_tracepoints}

# Tracing Framework {#tracepoints}



## Introduction {#tracepoints_intro}