docs: virt: manually convert text documents to ReST format
Status from this message: Queued, thanks very much for this.
Get series with b4
b4 am [email protected]Versions newest first
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 files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/28 | docs: kvm: add arm/pvtime.rst to index.rstDocumentation/ Documentation/ | +12 | 0 replies | |
| 2/28 | docs: virt: convert UML documentation to ReSTDocumentation/ Documentation/ | +789 | 0 replies | |
| 3/28 | docs: virt: user_mode_linux.rst: update compiling instructionsDocumentation/ | +9 | 0 replies | |
| 4/28 | docs: virt: user_mode_linux.rst: fix URL referencesDocumentation/ | +29 | 0 replies | |
| 5/28 | docs: virt: convert halt-polling.txt to ReST formatDocumentation/ Documentation/ | +46 | 0 replies | |
| 6/28 | docs: virt: Convert msr.txt to ReST formatDocumentation/ Documentation/ | +93 | 0 replies | |
| 7/28 | docs: kvm: devices/arm-vgic-its.txt to ReST formatDocumentation/ Documentation/ Documentation/ | +78 | 0 replies | |
| 8/28 | docs: kvm: devices/arm-vgit-v3.txt to ReSTDocumentation/ Documentation/ | +87 | 0 replies | |
| 9/28 | docs: kvm: convert devices/arm-vgit.txt to ReSTDocumentation/ Documentation/ | +60 | 0 replies | |
| 10/28 | docs: kvm: convert devices/mpic.txt to ReSTDocumentation/ Documentation/ | +9 | 0 replies | |
| 11/28 | docs: kvm: convert devices/s390_flic.txt to ReSTDocumentation/ Documentation/ | +41 | 0 replies | |
| 12/28 | docs: kvm: convert devices/vcpu.txt to ReSTDocumentation/ Documentation/ Documentation/ | +115 | 0 replies | |
| 13/28 | docs: kvm: convert devices/vfio.txt to ReSTDocumentation/ Documentation/ | +16 | 0 replies | |
| 14/28 | docs: kvm: convert devices/vm.txt to ReSTDocumentation/ Documentation/ | +127 | 0 replies | |
| 15/28 | docs: kvm: convert devices/xics.txt to ReSTDocumentation/ Documentation/ | +23 | 0 replies | |
| 16/28 | docs: kvm: convert devices/xive.txt to ReSTDocumentation/ Documentation/ | +96 | 0 replies | |
| 17/28 | docs: kvm: Convert api.txt to ReST formatDocumentation/ Documentation/ | +1963 | 0 replies | |
| 18/28 | docs: kvm: convert arm/hyp-abi.txt to ReSTDocumentation/ Documentation/ | +20 | 0 replies | |
| 19/28 | docs: kvm: arm/psci.txt: convert to ReSTDocumentation/ Documentation/ | +32 | 0 replies | |
| 20/28 | docs: kvm: Convert hypercalls.txt to ReST formatDocumentation/ Documentation/ | +75 | 0 replies | |
| 21/28 | docs: kvm: Convert locking.txt to ReST formatDocumentation/ Documentation/ Documentation/ | +244 | 0 replies | |
| 22/28 | docs: kvm: Convert mmu.txt to ReST formatDocumentation/ Documentation/ | +49 | 0 replies | |
| 23/28 | docs: kvm: Convert nested-vmx.txt to ReST formatDocumentation/ Documentation/ | +22 | 0 replies | |
| 24/28 | docs: kvm: Convert ppc-pv.txt to ReST formatDocumentation/ Documentation/ | +19 | 0 replies | |
| 25/28 | docs: kvm: Convert s390-diag.txt to ReST formatDocumentation/ Documentation/ | +9 | 0 replies | |
| 26/28 | docs: kvm: Convert timekeeping.txt to ReST formatDocumentation/ Documentation/ | +128 | 0 replies | |
| 27/28 | docs: kvm: review-checklist.txt: rename to ReSTDocumentation/ Documentation/ | +5 | 0 replies | |
| 28/28 | docs: virt: guest-halt-polling.txt convert to ReSTDocumentation/ Documentation/ | +10 | 0 replies |
Reviews trailers per patch
6 of 28 patches have a Reviewed-by or Acked-by.
| Patch | Cornelia Huck |
|---|---|
| 1/28 | |
| 2/28 | |
| 3/28 | |
| 4/28 | |
| 5/28 | R-b |
| 6/28 | |
| 7/28 | |
| 8/28 | |
| 9/28 | |
| 10/28 | |
| 11/28 | R-b |
| 12/28 | |
| 13/28 | R-b |
| 14/28 | R-b |
| 15/28 | |
| 16/28 | |
| 17/28 | |
| 18/28 | |
| 19/28 | |
| 20/28 | |
| 21/28 | |
| 22/28 | |
| 23/28 | |
| 24/28 | |
| 25/28 | R-b |
| 26/28 | |
| 27/28 | R-b |
| 28/28 |
Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.
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