Commit fb9b29e7 authored by wawryk's avatar wawryk Committed by Tomasz Zawadzki
Browse files

markdownlint: enable rule MD007 



MD007 - Unordered list indentation
Fixed all errors

Signed-off-by: default avatarwawryk <maciejx.wawryk@intel.com>
Change-Id: I051556bbd6bdaa94cec21bb072316bc693aea2ec
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/8998


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
parent e96beb93

doc/usdt.md

+10 −14
Original line number Diff line number Diff line
@@ -177,13 +177,11 @@ print the final results of the maps. 
  itself as a probe parameter and let the script decide which fields it wants to access

  (Note: these would need to be kept up-to-date with the C definitions of the struct - it is

  not possible to include the header files in a bpftrace script)



- investigate using pahole to generate data structure definitions that can be included in

  bpftrace scripts; this would allow us to pass the subsystem pointer itself as a probe

  argument, and let the script decide which fields it wants to access; for example,

  `pahole -E -C spdk_nvmf_subsystem build/bin/spdk_tgt` gets us close to what we need,

  but there are some limiters:



  - our structures have char arrays (not char pointers) for things like subnqn; large

    arrays like these cannot currently be passed to bpftrace printf without generating

    a stack space error (probe points are limited to 512 bytes of stack); we could
@@ -194,11 +192,9 @@ print the final results of the maps. 
    descriptions); information on enums can be found in the applications .debug_info

    section, but we would need something that can convert that into a file we can

    include in a bpftrace script



- Note that bpftrace prints are not always printed in exact chronological order; this can

  be seen especially with spdk_for_each_channel iterations, where we execute trace points

  on multiple threads in a very short period of time, and those may not get printed to the

  console in exact order; this is why the nvmf.bt script prints out a msec.nsec timestamp

  so that the user can understand the ordering and even pipe through sort if desired



- flesh out more DTrace probes in the nvmf code

mdl_rules.rb

+0 −1
Original line number Diff line number Diff line 
all

exclude_rule 'MD003'

exclude_rule 'MD004'

exclude_rule 'MD007'

exclude_rule 'MD009'

exclude_rule 'MD010'

exclude_rule 'MD011'