Tidy up README and TOC (#1108)

Bring the TOC in line with recent additions and enable the ability to
use a vim plugin to quickly regenerate in lieu of a better alternative.

Using https://github.com/mzlogin/vim-markdown-toc

Clean up any trailing whitespace so that subsequent file updates
by other PRs will be able to simply regen using appropriate tooling
without pulling in additional changes unrelated.
This commit is contained in:
Darragh Bailey
2020-05-10 14:23:25 +01:00
committed by GitHub
parent a83900f1ae
commit f5f9e34da0

View File

@@ -13,6 +13,8 @@ can help a lot :-)
## Index
<!-- note in vim set "let g:vmt_list_item_char='-'" to generate the correct output -->
<!-- vim-markdown-toc GFM -->
- [Features](#features)
- [Future work](#future-work)
@@ -40,17 +42,22 @@ can help a lot :-)
- [USB Controller Configuration](#usb-controller-configuration)
- [USB Device Passthrough](#usb-device-passthrough)
- [USB Redirector Devices](#usb-redirector-devices)
- [Filter for USB Redirector Devices](#filter-for-usb-redirector-devices)
- [Random number generator passthrough](#random-number-generator-passthrough)
- [Watchdog·Device](#watchdog-device)
- [Watchdog device](#watchdog-device)
- [Smartcard device](#smartcard-device)
- [Hypervisor Features](#hypervisor-features)
- [CPU Features](#cpu-features)
- [CPU features](#cpu-features)
- [Memory Backing](#memory-backing)
- [No box and PXE boot](#no-box-and-pxe-boot)
- [SSH Access To VM](#ssh-access-to-vm)
- [Forwarded Ports](#forwarded-ports)
- [Synced Folders](#synced-folders)
- [QEMU Session Support](#qemu-session-support)
- [Customized Graphics](#customized-graphics)
- [TPM Devices](#tpm-devices)
- [Libvirt communication channels](#libvirt-communication-channels)
- [Custom command line arguments](#custom-command-line-arguments)
- [Box Format](#box-format)
- [Create Box](#create-box)
- [Package Box from VM](#package-box-from-vm)
@@ -58,6 +65,8 @@ can help a lot :-)
- [Development](#development)
- [Contributing](#contributing)
<!-- vim-markdown-toc -->
## Features
* Control local Libvirt hypervisors.
@@ -1511,8 +1520,7 @@ If you're still confused, check the Github Issues for this repo for anything tha
looks similar to your problem.
[Github Issue #1032](https://github.com/vagrant-libvirt/vagrant-libvirt/issues/1032)
contains some historical troubleshooting for VMs that appeared
to hang.
contains some historical troubleshooting for VMs that appeared to hang.
Did you hit a problem that you'd like to note here to save time in the future?
Please do!
@@ -1560,3 +1568,8 @@ $ bundle exec vagrant up --provider=libvirt
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
<!--
# styling for TOC
vim: expandtab shiftwidth=2
-->