[PR #6681/45eb1e39 backport][stable-7] Use semantic markup (modules o-p) (#6705)

Use semantic markup (modules o-p) (#6681)

* Use semantic markup.

* Use real option, not alias.

* E() now works better.

(cherry picked from commit 45eb1e3915)

Co-authored-by: Felix Fontein <felix@fontein.de>

plugins/modules/proxmox_disk.py

@@ -25,17 +25,17 @@ options:
   name:
     description:
       - The unique name of the VM.
-      - You can specify either I(name) or I(vmid) or both of them.
+      - You can specify either O(name) or O(vmid) or both of them.
     type: str
   vmid:
     description:
       - The unique ID of the VM.
-      - You can specify either I(vmid) or I(name) or both of them.
+      - You can specify either O(vmid) or O(name) or both of them.
     type: int
   disk:
     description:
-      - The disk key (C(unused[n]), C(ide[n]), C(sata[n]), C(scsi[n]) or C(virtio[n])) you want to operate on.
-      - Disk buses (IDE, SATA and so on) have fixed ranges of C(n) that accepted by Proxmox API.
+      - The disk key (V(unused[n]), V(ide[n]), V(sata[n]), V(scsi[n]) or V(virtio[n])) you want to operate on.
+      - Disk buses (IDE, SATA and so on) have fixed ranges of V(n) that accepted by Proxmox API.
       - >
         For IDE: 0-3;
         for SCSI: 0-30;
@@ -48,79 +48,79 @@ options:
     description:
       - Indicates desired state of the disk.
       - >
-        I(state=present) can be used to create, replace disk or update options in existing disk. It will create missing
-        disk or update options in existing one by default. See the I(create) parameter description to control behavior
+        O(state=present) can be used to create, replace disk or update options in existing disk. It will create missing
+        disk or update options in existing one by default. See the O(create) parameter description to control behavior
         of this option.
-      - Some updates on options (like I(cache)) are not being applied instantly and require VM restart.
+      - Some updates on options (like O(cache)) are not being applied instantly and require VM restart.
       - >
-        Use I(state=detached) to detach existing disk from VM but do not remove it entirely.
-        When I(state=detached) and disk is C(unused[n]) it will be left in same state (not removed).
+        Use O(state=detached) to detach existing disk from VM but do not remove it entirely.
+        When O(state=detached) and disk is V(unused[n]) it will be left in same state (not removed).
       - >
-        I(state=moved) may be used to change backing storage for the disk in bounds of the same VM
+        O(state=moved) may be used to change backing storage for the disk in bounds of the same VM
         or to send the disk to another VM (using the same backing storage).
       - >
-        I(state=resized) intended to change the disk size. As of Proxmox 7.2 you can only increase the disk size
+        O(state=resized) intended to change the disk size. As of Proxmox 7.2 you can only increase the disk size
         because shrinking disks is not supported by the PVE API and has to be done manually.
-      - To entirely remove the disk from backing storage use I(state=absent).
+      - To entirely remove the disk from backing storage use O(state=absent).
     type: str
     choices: ['present', 'resized', 'detached', 'moved', 'absent']
     default: present
   create:
     description:
-      - With I(create) flag you can control behavior of I(state=present).
-      - When I(create=disabled) it will not create new disk (if not exists) but will update options in existing disk.
-      - When I(create=regular) it will either create new disk (if not exists) or update options in existing disk.
-      - When I(create=forced) it will always create new disk (if disk exists it will be detached and left unused).
+      - With O(create) flag you can control behavior of O(state=present).
+      - When O(create=disabled) it will not create new disk (if not exists) but will update options in existing disk.
+      - When O(create=regular) it will either create new disk (if not exists) or update options in existing disk.
+      - When O(create=forced) it will always create new disk (if disk exists it will be detached and left unused).
     type: str
     choices: ['disabled', 'regular', 'forced']
     default: regular
   storage:
     description:
       - The drive's backing storage.
-      - Used only when I(state) is C(present).
+      - Used only when O(state) is V(present).
     type: str
   size:
     description:
-      - Desired volume size in GB to allocate when I(state=present) (specify I(size) without suffix).
+      - Desired volume size in GB to allocate when O(state=present) (specify O(size) without suffix).
       - >
-        New (or additional) size of volume when I(state=resized). With the C(+) sign
+        New (or additional) size of volume when O(state=resized). With the V(+) sign
         the value is added to the actual size of the volume
         and without it, the value is taken as an absolute one.
     type: str
   bwlimit:
     description:
       - Override I/O bandwidth limit (in KB/s).
-      - Used only when I(state=moved).
+      - Used only when O(state=moved).
     type: int
   delete_moved:
     description:
       - Delete the original disk after successful copy.
       - By default the original disk is kept as unused disk.
-      - Used only when I(state=moved).
+      - Used only when O(state=moved).
     type: bool
   target_disk:
     description:
-      - The config key the disk will be moved to on the target VM (for example, C(ide0) or C(scsi1)).
+      - The config key the disk will be moved to on the target VM (for example, V(ide0) or V(scsi1)).
       - Default is the source disk key.
-      - Used only when I(state=moved).
+      - Used only when O(state=moved).
     type: str
   target_storage:
     description:
-      - Move the disk to this storage when I(state=moved).
+      - Move the disk to this storage when O(state=moved).
       - You can move between storages only in scope of one VM.
-      - Mutually exclusive with I(target_vmid).
-      - Consider increasing I(timeout) in case of large disk images or slow storage backend.
+      - Mutually exclusive with O(target_vmid).
+      - Consider increasing O(timeout) in case of large disk images or slow storage backend.
     type: str
   target_vmid:
     description:
-      - The (unique) ID of the VM where disk will be placed when I(state=moved).
+      - The (unique) ID of the VM where disk will be placed when O(state=moved).
       - You can move disk between VMs only when the same storage is used.
-      - Mutually exclusive with I(target_vmid).
+      - Mutually exclusive with O(target_vmid).
     type: int
   timeout:
     description:
       - Timeout in seconds to wait for slow operations such as importing disk or moving disk between storages.
-      - Used only when I(state) is C(present) or C(moved).
+      - Used only when O(state) is V(present) or V(moved).
     type: int
     default: 600
   aio:
@@ -177,13 +177,13 @@ options:
       - Volume string format
       - C(<STORAGE>:<VMID>/<FULL_NAME>) or C(<ABSOLUTE_PATH>/<FULL_NAME>)
       - Attention! Only root can use absolute paths.
-      - This parameter is mutually exclusive with I(size).
-      - Increase I(timeout) parameter when importing large disk images or using slow storage.
+      - This parameter is mutually exclusive with O(size).
+      - Increase O(timeout) parameter when importing large disk images or using slow storage.
     type: str
   iops:
     description:
       - Maximum total r/w I/O in operations per second.
-      - You can specify either total limit or per operation (mutually exclusive with I(iops_rd) and I(iops_wr)).
+      - You can specify either total limit or per operation (mutually exclusive with O(iops_rd) and O(iops_wr)).
     type: int
   iops_max:
     description:
@@ -196,7 +196,7 @@ options:
   iops_rd:
     description:
       - Maximum read I/O in operations per second.
-      - You can specify either read or total limit (mutually exclusive with I(iops)).
+      - You can specify either read or total limit (mutually exclusive with O(iops)).
     type: int
   iops_rd_max:
     description:
@@ -209,7 +209,7 @@ options:
   iops_wr:
     description:
       - Maximum write I/O in operations per second.
-      - You can specify either write or total limit (mutually exclusive with I(iops)).
+      - You can specify either write or total limit (mutually exclusive with O(iops)).
     type: int
   iops_wr_max:
     description:
@@ -227,7 +227,7 @@ options:
     description:
       - Maximum total r/w speed in megabytes per second.
       - Can be fractional but use with caution - fractionals less than 1 are not supported officially.
-      - You can specify either total limit or per operation (mutually exclusive with I(mbps_rd) and I(mbps_wr)).
+      - You can specify either total limit or per operation (mutually exclusive with O(mbps_rd) and O(mbps_wr)).
     type: float
   mbps_max:
     description:
@@ -236,7 +236,7 @@ options:
   mbps_rd:
     description:
       - Maximum read speed in megabytes per second.
-      - You can specify either read or total limit (mutually exclusive with I(mbps)).
+      - You can specify either read or total limit (mutually exclusive with O(mbps)).
     type: float
   mbps_rd_max:
     description:
@@ -245,7 +245,7 @@ options:
   mbps_wr:
     description:
       - Maximum write speed in megabytes per second.
-      - You can specify either write or total limit (mutually exclusive with I(mbps)).
+      - You can specify either write or total limit (mutually exclusive with O(mbps)).
     type: float
   mbps_wr_max:
     description:
@@ -312,7 +312,7 @@ options:
     choices: ['enospc', 'ignore', 'report', 'stop']
   wwn:
     description:
-      - The drive's worldwide name, encoded as 16 bytes hex string, prefixed by C(0x).
+      - The drive's worldwide name, encoded as 16 bytes hex string, prefixed by V(0x).
     type: str
 extends_documentation_fragment:
   - community.general.proxmox.documentation