doveadm: Allow FTS man page information to be overriden via an include file

Allows Pro to add "fts check" commands, which are only used there.

Author: slusarz

docs/core/man/doveadm-fts.1.md

@@ -64,70 +64,7 @@ index** will index all the missing mails (if any). Note that currently
 most FTS drivers do not implement this properly, but instead they
 delete all the FTS indexes. This may change in the future versions.
 
-### fts check fast
-
-**doveadm** [*GLOBAL OPTIONS*] fts check fast
-  [**-u** *user* | **-A** | **-F** *file* | **\-\-no-userdb-lookup**]
-  [**-S** *socket_path*]
-  [**-\-refresh**]
-  [**-\-print-mismatches-only**]
-  [*namespace*]
-
-This command exists only when the fts_dovecot plugin (Dovecot Pro FTS) is
-loaded.
-
-This command can be used to check FTS indexes for consistency. It performs
-a fast check using only information in local caches (fts.S, metacache).
-
-**-\-refresh**
-:   Refresh any necessary local caches for the command to run successfully.
-    This can be used if the command otherwise fails with exit code 68.
-
-**-\-print-mismatches-only**
-:    Print only mailboxes that have inconsistencies.
-
-Exit codes:
-
-**0**
-:   The mailbox is fully consistent
-
-**2**
-:   The mailbox is not fully consistent
-
-**68**
-:   There is not enough information in local metacache to know whether the
-    mailbox is fully consistent. Use either the **-\-refresh** parameter or
-    the "full" check.
-
-### fts check full
-
-**doveadm** [*GLOBAL OPTIONS*] fts check full
-  [**-u** *user* | **-A** | **-F** *file* | **\-\-no-userdb-lookup**]
-  [**-S** *socket_path*]
-  [**-\-print-details**]
-  [**-\-print-mismatches-only**]
-  [*namespace*]
-
-This command exists only when the fts_dovecot plugin (Dovecot Pro FTS) is
-loaded.
-
-This command can be used to check FTS indexes for consistency. It performs
-a full check to give detailed output of inconsistencies.
-
-**-\-print-details**
-:   Print also IMAP UID numbers and FTS triplet names for each email.
-
-**-\-print-mismatches-only**
-:   Print only mailboxes (or emails, with **-\-print-details**) that have
-    inconsistencies.
-
-Exit codes:
-
-**0**
-:   The mailbox is fully consistent
-
-**2**
-:   The mailbox is not fully consistent
+<!-- @include: @docs/core/man/include/doveadm-fts-includes.inc -->
 
 <!-- @include: include/reporting-bugs.inc -->
 

util/generate_man.js

@@ -44,10 +44,14 @@ const debug = program.opts().debug
 const doInclude = (content, includes, f) => {
 	const result = content.replace(includesRE, (m, m1) => {
 		if (!m1.length) return m
+		/* VitePress MD supports paths relative to base with leading
+		 * '@'. */
+		if (m1.startsWith('@'))
+			return doInclude(fs.readFileSync(process.cwd() + '/' + m1.slice(1), 'utf8'), includes, f)
 		const inc_f = path.basename(m1)
 		for (const fn of includes) {
 			if (path.basename(fn) == inc_f)
-			   return doInclude(fs.readFileSync(fn, 'utf8'), includes, f)
+				return doInclude(fs.readFileSync(fn, 'utf8'), includes, f)
 		}
 		throw new Error("Missing include " + inc_f)
 	})