GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Set default native arg passing to Legacy on Windows. by JamesWTruher · Pull Request #18706 · PowerShell/PowerShell

Conversation

@JamesWTruher

@JamesWTruher James Truher (JamesWTruher) commented Dec 1, 2022 •
edited by daxian-dbw
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Collaborator

PR Summary

The committee agreed to a new PSWindowsNativeCommandArgPassing experimental feature. When this feature is enabled:

  • On Windows
    • $PSNativeCommandArgumentPassing = Windows
  • Non-Windows
    • $PSNativeCommandArgumentPassing = Standard

When this feature is disabled:

  • On Windows
    • $PSNativeCommandArgumentPassing = Legacy
  • Non-Windows
    • $PSNativeCommandArgumentPassing = Standard

Additionally, new telemetry metric will be added for native command execution to inform the mode being used.

PR Context

PR Checklist

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
  • This PR is ready to merge and is not Work in Progress.
    • If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
  • Breaking changes
    • None
    • OR
    • Experimental feature(s) needed
      • Experimental feature name(s):
  • User-facing changes
    • Not Applicable
    • OR
    • Documentation needed
      • Issue filed: Native argument passing on Windows default changes MicrosoftDocs/PowerShell-Docs#9739
  • Testing - New and feature
    • N/A or can only be tested interactively
    • OR
    • Make sure you've added a new test if existing tests do not effectively test the code changed
  • Tooling
    • I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
    • OR
    • I have considered the user experience from a tooling perspective and opened an issue in the relevant tool repository. This may include:
      • Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode
        (which runs in a different PS Host).
        • Issue filed:
      • Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
        • Issue filed:
      • Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
        • Issue filed:
      • Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
        • Issue filed:

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@pull-request-quantifier-deprecated pull-request-quantifier-deprecated Bot added the Extra Small label Dec 1, 2022
@ghost ghost assigned Paul Higinbotham (PaulHigin) Dec 1, 2022
daxian-dbw
Dongbo Wang (daxian-dbw) requested changes Dec 2, 2022
View reviewed changes

@daxian-dbw Dongbo Wang (daxian-dbw) left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can use PSVersionInfo.PSCurrentVersion.PreReleaseLabel to detect whether it's a stable version.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread src/System.Management.Automation/engine/InitialSessionState.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Dec 2, 2022
daxian-dbw
Dongbo Wang (daxian-dbw) requested changes Dec 2, 2022
View reviewed changes

@daxian-dbw Dongbo Wang (daxian-dbw) left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change makes stable and preview releases have different default behavior on native argument passing. Won't that inconsistency cause any problems and confusions to the preview adopters? If we choose to do this on purpose, then doc needs to be updated to reflect this inconsistency.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread src/System.Management.Automation/engine/InitialSessionState.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread src/System.Management.Automation/engine/InitialSessionState.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread test/powershell/Language/Scripting/NativeExecution/NativeCommandArguments.Tests.ps1 Resolved

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost added the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 2, 2022
@daxian-dbw Dongbo Wang (daxian-dbw) added the Backport-7.3.x-Consider label Dec 2, 2022
@ghost ghost removed the Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept label Dec 2, 2022
@SteveL-MSFT

Steve Lee (SteveL-MSFT) commented Dec 2, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

Dongbo Wang (@daxian-dbw) the difference between stable and preview is deliberate as to prioritize compat for stable while ensuring we have the new desired behavior in preview to continue to get feedback. Maybe an option we can take here to make this more clear is to wrap it in a new Experimental Feature. Specifically, Windows mode is experimental.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@daxian-dbw

Dongbo Wang (daxian-dbw) commented Dec 5, 2022

Copy link
Copy Markdown
Member

I understand there will be difference between stable and preview versions. However, the native arg passing feature is already official, so making an official feature behave differently seems confusing.

Introducing a new experimental feature for the different arg passing behavior in preview versions sounds like a good idea. A doc issue needs to be opened for the new experimental feature.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@SteveL-MSFT

Steve Lee (SteveL-MSFT) commented Dec 5, 2022

Copy link
Copy Markdown
Member

Dongbo Wang (@daxian-dbw) We should probably advertise that Windows mode is still experimental and changes will continue until we can get to an acceptable level of compatibility

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@JamesWTruher James Truher (JamesWTruher) changed the title WIP:Set default native arg passing to Legacy on Windows. Set default native arg passing to Legacy on Windows. Dec 6, 2022
@JamesWTruher James Truher (JamesWTruher) changed the title Set default native arg passing to Legacy on Windows. WIP:Set default native arg passing to Legacy on Windows. Dec 6, 2022
@JamesWTruher
James Truher (JamesWTruher) force-pushed the WindowNativeArgumentDefaults branch from 4788f33 to 11e8a6b Compare December 6, 2022 22:29
@ghost ghost added the Review - Needed The PR is being reviewed label Dec 14, 2022
@ghost

Deleted user (ghost) commented Dec 14, 2022

Copy link
Copy Markdown

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@JamesWTruher
James Truher (JamesWTruher) force-pushed the WindowNativeArgumentDefaults branch from 11e8a6b to 647eabe Compare January 23, 2023 19:45
@JamesWTruher James Truher (JamesWTruher) changed the title WIP:Set default native arg passing to Legacy on Windows. Set default native arg passing to Legacy on Windows. Jan 23, 2023
@JamesWTruher James Truher (JamesWTruher) mentioned this pull request Jan 24, 2023
Native argument passing on Windows default changes MicrosoftDocs/PowerShell-Docs#9739
Closed
2 tasks done
@daxian-dbw Dongbo Wang (daxian-dbw) added the Review - Committee The PR/Issue needs a review from the PowerShell Committee label May 1, 2023
@daxian-dbw

Dongbo Wang (daxian-dbw) commented May 1, 2023

Copy link
Copy Markdown
Member

@PowerShell/powershell-committee Please review this PR and decide whether this PR should be closed or accepted.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@ghost ghost removed the Review - Needed The PR is being reviewed label May 1, 2023
@daxian-dbw Dongbo Wang (daxian-dbw) added the Needs-Triage The issue is new and needs to be triaged by a work group. label May 1, 2023
PaulHigin
Paul Higinbotham (PaulHigin) approved these changes May 10, 2023
View reviewed changes
@SteveL-MSFT

Steve Lee (SteveL-MSFT) commented May 10, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

@PowerShell/powershell-committee discussed this. We agreed to a new PSWindowsNativeCommandArgPassing experimental feature. When this feature is enabled:

  • On Windows
    • $PSNativeCommandArgumentPassing = Windows
  • Non-Windows
    • $PSNativeCommandArgumentPassing = Standard

When this feature is disabled:

  • On Windows
    • $PSNativeCommandArgumentPassing = Legacy
  • Non-Windows
    • $PSNativeCommandArgumentPassing = Standard

Additionally, new telemetry metric will be added for native command execution to inform the mode being used.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@SteveL-MSFT Steve Lee (SteveL-MSFT) added Committee-Reviewed PS-Committee has reviewed this and made a decision and removed Review - Committee The PR/Issue needs a review from the PowerShell Committee labels May 10, 2023
@JamesWTruher
James Truher (JamesWTruher) force-pushed the WindowNativeArgumentDefaults branch from 647eabe to 4e1f2d5 Compare May 10, 2023 21:59
@StevenBucher98 Steven Bucher (StevenBucher98) added the PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed label May 15, 2023
daxian-dbw
Dongbo Wang (daxian-dbw) reviewed Jun 19, 2023
View reviewed changes
Comment thread src/System.Management.Automation/engine/InitialSessionState.cs Resolved

Uh oh!

There was an error while loading. Please reload this page.

daxian-dbw
Dongbo Wang (daxian-dbw) approved these changes Jun 19, 2023
View reviewed changes

@daxian-dbw Dongbo Wang (daxian-dbw) left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@daxian-dbw Dongbo Wang (daxian-dbw) added CL-Engine Indicates that a PR should be marked as an engine change in the Change Log and removed Review - Needed The PR is being reviewed Needs-Triage The issue is new and needs to be triaged by a work group. labels Jun 19, 2023
James Truher (JamesWTruher) and others added 9 commits June 19, 2023 15:57
@JamesWTruher
Set default native arg passing to Legacy on Windows.
ef5a174
If the PS release is a preview, then set it to Windows.
@JamesWTruher
remove whitespace following '!'
a85e54e
@JamesWTruher @daxian-dbw
Update src/System.Management.Automation/engine/InitialSessionState.cs
57959e9
Co-authored-by: Dongbo Wang <[email protected]>
@JamesWTruher @daxian-dbw
Update src/System.Management.Automation/engine/InitialSessionState.cs
44543d6
Co-authored-by: Dongbo Wang <[email protected]>
@JamesWTruher
update message to accurately reflect the code changes.
ce2e5f4
@JamesWTruher
merge conflict fixes
70d06c9
@JamesWTruher
Fix CodeFactor issue with regard to NativeCommandProcessor.cs
7b8850d
@JamesWTruher
fix typo
221e3ab
@JamesWTruher @daxian-dbw
Update src/System.Management.Automation/engine/InitialSessionState.cs
b37a98b
use compile time rather than runtime check

Co-authored-by: Dongbo Wang <[email protected]>
@JamesWTruher
James Truher (JamesWTruher) force-pushed the WindowNativeArgumentDefaults branch from 29c58b1 to b37a98b Compare June 19, 2023 22:57
@pull-request-quantifier-deprecated

pull-request-quantifier-deprecated Bot commented Jun 19, 2023

Copy link
Copy Markdown

This PR has 24 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Small
Size       : +21 -3
Percentile : 9.6%

Total files changed: 4

Change summary by file extension:
.cs : +17 -2
.ps1 : +4 -1

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@daxian-dbw
Dongbo Wang (daxian-dbw) merged commit 5437f38 into PowerShell:master Jun 19, 2023
@daxian-dbw Dongbo Wang (daxian-dbw) mentioned this pull request Jun 23, 2023
Add msbuild to NativeCommandProcessor (s_legacyCommands) in PWSH 7.3 #18660
Open
5 tasks done
@ghost

Deleted user (ghost) commented Jun 29, 2023

Copy link
Copy Markdown

🎉v7.4.0-preview.4 has been released which incorporates this pull request.:tada:

Handy links:

  • Release Notes
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@God-damnit-all

God-damnit-all commented Jun 30, 2023

Copy link
Copy Markdown
Contributor

So the default behavior in 7.2 is Legacy, then in 7.3 it's Windows, now it's going to be Legacy in 7.4 unless an experimental feature is enabled which makes it into Windows by default unless you set a new variable to Legacy, do I have that right?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@TravisEz13

Travis Plunk (TravisEz13) commented Jul 12, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

@ImportTaste, this is marked to backport to 7.3.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@TravisEz13 Travis Plunk (TravisEz13) added Backport-7.3.x-Approved and removed Backport-7.3.x-Consider labels Jul 12, 2023
@TravisEz13

Travis Plunk (TravisEz13) commented Sep 6, 2023

Copy link
Copy Markdown
Member

@PowerShell/powershell-committee Are we okay with making this change to 7.3 after it has been release?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@SteveL-MSFT

Steve Lee (SteveL-MSFT) commented Sep 7, 2023 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

PS-Committee decided to make this feature stable in 7.4, so the default will be Windows in 7.4. Based on the telemetry, it seems that most Windows (like 99%) have not changed the default in 7.4 previews to Legacy or Standard. As such, there is no reason to backport to 7.3 which will be supported for just 1 more year.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@TravisEz13 Travis Plunk (TravisEz13) removed the Backport-7.3.x-Consider label Sep 7, 2023
@God-damnit-all

God-damnit-all commented Sep 28, 2023

Copy link
Copy Markdown
Contributor

it seems that most Windows (like 99%) have not changed the default in 7.4 previews to Legacy or Standard

What's the difference between Windows and Standard on Windows?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
@JamesWTruher
Add a new experimental feature to control native argument passing sty…
334e5ba
…le on Windows (PowerShell#18706)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@daxian-dbw Dongbo Wang (daxian-dbw) daxian-dbw approved these changes
+1 more reviewer
@PaulHigin Paul Higinbotham (PaulHigin) PaulHigin approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@PaulHigin Paul Higinbotham (PaulHigin)

Labels

CL-Engine Indicates that a PR should be marked as an engine change in the Change Log Committee-Reviewed PS-Committee has reviewed this and made a decision Extra Small PowerShell-Docs needed The PR was reviewed and a PowerShell Docs update is needed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

7 participants

@JamesWTruher @SteveL-MSFT @daxian-dbw @God-damnit-all @TravisEz13 @PaulHigin @StevenBucher98
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.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.