Skip to content

Document new variable PSApplicationOutputEncoding #10876

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document new variable PSApplicationOutputEncoding #10876

wants to merge 2 commits into from
+178 −109

Conversation

@jborean93
Copy link
Contributor

@jborean93 jborean93 commented Feb 14, 2024 •
edited by sdwheeler
Loading

PR Summary

Documents the new variable $PSApplicationOutputEncoding which is used to control the encoding PowerShell uses when reading output from an external application.

This also removes the example for $OutputEncoding as it is wrong. The $OutputEncoding variable is only used as the encoding that PowerShell writes data through the external application's stdin pipe. The command line is always a string on Windows/Linux/macOS so is unaffected by this option.

PR Checklist

  • Descriptive Title: This PR's title is a synopsis of the changes it proposes.
  • Summary: This PR's summary describes the scope and intent of the change.
  • Contributor's Guide: I have read the contributors guide.
  • Style: This PR adheres to the style guide.

@jborean93 jborean93 mentioned this pull request Feb 14, 2024
Merged
22 tasks
@learn-build-service-prod

This comment was marked as outdated.

Sign in to view
@github-actions

This comment was marked as outdated.

Sign in to view
@jborean93
Copy link
Contributor Author

jborean93 commented Feb 14, 2024 •
edited
Loading

Depending on what happens with #10877, I might just revert the changes to $OutputEncoding here in favour of that PR and keep this focused on the new proposed variable.

Edit: PR has been merged so I've rebased the changes here.

@sdwheeler sdwheeler added hold-for-pr Waiting - for PR merge hold-for-release Waiting - for next release labels Feb 14, 2024
@jborean93 jborean93 force-pushed the PSApplicationOutputEncoding branch from b55f4ce to c1a3390 Compare February 14, 2024 20:00
@learn-build-service-prod

This comment was marked as outdated.

Sign in to view
@jborean93 jborean93 force-pushed the PSApplicationOutputEncoding branch from c1a3390 to bfb0a36 Compare February 14, 2024 20:04
@learn-build-service-prod

This comment was marked as outdated.

Sign in to view
@sdwheeler sdwheeler force-pushed the PSApplicationOutputEncoding branch from bfb0a36 to 49de1d1 Compare March 2, 2024 15:40
@learn-build-service-prod

This comment was marked as outdated.

Sign in to view
@github-actions

This comment was marked as outdated.

Sign in to view
@sdwheeler sdwheeler added this to the Future milestone May 9, 2024
@sdwheeler sdwheeler force-pushed the PSApplicationOutputEncoding branch from 49de1d1 to 823964e Compare May 16, 2024 20:17
@learn-build-service-prod

This comment was marked as off-topic.

Sign in to view
@sdwheeler sdwheeler force-pushed the PSApplicationOutputEncoding branch from 823964e to fababe9 Compare August 12, 2024 13:26
@learn-build-service-prod

This comment was marked as outdated.

Sign in to view
@learn-build-service-prod

This comment was marked as outdated.

Sign in to view
@sdwheeler
Copy link
Collaborator

sdwheeler commented Nov 22, 2024

This change is not going to make it into 7.5. Closing this PR. We can reopen it if the change gets merged in a future release.

@sdwheeler sdwheeler closed this Nov 22, 2024
@jborean93
Copy link
Contributor Author

jborean93 commented Oct 21, 2025

@sdwheeler, any chance we can re-open this PR now that PowerShell/PowerShell#21219 has been merged?

@sdwheeler sdwheeler reopened this Oct 21, 2025
@learn-build-service-prod

This comment was marked as outdated.

Sign in to view
@sdwheeler
Copy link
Collaborator

sdwheeler commented Oct 21, 2025

@jborean93 Thanks for the notification. I will rebase and take a look.

@sdwheeler sdwheeler force-pushed the PSApplicationOutputEncoding branch from 3f29267 to 2552059 Compare October 21, 2025 13:30
@sdwheeler sdwheeler removed the hold-for-pr Waiting - for PR merge label Oct 21, 2025
@learn-build-service-prod
Copy link
Contributor

learn-build-service-prod bot commented Oct 21, 2025

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Contributor

learn-build-service-prod bot commented Oct 21, 2025

Learn Build status updates of commit 2552059:

✅ Validation status: passed

File Status Preview URL Details
reference/7.5/Microsoft.PowerShell.Core/About/about_Character_Encoding.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Preference_Variables.md ✅Succeeded View (powershell-7.5)

For more details, please refer to the build report.

@jborean93 @sdwheeler
Document new variable PSApplicationOutputEncoding
527a18e 
Documents the new variable $PSApplicationOutputEncoding which is used to
control the encoding PowerShell uses when reading output from an
external application.
@sdwheeler sdwheeler force-pushed the PSApplicationOutputEncoding branch from 2552059 to 527a18e Compare October 21, 2025 13:59
@learn-build-service-prod
Copy link
Contributor

learn-build-service-prod bot commented Oct 21, 2025

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@learn-build-service-prod
Copy link
Contributor

learn-build-service-prod bot commented Oct 21, 2025

Learn Build status updates of commit 527a18e:

✅ Validation status: passed

File Status Preview URL Details
reference/7.5/Microsoft.PowerShell.Core/About/about_Character_Encoding.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Preference_Variables.md ✅Succeeded View (powershell-7.5)

For more details, please refer to the build report.

@learn-build-service-prod
Copy link
Contributor

learn-build-service-prod bot commented Oct 21, 2025

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

@sdwheeler
Copy link
Collaborator

sdwheeler commented Oct 21, 2025

Merge is pending release. Don't know if this is going into the next release of 7.6 or 7.5 (or both).

@learn-build-service-prod
Copy link
Contributor

learn-build-service-prod bot commented Oct 21, 2025

Learn Build status updates of commit b471605:

✅ Validation status: passed

File Status Preview URL Details
reference/7.5/Microsoft.PowerShell.Core/About/about_Character_Encoding.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Preference_Variables.md ✅Succeeded View (powershell-7.5)

For more details, please refer to the build report.

@jborean93
Copy link
Contributor Author

jborean93 commented Oct 21, 2025

Thanks, I've been told the master branch is for 7.7 so I'll update the PR's paths. Looks like the references/7.7 folder needs to be created first though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sdwheeler sdwheeler Awaiting requested review from sdwheeler sdwheeler is a code owner

@michaeltlombardi michaeltlombardi Awaiting requested review from michaeltlombardi michaeltlombardi is a code owner

1 more reviewer

@aungzawoo43 aungzawoo43 aungzawoo43 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

hold-for-release Waiting - for next release

Projects

None yet

Milestone

Future

Development

Successfully merging this pull request may close these issues.

3 participants

@jborean93 @sdwheeler @aungzawoo43