[libvirt PATCHv2 10/10] docs: add virtiofs kbase

[Ján Tomko]

On Thu, Jan 23, 2020 at 03:58:43PM -0600, Eric Blake wrote:
>On 1/23/20 11:46 AM, Ján Tomko wrote:
>>Add a document describing the usage of virtiofs.
>>---
>>  docs/kbase.html.in      |   3 +
>>  docs/kbase/virtiofs.rst | 153 ++++++++++++++++++++++++++++++++++++++++
>>  2 files changed, 156 insertions(+)
>>  create mode 100644 docs/kbase/virtiofs.rst
>>
>
>>+=== 8< delete before merging 8< ===
>>+NOTE: if you're looking at this note, this is just a proposal.
>>+See the up-to-date version on: https://libvirt.org/kbase/virtiofs.html
>>+=== 8< --------------------- 8< ===
>
>I'm assuming this will be updated ;)
>
>>+
>>+.. contents::
>>+
>>+=========
>>+Virtio-FS
>>+=========
>>+
>>+Virtio-FS is a delicious delicacy aiming to provide an easy-to-configure
>
>Fun language, but diverges from the official description...
>
>>+way of sharing filesystems between the host and the virtual machine.
>>+
>>+See https://virtio-fs.gitlab.io/
>
>...that you find here: "Virtio-fs is a shared file system that lets 
>virtual machines access a directory tree on the host. Unlike existing 
>approaches, it is designed to offer local file system semantics and 
>performance."
>
>I'm not opposed to a fun turn of a phrase in what is otherwise dry 
>technical documentation, but wonder if it helps our case here.
>

Oops, I totally forgot about that placeholder text.

Jano

>
>>+
>>+2. Use hugepage-backed memory
>>+
>>+Make sure there are enough huge pages allocated for the requested guest memory.
>>+For exmaple, for one guest with 2 GiB of RAM backed by 2 MiB hugepages:
>
>example
>
>-- 
>Eric Blake, Principal Software Engineer
>Red Hat, Inc.           +1-919-301-3226
>Virtualization:  qemu.org | libvirt.org
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20200124/658e240d/attachment-0001.sig>