Documentation of possible values for -o tidy_strategy is missing from the man page of dwarfs

[maxigaz]

I installed dwarfs 0.10.2 from the AUR on Arch Linux. Looking at man dwarfs, I found that some documentation of the option -o tidy_strategy is missing.

Here's how it looks for me:

However, if I open https://github.com/mhx/dwarfs/blob/main/doc/dwarfs.md or https://raw.githubusercontent.com/mhx/dwarfs/refs/heads/main/doc/dwarfs.md in a web browser, all the options are mentioned there, as expected.

- `-o tidy_strategy=`*name*:
  Use one of the following strategies to tidy the block cache:

  - `none`:
    This is the default strategy that never tidies the cache.
    Blocks will only be evicted from the cache if the cache is
    full and a more recently used block is added to the cache.

  - `time`:
    Time based tidying strategy. Every `tidy_interval`, the block
    cache is traversed and all blocks that have not been accessed
    for more then `tidy_max_age` will be removed.

  - `swap`:
    Swap based tidying strategy. Every `tidy_interval`, the block
    cache is traversed and all blocks that have been fully or
    partially swapped out by the kernel will be removed.

- `-o tidy_interval=`*time*:
  Used only if `tidy_strategy` is not `none`. This is the interval
  at which the cache tidying thread wakes up to look for blocks
  that can be removed from the cache. This must be an integer value.
  Suffixes `ms`, `s`, `m`, `h` are supported. If no suffix is given,
  the value will be assumed to be in seconds.

- `-o tidy_max_age=`*time*:
  Used only if `tidy_strategy` is `time`. A block will be removed
  from the cache if it hasn't been used for this time span. This must
  be an integer value. Suffixes `ms`, `s`, `m`, `h` are supported.
  If no suffix is given, the value will be assumed to be in seconds.

Could it be that the those list items were not recognised during the conversion from markdown to the manpage format?

[mhx]

Thank you for catching and reporting this!

Could it be that the those list items were not recognised during the conversion from markdown to the manpage format?

That's exactly what's happening. If you try dwarfs --man, which uses a different library to turn markdown into an embeddable manual page, you should also see the list of strategies.

It seems that ronn-ng has an open issue for the problem. I'll see if there's a quick fix, but I'd prefer to rely on an upstream fix in ronn-ng.

[mhx]

I've changed the docs to not use nested indentation. This was the only place where it was used, and it was even inconsistent with the documentation of similar options. If there's another maintenance release on the 0.10.x branch, it'll go in there, otherwise it'll be part of the 0.11.0 release.