Docfix: add missing virtiofsd cache default 'auto'

Bug #1895399 reported by Harry Coin
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
QEMU
Fix Released
Undecided
Unassigned

Bug Description

The usage command line for virtiofsd has:

void fuse_cmdline_help(void)
{
    printf(" -h --help print help\n"
...
           " -o cache=<mode> cache mode. could be one of \"auto, "
           "always, none\"\n"
           " default: auto\n"

But the default: auto info is missing from the man page. I suggest this patch:

--- docs/tools/virtiofsd.rst 2020-09-10 18:07:45.380430677 -0500
+++ /tmp/virtiofsd.rst 2020-09-12 11:48:10.440815204 -0500
@@ -106,6 +106,7 @@
   forbids the FUSE client from caching to achieve best coherency at the cost of
   performance. ``auto`` acts similar to NFS with a 1 second metadata cache
   timeout. ``always`` sets a long cache lifetime at the expense of coherency.
+ The default is ``auto``.

 Examples
 --------

Revision history for this message
Stefan Hajnoczi (stefanha) wrote : Re: [Bug 1895399] [NEW] Docfix: add missing virtiofsd cache default 'auto'

On Sat, Sep 12, 2020 at 04:53:54PM -0000, Harry Coin wrote:
> Public bug reported:
>
> The usage command line for virtiofsd has:
>
> void fuse_cmdline_help(void)
> {
> printf(" -h --help print help\n"
> ...
> " -o cache=<mode> cache mode. could be one of \"auto, "
> "always, none\"\n"
> " default: auto\n"
>
>
> But the default: auto info is missing from the man page. I suggest this patch:
>
> --- docs/tools/virtiofsd.rst 2020-09-10 18:07:45.380430677 -0500
> +++ /tmp/virtiofsd.rst 2020-09-12 11:48:10.440815204 -0500
> @@ -106,6 +106,7 @@
> forbids the FUSE client from caching to achieve best coherency at the cost of
> performance. ``auto`` acts similar to NFS with a 1 second metadata cache
> timeout. ``always`` sets a long cache lifetime at the expense of coherency.
> + The default is ``auto``.
>
> Examples
> --------
>

Thanks, that looks good.

Please either submit a patch
(https://wiki.qemu.org/Contribute/SubmitAPatch) or reply with a line in
the following format so I can send a patch on your behalf:

  Signed-off-by: Full Name <email address hidden>

The "Signed-off-by:" tag indicates that you are contributing under the
Developer Certificate of Origin (https://developercertificate.org/) that
QEMU, Linux, and other open source projects use.

Revision history for this message
Harry Coin (hcoin) wrote :

On 9/14/20 5:08 AM, Stefan Hajnoczi wrote:
> On Sat, Sep 12, 2020 at 04:53:54PM -0000, Harry Coin wrote:
>> Public bug reported:
>>
>> The usage command line for virtiofsd has:
>>
>> void fuse_cmdline_help(void)
>> {
>> printf(" -h --help print help\n"
>> ...
>> " -o cache=<mode> cache mode. could be one of \"auto, "
>> "always, none\"\n"
>> " default: auto\n"
>>
>>
>> But the default: auto info is missing from the man page. I suggest this patch:
>>
>> --- docs/tools/virtiofsd.rst 2020-09-10 18:07:45.380430677 -0500
>> +++ /tmp/virtiofsd.rst 2020-09-12 11:48:10.440815204 -0500
>> @@ -106,6 +106,7 @@
>> forbids the FUSE client from caching to achieve best coherency at the cost of
>> performance. ``auto`` acts similar to NFS with a 1 second metadata cache
>> timeout. ``always`` sets a long cache lifetime at the expense of coherency.
>> + The default is ``auto``.
>>
>> Examples
>> --------
>>
> Thanks, that looks good.
>
> Please either submit a patch
> (https://wiki.qemu.org/Contribute/SubmitAPatch) or reply with a line in
> the following format so I can send a patch on your behalf:
>
> Signed-off-by: Full Name <email address hidden>
>
> The "Signed-off-by:" tag indicates that you are contributing under the
> Developer Certificate of Origin (https://developercertificate.org/) that
> QEMU, Linux, and other open source projects use.
>
OK.  First time for everything:

Signed-off-by: Harry G. Coin <email address hidden>

Revision history for this message
Stefan Hajnoczi (stefanha) wrote :

On Mon, Sep 14, 2020 at 02:53:57PM -0000, Harry Coin wrote:
> OK.  First time for everything:
>
> Signed-off-by: Harry G. Coin <email address hidden>

Thank you. I posted your patch to the QEMU mailing list with your
authorship information:
https://<email address hidden>/

Revision history for this message
Thomas Huth (th-huth) wrote :
Changed in qemu:
status: New → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.