]> git.proxmox.com Git - mirror_qemu.git/commit - qapi/migration.json
qapi: Reformat doc comments to conform to current conventions
authorMarkus Armbruster <armbru@redhat.com>
Fri, 28 Apr 2023 10:54:29 +0000 (12:54 +0200)
committerMarkus Armbruster <armbru@redhat.com>
Wed, 10 May 2023 08:01:01 +0000 (10:01 +0200)
commita937b6aa739f65f2cae2ad9a7eb65a309ad2a359
treec11a2c7b6fc5b850ef4dd6b613902759824779a5
parent059d341a67bb660a7957cb62a6a860c92c2fb64a
qapi: Reformat doc comments to conform to current conventions

Change

    # @name: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed
    #        do eiusmod tempor incididunt ut labore et dolore magna aliqua.

to

    # @name: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed
    #     do eiusmod tempor incididunt ut labore et dolore magna aliqua.

See recent commit "qapi: Relax doc string @name: description
indentation rules" for rationale.

Reflow paragraphs to 70 columns width, and consistently use two spaces
to separate sentences.

To check the generated documentation does not change, I compared the
generated HTML before and after this commit with "wdiff -3".  Finds no
differences.  Comparing with diff is not useful, as the reflown
paragraphs are visible there.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20230428105429.1687850-18-armbru@redhat.com>
Reviewed-by: Juan Quintela <quintela@redhat.com>
Acked-by: Lukas Straub <lukasstraub2@web.de>
[Straightforward conflicts in qapi/audio.json qapi/misc-target.json
qapi/run-state.json resolved]
39 files changed:
qapi/acpi.json
qapi/audio.json
qapi/authz.json
qapi/block-core.json
qapi/block-export.json
qapi/block.json
qapi/char.json
qapi/common.json
qapi/compat.json
qapi/control.json
qapi/crypto.json
qapi/cryptodev.json
qapi/cxl.json
qapi/dump.json
qapi/error.json
qapi/introspect.json
qapi/job.json
qapi/machine-target.json
qapi/machine.json
qapi/migration.json
qapi/misc-target.json
qapi/misc.json
qapi/net.json
qapi/pci.json
qapi/qapi-schema.json
qapi/qdev.json
qapi/qom.json
qapi/rdma.json
qapi/replay.json
qapi/rocker.json
qapi/run-state.json
qapi/sockets.json
qapi/stats.json
qapi/tpm.json
qapi/trace.json
qapi/transaction.json
qapi/ui.json
qapi/virtio.json
qapi/yank.json