Skip to content

docs: virt: manually convert text documents to ReST format

Mauro Carvalho Chehab kvm linux-doc linux-media linux-um 1 version Applied

Status from this message: Queued, thanks very much for this.

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest28 patches 1 replyApplied

v3 from the cover letter

- locking.rst now uses tables for the two concurrency examples;
- The file guest-halt-polling.txt was still under Documentation/virtual. Converted to ReST and moved to Documentaion/virt;
- Addressed the issues pointed by Cornelia and Paolo.

Patches in v1 Applied

#Subject and filesSizeRepliesApplied
1/28docs: kvm: add arm/pvtime.rst to index.rstDocumentation/virt/kvm/arm/index.rst Documentation/virt/kvm/index.rst+12 -00 replies
2/28docs: virt: convert UML documentation to ReSTDocumentation/virt/index.rst Documentation/virt/uml/user_mode_linux.rst+789 -9170 replies
3/28docs: virt: user_mode_linux.rst: update compiling instructionsDocumentation/virt/uml/user_mode_linux.rst+9 -530 replies
4/28docs: virt: user_mode_linux.rst: fix URL referencesDocumentation/virt/uml/user_mode_linux.rst+29 -420 replies
5/28docs: virt: convert halt-polling.txt to ReST formatDocumentation/virt/kvm/halt-polling.rst Documentation/virt/kvm/index.rst+46 -410 replies
6/28docs: virt: Convert msr.txt to ReST formatDocumentation/virt/kvm/index.rst Documentation/virt/kvm/msr.rst+93 -550 replies
7/28docs: kvm: devices/arm-vgic-its.txt to ReST formatDocumentation/virt/kvm/devices/arm-vgic-its.rst Documentation/virt/kvm/devices/index.rst Documentation/virt/kvm/index.rst+78 -390 replies
8/28docs: kvm: devices/arm-vgit-v3.txt to ReSTDocumentation/virt/kvm/devices/arm-vgic-v3.rst Documentation/virt/kvm/devices/index.rst+87 -460 replies
9/28docs: kvm: convert devices/arm-vgit.txt to ReSTDocumentation/virt/kvm/devices/arm-vgic.rst Documentation/virt/kvm/devices/index.rst+60 -300 replies
10/28docs: kvm: convert devices/mpic.txt to ReSTDocumentation/virt/kvm/devices/index.rst Documentation/virt/kvm/devices/mpic.rst+9 -30 replies
11/28docs: kvm: convert devices/s390_flic.txt to ReSTDocumentation/virt/kvm/devices/index.rst Documentation/virt/kvm/devices/s390_flic.rst+41 -300 replies
12/28docs: kvm: convert devices/vcpu.txt to ReSTDocumentation/virt/kvm/devices/index.rst Documentation/virt/kvm/devices/vcpu.rst Documentation/virt/kvm/devices/vcpu.txt+115 -760 replies
13/28docs: kvm: convert devices/vfio.txt to ReSTDocumentation/virt/kvm/devices/index.rst Documentation/virt/kvm/devices/vfio.rst+16 -100 replies
14/28docs: kvm: convert devices/vm.txt to ReSTDocumentation/virt/kvm/devices/index.rst Documentation/virt/kvm/devices/vm.rst+127 -800 replies
15/28docs: kvm: convert devices/xics.txt to ReSTDocumentation/virt/kvm/devices/index.rst Documentation/virt/kvm/devices/xics.rst+23 -60 replies
16/28docs: kvm: convert devices/xive.txt to ReSTDocumentation/virt/kvm/devices/index.rst Documentation/virt/kvm/devices/xive.rst+96 -530 replies
17/28docs: kvm: Convert api.txt to ReST formatDocumentation/virt/kvm/api.rst Documentation/virt/kvm/index.rst+1963 -13860 replies
18/28docs: kvm: convert arm/hyp-abi.txt to ReSTDocumentation/virt/kvm/arm/hyp-abi.rst Documentation/virt/kvm/arm/index.rst+20 -90 replies
19/28docs: kvm: arm/psci.txt: convert to ReSTDocumentation/virt/kvm/arm/index.rst Documentation/virt/kvm/arm/psci.rst+32 -150 replies
20/28docs: kvm: Convert hypercalls.txt to ReST formatDocumentation/virt/kvm/hypercalls.rst Documentation/virt/kvm/index.rst+75 -560 replies
21/28docs: kvm: Convert locking.txt to ReST formatDocumentation/virt/kvm/index.rst Documentation/virt/kvm/locking.rst Documentation/virt/kvm/locking.txt+244 -2150 replies
22/28docs: kvm: Convert mmu.txt to ReST formatDocumentation/virt/kvm/index.rst Documentation/virt/kvm/mmu.rst+49 -140 replies
23/28docs: kvm: Convert nested-vmx.txt to ReST formatDocumentation/virt/kvm/index.rst Documentation/virt/kvm/nested-vmx.rst+22 -160 replies
24/28docs: kvm: Convert ppc-pv.txt to ReST formatDocumentation/virt/kvm/index.rst Documentation/virt/kvm/ppc-pv.rst+19 -80 replies
25/28docs: kvm: Convert s390-diag.txt to ReST formatDocumentation/virt/kvm/index.rst Documentation/virt/kvm/s390-diag.rst+9 -50 replies
26/28docs: kvm: Convert timekeeping.txt to ReST formatDocumentation/virt/kvm/index.rst Documentation/virt/kvm/timekeeping.rst+128 -940 replies
27/28docs: kvm: review-checklist.txt: rename to ReSTDocumentation/virt/kvm/index.rst Documentation/virt/kvm/review-checklist.rst+5 -00 replies
28/28docs: virt: guest-halt-polling.txt convert to ReSTDocumentation/virt/guest-halt-polling.rst Documentation/virt/index.rst+10 -30 replies

Reviews trailers per patch

6 of 28 patches have a Reviewed-by or Acked-by.

PatchCornelia Huck
1/28
2/28
3/28
4/28
5/28R-b
6/28
7/28
8/28
9/28
10/28
11/28R-b
12/28
13/28R-b
14/28R-b
15/28
16/28
17/28
18/28
19/28
20/28
21/28
22/28
23/28
24/28
25/28R-b
26/28
27/28R-b
28/28

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [PATCH 00/28] docs: virt: manually convert text documents to ReST format

Manually convert the documentation under Documentation/virt to ReST, minimizing the usage of uneeded markups and preserving the documentation writer's style.

PS.: Patches are against linux-next tree (20200204).

v3:

- locking.rst now uses tables for the two concurrency examples;
- The file guest-halt-polling.txt was still under Documentation/virtual. Converted to ReST and moved to Documentaion/virt;
- Addressed the issues pointed by Cornelia and Paolo.

v2:

- Solved a conflict with linux-next;
- Added SPDX headers.

Mauro Carvalho Chehab (28):
docs: kvm: add arm/pvtime.rst to index.rst
docs: virt: convert UML documentation to ReST
docs: virt: user_mode_linux.rst: update compiling instructions
docs: virt: user_mode_linux.rst: fix URL references
docs: virt: convert halt-polling.txt to ReST format
docs: virt: Convert msr.txt to ReST format
docs: kvm: devices/arm-vgic-its.txt to ReST format
docs: kvm: devices/arm-vgit-v3.txt to ReST
docs: kvm: convert devices/arm-vgit.txt to ReST
docs: kvm: convert devices/mpic.txt to ReST
docs: kvm: convert devices/s390_flic.txt to ReST
docs: kvm: convert devices/vcpu.txt to ReST
docs: kvm: convert devices/vfio.txt to ReST
docs: kvm: convert devices/vm.txt to ReST
docs: kvm: convert devices/xics.txt to ReST
docs: kvm: convert devices/xive.txt to ReST
docs: kvm: Convert api.txt to ReST format
docs: kvm: convert arm/hyp-abi.txt to ReST
docs: kvm: arm/psci.txt: convert to ReST
docs: kvm: Convert hypercalls.txt to ReST format
docs: kvm: Convert locking.txt to ReST format
docs: kvm: Convert mmu.txt to ReST format
docs: kvm: Convert nested-vmx.txt to ReST format
docs: kvm: Convert ppc-pv.txt to ReST format
docs: kvm: Convert s390-diag.txt to ReST format
docs: kvm: Convert timekeeping.txt to ReST format
docs: kvm: review-checklist.txt: rename to ReST
docs: virt: guest-halt-polling.txt convert to ReST

 .../guest-halt-polling.rst}                   |   12 +-
 Documentation/virt/index.rst                  |    2 +
 Documentation/virt/kvm/{api.txt => api.rst}   | 3348 ++++++++++-------
 .../virt/kvm/arm/{hyp-abi.txt => hyp-abi.rst} |   28 +-
 Documentation/virt/kvm/arm/index.rst          |   12 +
 .../virt/kvm/arm/{psci.txt => psci.rst}       |   46 +-
 .../{arm-vgic-its.txt => arm-vgic-its.rst}    |  106 +-
 .../{arm-vgic-v3.txt => arm-vgic-v3.rst}      |  132 +-
 .../devices/{arm-vgic.txt => arm-vgic.rst}    |   89 +-
 Documentation/virt/kvm/devices/index.rst      |   19 +
 .../virt/kvm/devices/{mpic.txt => mpic.rst}   |   11 +-
 .../devices/{s390_flic.txt => s390_flic.rst}  |   70 +-
 Documentation/virt/kvm/devices/vcpu.rst       |  114 +
 Documentation/virt/kvm/devices/vcpu.txt       |   76 -
 .../virt/kvm/devices/{vfio.txt => vfio.rst}   |   25 +-
 .../virt/kvm/devices/{vm.txt => vm.rst}       |  206 +-
 .../virt/kvm/devices/{xics.txt => xics.rst}   |   28 +-
 .../virt/kvm/devices/{xive.txt => xive.rst}   |  148 +-
 .../{halt-polling.txt => halt-polling.rst}    |   86 +-
 .../kvm/{hypercalls.txt => hypercalls.rst}    |  129 +-
 Documentation/virt/kvm/index.rst              |   16 +
 Documentation/virt/kvm/locking.rst            |  243 ++
 Documentation/virt/kvm/locking.txt            |  215 --
 Documentation/virt/kvm/{mmu.txt => mmu.rst}   |   62 +-
 Documentation/virt/kvm/{msr.txt => msr.rst}   |  147 +-
 .../kvm/{nested-vmx.txt => nested-vmx.rst}    |   37 +-
 .../virt/kvm/{ppc-pv.txt => ppc-pv.rst}       |   26 +-
 ...iew-checklist.txt => review-checklist.rst} |    3 +
 .../virt/kvm/{s390-diag.txt => s390-diag.rst} |   13 +-
 .../kvm/{timekeeping.txt => timekeeping.rst}  |  221 +-
 ...odeLinux-HOWTO.txt => user_mode_linux.rst} | 1814 ++++-----
 31 files changed, 4194 insertions(+), 3290 deletions(-)
 rename Documentation/{virtual/guest-halt-polling.txt => virt/guest-halt-polling.rst} (91%)
 rename Documentation/virt/kvm/{api.txt => api.rst} (71%)
 rename Documentation/virt/kvm/arm/{hyp-abi.txt => hyp-abi.rst} (79%)
 create mode 100644 Documentation/virt/kvm/arm/index.rst
 rename Documentation/virt/kvm/arm/{psci.txt => psci.rst} (60%)
 rename Documentation/virt/kvm/devices/{arm-vgic-its.txt => arm-vgic-its.rst} (71%)
 rename Documentation/virt/kvm/devices/{arm-vgic-v3.txt => arm-vgic-v3.rst} (77%)
 rename Documentation/virt/kvm/devices/{arm-vgic.txt => arm-vgic.rst} (66%)
 create mode 100644 Documentation/virt/kvm/devices/index.rst
 rename Documentation/virt/kvm/devices/{mpic.txt => mpic.rst} (91%)
 rename Documentation/virt/kvm/devices/{s390_flic.txt => s390_flic.rst} (87%)
 create mode 100644 Documentation/virt/kvm/devices/vcpu.rst
 delete mode 100644 Documentation/virt/kvm/devices/vcpu.txt
 rename Documentation/virt/kvm/devices/{vfio.txt => vfio.rst} (72%)
 rename Documentation/virt/kvm/devices/{vm.txt => vm.rst} (61%)
 rename Documentation/virt/kvm/devices/{xics.txt => xics.rst} (84%)
 rename Documentation/virt/kvm/devices/{xive.txt => xive.rst} (62%)
 rename Documentation/virt/kvm/{halt-polling.txt => halt-polling.rst} (64%)
 rename Documentation/virt/kvm/{hypercalls.txt => hypercalls.rst} (55%)
 create mode 100644 Documentation/virt/kvm/locking.rst
 delete mode 100644 Documentation/virt/kvm/locking.txt
 rename Documentation/virt/kvm/{mmu.txt => mmu.rst} (94%)
 rename Documentation/virt/kvm/{msr.txt => msr.rst} (74%)
 rename Documentation/virt/kvm/{nested-vmx.txt => nested-vmx.rst} (90%)
 rename Documentation/virt/kvm/{ppc-pv.txt => ppc-pv.rst} (91%)
 rename Documentation/virt/kvm/{review-checklist.txt => review-checklist.rst} (95%)
 rename Documentation/virt/kvm/{s390-diag.txt => s390-diag.rst} (90%)
 rename Documentation/virt/kvm/{timekeeping.txt => timekeeping.rst} (85%)
 rename Documentation/virt/uml/{UserModeLinux-HOWTO.txt => user_mode_linux.rst} (74%)
Signature · 8 lines
2.24.1



_______________________________________________
linux-um mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/linux-um