Repository navigation
Fix the truncated pwsh man page - #28293
Open
Christian Pfeiffer (ChrisTX) wants to merge 1 commit into
Open
Christian Pfeiffer (ChrisTX) wants to merge 1 commit into
Christian Pfeiffer (ChrisTX) wants to merge 1 commit into
Conversation
The checked-in pwsh.1 ends in the synopsis at -WindowStyle, because Ronn takes its placeholder <style> for an HTML style element and drops what follows. Rename the placeholder to <windowStyle>, like the other camelCase placeholders, and regenerate pwsh.1 from pwsh.1.ronn. Fixes PowerShell#21086 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
Author
|
@microsoft-github-policy-service agree |
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are reported for the change restoring the packaged pwsh man page.
No open issues 🎉
What changed in this PR
Fixes #21086 by restoring the complete pwsh man page installed by Linux and macOS packages, which use the checked-in generated file introduced in #24423.
Changes:
- Renames
<style>to<windowStyle>to prevent Ronn from interpreting the placeholder as an HTML element. - Regenerates the man page with Ronn-NG 0.10.1, restoring the complete synopsis and all nine sections.
| File | Description |
|---|---|
assets/manpage/pwsh.1.ronn |
Corrects the placeholder that caused truncation. |
assets/manpage/pwsh.1 |
Restores the complete generated man page used by packaging. |
Review effort: Balanced
Arch Linux Technical User (archlinux-github)
pushed a commit
to archlinux/aur
that referenced
this pull request
Nov 1, 2026
- check() fails on groff warnings for pwsh.1 (groff -man -ww -z, as in PowerShell/PowerShell#28293) - and on sections of pwsh.1.ronn missing from pwsh.1, which groff doesn't notice: the checked-in page of PowerShell/PowerShell#21086 ends in the synopsis without a warning - Runs on cross builds as well, before the test suite is skipped - groff in checkdepends Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
microsoft-github-policy-service
Bot
added
the
Review - Needed
Contributor
|
This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days. |
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
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary
Fixes #21086.
The checked-in
assets/manpage/pwsh.1, which the Linux and macOS packages install, ends in the middle of the synopsis at-WindowStyle. Everything after it is missing: the rest of the synopsis, the description, all options, files, environment, automatic variables, see also and copyright.The cause is the placeholder
<style>inpwsh.1.ronn. Ronn treats<name>as a placeholder, butstyleis also the name of an HTML element, so it parses<style>as one and drops what follows. With Ronn 0.7.3, which generated the currentpwsh.1, that's the rest of the document; Ronn-NG only drops the rest of the synopsis.This PR:
<windowStyle>, like the other camelCase placeholders (<filePath>,<directoryPath>), so all placeholders are still rendered the same waypwsh.1frompwsh.1.ronn(ronn -r pwsh.1.ronn, Ronn-NG 0.10.1)The regenerated page has all nine sections, and
groff -man -ww -z pwsh.1reports no warnings.PR Context
The man page installed with PowerShell on Linux and macOS only shows the name and the start of the synopsis (#21086).
pwsh.1was checked in by #24423, which generates the packages' man page from that file instead of running Ronn during packaging.PR Checklist
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright header🤖 Generated with Claude Code