From fb9b29e7327ba43b2f8f5b140b51c48d1a6329d2 Mon Sep 17 00:00:00 2001 From: wawryk Date: Fri, 30 Jul 2021 12:13:05 +0200 Subject: [PATCH] markdownlint: enable rule MD007 MD007 - Unordered list indentation Fixed all errors Signed-off-by: wawryk Change-Id: I051556bbd6bdaa94cec21bb072316bc693aea2ec Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/8998 Tested-by: SPDK CI Jenkins Reviewed-by: Ben Walker Reviewed-by: Jim Harris Community-CI: Broadcom CI --- doc/usdt.md | 24 ++++++++++-------------- mdl_rules.rb | 1 - 2 files changed, 10 insertions(+), 15 deletions(-) diff --git a/doc/usdt.md b/doc/usdt.md index 08c258076..ee5cdf21a 100644 --- a/doc/usdt.md +++ b/doc/usdt.md @@ -177,28 +177,24 @@ 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 - modify SPDK to have the char array for storage, and a char pointer that points to - that storage, the latter could easily then be used in bpftrace scripts - - our structures include fields with their enum types instead of int; bpftrace will - complain it does not know about the enum (pahole doesn't print out enum - 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 - + - 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 + modify SPDK to have the char array for storage, and a char pointer that points to + that storage, the latter could easily then be used in bpftrace scripts + - our structures include fields with their enum types instead of int; bpftrace will + complain it does not know about the enum (pahole doesn't print out enum + 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 diff --git a/mdl_rules.rb b/mdl_rules.rb index 8c9790bd6..e84a69429 100644 --- a/mdl_rules.rb +++ b/mdl_rules.rb @@ -1,7 +1,6 @@ all exclude_rule 'MD003' exclude_rule 'MD004' -exclude_rule 'MD007' exclude_rule 'MD009' exclude_rule 'MD010' exclude_rule 'MD011'