.ps1xml formatting file doc corrections
#12614
Merged
+103
−74
Conversation
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
surfingoldelephant
requested review from
michaeltlombardi and
sdwheeler
as code owners
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
surfingoldelephant
changed the title
.ps1xml formatting file doc corrections
reference/5.1/Microsoft.PowerShell.Core/About/about_Format.ps1xml.md
Outdated
Show resolved
Hide resolved
reference/7.4/Microsoft.PowerShell.Core/About/about_Format.ps1xml.md
Outdated
Show resolved
Hide resolved
reference/7.5/Microsoft.PowerShell.Core/About/about_Format.ps1xml.md
Outdated
Show resolved
Hide resolved
reference/7.6/Microsoft.PowerShell.Core/About/about_Format.ps1xml.md
Outdated
Show resolved
Hide resolved
This fixes the wrong path used in both `Update-FormatData` examples. The paths used to initially create the custom formatting files are .\MyDotNetTypes.Format.ps1xml and .\MyFileSystem.Format.ps1xml. Before this change, Update-FormatData -PrependPath incorrectly pointed to $HOME\Format\CultureInfo.Format.ps1xml and $PSHOME\Format\MyFileSystem.Format.ps1xml.
Both Update-FormatData examples now use the $HOME\Format example path. This also updates the first example to create the directory before calling Export-FormatData, as the directory doesn't exist by default and Export-FormatData fails if part of the path is missing.
This fixes the incorrect assertion that formatting files **must** use `.format.ps1xml` (only `.ps1xml` is required).
The original note suggests that after copying Win PS formatting files, the signature block should be replaced. However, the files don't actually contain a signature block to begin with. This may cause confusion, so the note is updated with a more generalized suggestion on signing taken from about_Format.ps1xml. Also includes minor style changes and less Windows-specific references.
The 7.x docs use `$HOME\Format` as an example directory. This updates the 5.1 doc to use the same path. It also removes the suggestion to place custom formatting files in Win PS's `$PSHOME`. As this is a system directory, it's not an appropriate location for user files.
michaeltlombardi
force-pushed
the
formatFileDocCorrections
branch
from
0f2da98 to
5d421c4
Compare
This comment was marked as outdated.
This comment was marked as outdated.
1 similar comment
Contributor
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. 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 foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
This comment was marked as outdated.
This comment was marked as outdated.
Contributor
|
Learn Build status updates of commit 5d421c4: ✅ Validation status: passed
For more details, please refer to the build report. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
This PR fixes various
.ps1xmlformatting file doc issues.about_Format.ps1xmlexamples.Copy-Item/Export-FormatDatadoesn't create missing directories)..format.ps1xml(only.ps1xmlis required).PR Checklist