FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

tools: fix man-page generation on Windows by Cherry · Pull Request #64886 · nodejs/node · GitHub

/ node Public

tools: fix man-page generation on Windows - #64886

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
Cherry:doc-kit-windows-man-page
Aug 18, 2026
Merged

tools: fix man-page generation on Windows#64886
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
Cherry:doc-kit-windows-man-page

Conversation

Cherry commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

I hit this while working on #64606, which changes doc/api/cli.md and so needs doc/node.1 regenerated. I couldn't regenerate it natively on Windows at all - I had to run the generator from WSL to get an up-to-date man page committed.

Two separate path assumptions in tools/doc/man-page.doc-kit.config.mjs:

  • changelog/index were native paths. doc-kit only reads a value from disk when it parses as a file: URL, and E: parses as a URL scheme (which is from where I tried to run this on Windows), so it tried to fetch them over the network and died with TypeError: fetch failed. Now passed as file: URLs.
  • input is a glob pattern, where \ is an escape character, so the native path matched no files. The run then spun indefinitely with no log output, which is why this wasn't obvious. Now uses POSIX separators.

Signed-off-by: James Ross <james@jross.me>

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/web-infra

nodejs-github-bot added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Jul 31, 2026
trivikr added the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 18, 2026
nodejs-github-bot merged commit e2b33e2 into nodejs:main Aug 18, 2026
27 checks passed

Copy link
Copy Markdown
Collaborator

Landed in e2b33e2

nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Aug 18, 2026
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
Signed-off-by: James Ross <james@jross.me>
PR-URL: #64886
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Stefan Stojanovic <stefan.stojanovic@janeasystems.com>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
aduh95 pushed a commit that referenced this pull request Aug 25, 2026
Signed-off-by: James Ross <james@jross.me>
PR-URL: #64886
Reviewed-By: Aviv Keller <me@aviv.sh>
Reviewed-By: Stefan Stojanovic <stefan.stojanovic@janeasystems.com>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants


Back | FazBrowse Home | New Git URL