Skip to content

tools: fix man-page generation on Windows #64886

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Cherry wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −3
Open

tools: fix man-page generation on Windows #64886

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions tools/doc/man-page.doc-kit.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,14 @@ import { fileURLToPath } from 'node:url';

const root = new URL('../../', import.meta.url);

const fromRoot = (path) => fileURLToPath(new URL(path, root));
// POSIX separators, because `input` is a glob pattern and a backslash reads as
// an escape character, which would mangle Windows paths into non-matches.
const fromRoot = (path) =>
fileURLToPath(new URL(path, root)).replaceAll('\\', '/');

// doc-kit only treats a value as local when it parses as a `file:` URL, and a
// Windows drive letter parses as a URL scheme, so these must stay URLs.
const urlFromRoot = (path) => new URL(path, root).href;

export default {
target: ['man-page'],
Expand All @@ -15,7 +22,7 @@ export default {
output: fromRoot('tools/doc/.manpagecheck'),

// Point every loadable URL at its local file so no network request is made.
changelog: fromRoot('CHANGELOG.md'),
index: fromRoot('doc/api/index.md'),
changelog: urlFromRoot('CHANGELOG.md'),
index: urlFromRoot('doc/api/index.md'),
},
};
Loading