From b6718c8b43fe2c421a6a051ccf52b0d81b0b7e9a Mon Sep 17 00:00:00 2001 From: Michael M Slusarz Date: Thu, 22 Aug 2024 19:29:49 -0600 Subject: [PATCH] man: Fix include paths in include files This was breaking rendering in VitePress, as the include paths are relative to the file, not the page rendering the include file Need to fix man generation utility, with this change, by passing in the filepath of the included file in recursive calls, rather than the original file. --- docs/core/man/include/doveadm-backup-sync.inc | 14 +++++++------- docs/core/man/include/doveadm-copy-move.inc | 14 +++++++------- docs/core/man/include/global-options-formatter.inc | 2 +- util/generate_man.js | 2 +- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/core/man/include/doveadm-backup-sync.inc b/docs/core/man/include/doveadm-backup-sync.inc index 2ae3521aa..a49011b1f 100644 --- a/docs/core/man/include/doveadm-backup-sync.inc +++ b/docs/core/man/include/doveadm-backup-sync.inc @@ -102,13 +102,13 @@ server processes to be running, except when using -u parameter to do a dsync can sync either one or multiple users using the -u or -A parameters. - + ## OPTIONS - + - + **-1** : Do one-way synchronization instead of two-way synchronization. @@ -120,7 +120,7 @@ parameters. : Synchronize all the available namespaces. By default only namespaces that don't have explicit location setting are synchronized. - + **-P** : Run a [[man,doveadm-purge]] for the destination (remote) storage @@ -131,7 +131,7 @@ parameters. system to the destination (remote). This option reverses the flow, and will instead pull messages from the remote to the local storage. - + **-T** *secs* : Specify the time in seconds, how long [[man,doveadm]] should wait @@ -184,7 +184,7 @@ parameters. : Use stateful synchronization. If the previous state is unknown, use an empty string. The new state is always printed to standard output. - + **-x** *mailbox_mask* : Exclude the specified mailbox name/mask. The mask may contain "**?**" @@ -302,7 +302,7 @@ Once all users have been converted, you can set the default *mail_location* to mdbox and remove the per-user mail locations from *userdb*. - + ## SEE ALSO diff --git a/docs/core/man/include/doveadm-copy-move.inc b/docs/core/man/include/doveadm-copy-move.inc index d6489e4ed..a2c1f039c 100644 --- a/docs/core/man/include/doveadm-copy-move.inc +++ b/docs/core/man/include/doveadm-copy-move.inc @@ -38,19 +38,19 @@ given *search_query*, into the user's *destination* mailbox. In the third form, matching mails will be moved or copied only for given *user*(s). - + ## OPTIONS - + - + - + - + - + ## ARGUMENTS @@ -81,7 +81,7 @@ $ doveadm move -u jane Archive/2011/09 mailbox INBOX BEFORE \ 2011-10-01 SINCE 01-Sep-2011 ``` - + ## SEE ALSO diff --git a/docs/core/man/include/global-options-formatter.inc b/docs/core/man/include/global-options-formatter.inc index 7544a4876..2d8156ace 100644 --- a/docs/core/man/include/global-options-formatter.inc +++ b/docs/core/man/include/global-options-formatter.inc @@ -1,4 +1,4 @@ - + **-f** *formatter* : Specifies the *formatter* for formatting the output. Supported diff --git a/util/generate_man.js b/util/generate_man.js index a759838e3..fdfe1adf9 100755 --- a/util/generate_man.js +++ b/util/generate_man.js @@ -43,7 +43,7 @@ const doInclude = (content, f) => { return content.replace(includesRE, (m, m1) => { if (!m1.length) return m const inc_f = path.join(path.dirname(f), m1) - return doInclude(fs.readFileSync(inc_f, 'utf8'), f) + return doInclude(fs.readFileSync(inc_f, 'utf8'), inc_f) }) }