This patch splits the intro/details section for structs which are used in an inlinable context; i.e. structs used either as arguments for a command/event, or used as a branch of a union. The QAPI documentation block for these entities will have their "intro" section removed when inlined into other contexts, but may still display the intro section on generated documentation *IF* these structs are also used as an argument or return type.
Review notes: Same ol' Same ol'. Signed-off-by: John Snow <[email protected]> --- qapi/block-export.json | 5 ++--- qapi/crypto.json | 3 +-- qapi/machine.json | 3 +-- qapi/qom.json | 9 +++------ 4 files changed, 7 insertions(+), 13 deletions(-) diff --git a/qapi/block-export.json b/qapi/block-export.json index 77459f6321b..e3cee2fb5ce 100644 --- a/qapi/block-export.json +++ b/qapi/block-export.json @@ -154,9 +154,8 @@ ## # @BlockExportOptionsFuse: -# -# Options for exporting a block graph node on some (file) mountpoint -# as a raw image. +# Options for exporting a block graph node on some (file) +# mountpoint as a raw image. # # Multi-threading note: The FUSE export supports multi-threading. # Currently, requests are distributed across these threads in a diff --git a/qapi/crypto.json b/qapi/crypto.json index f85d1cebed3..5ae07d650a6 100644 --- a/qapi/crypto.json +++ b/qapi/crypto.json @@ -429,8 +429,7 @@ ## # @SecretProperties: -# -# Properties for secret objects. +# Properties for secret objects. # # Either @data or @file must be provided, but not both. # diff --git a/qapi/machine.json b/qapi/machine.json index 05a2851c0fc..b1064b53ae3 100644 --- a/qapi/machine.json +++ b/qapi/machine.json @@ -899,8 +899,7 @@ ## # @CpuInstanceProperties: -# -# Properties identifying a CPU. +# Properties identifying a CPU. # # Which members are optional and which mandatory depends on the # architecture and board. diff --git a/qapi/qom.json b/qapi/qom.json index 3de06488768..d80dd5976ed 100644 --- a/qapi/qom.json +++ b/qapi/qom.json @@ -456,8 +456,7 @@ ## # @FilterRedirectorProperties: -# -# Properties for filter-redirector objects. +# Properties for filter-redirector objects. # # At least one of @indev or @outdev must be present. If both are # present, they must not refer to the same character device backend. @@ -756,8 +755,7 @@ ## # @MemoryBackendShmProperties: -# -# Properties for memory-backend-shm objects. +# Properties for memory-backend-shm objects. # # This memory backend supports only shared memory, which is the # default. @@ -771,8 +769,7 @@ ## # @MemoryBackendEpcProperties: -# -# Properties for memory-backend-epc objects. +# Properties for memory-backend-epc objects. # # The @merge boolean option is false by default with epc # -- 2.55.0
