public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Markus Frank <m.frank@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH docs v1 3/5] virtiofs: add table for optional parameters
Date: Mon,  5 May 2025 17:05:31 +0200	[thread overview]
Message-ID: <20250505150533.290694-4-m.frank@proxmox.com> (raw)
In-Reply-To: <20250505150533.290694-1-m.frank@proxmox.com>

Removes redundant explanatory text now covered by the table.

Signed-off-by: Markus Frank <m.frank@proxmox.com>
---
 qm.adoc | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/qm.adoc b/qm.adoc
index 74f8304..1549705 100644
--- a/qm.adoc
+++ b/qm.adoc
@@ -1325,12 +1325,16 @@ xattrs if the underlying host filesystem supports them, but they must also be
 compatible with the guest filesystem (for example most Linux filesystems support
 ACLs, while Windows filesystems do not).
 
-The `expose-acl` option automatically implies `expose-xattr`, that is, it makes
-no difference if you set `expose-xattr` to `0` if `expose-acl` is set to `1`.
-
-If you want virtiofs to honor the `O_DIRECT` flag, you can set the `direct-io`
-parameter to `1` (default: `0`). This will degrade performance, but is useful if
-applications do their own caching.
+All Optional Parameters:
+
+[cols="1,3,1", options="header"]
+|===
+|Parameter |Description |Default
+|`cache` |Sets caching mode: `always`, `never`, `metadata`, or `auto`. |`auto`
+|`expose-acl` |Enables ACL passthrough; implies `expose-xattr`. Supported only on compatible filesystems. |`0`
+|`expose-xattr` |Enables xattr passthrough; redundant if `expose-acl` is `1`. |`0`
+|`direct-io` |Enables support for the `O_DIRECT` flag. May degrade performance, but is useful if applications perform their own caching. |`0`
+|===
 
 ----
 qm set <vmid> -virtiofs0 dirid=<dirid>,cache=always,direct-io=1
-- 
2.39.5



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel


  parent reply	other threads:[~2025-05-05 15:05 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-05 15:05 [pve-devel] [PATCH qemu-server/docs/manager v1 0/5] virtiofs: add thread-pool-size and improve docs Markus Frank
2025-05-05 15:05 ` [pve-devel] [PATCH qemu-server v1 1/5] fix #6370: virtiofs: add support for thread-pool-size option Markus Frank
2025-05-05 15:05 ` [pve-devel] [PATCH docs v1 2/5] virtiofs: add explanation for cache=metadata behavior Markus Frank
2025-05-05 15:05 ` Markus Frank [this message]
2025-05-05 15:05 ` [pve-devel] [PATCH docs v1 4/5] virtiofs: add thread-pool-size description Markus Frank
2025-05-05 15:05 ` [pve-devel] [PATCH manager v1 5/5] fix #6370: ui: virtiofs edit: add support for thread-pool-size option Markus Frank

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20250505150533.290694-4-m.frank@proxmox.com \
    --to=m.frank@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal