Fixup and update cmd.exe shelling out docs #1605
Closed
Conversation
This file contains 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
Kissaki
commented
Nov 1, 2024
| @@ -1,6 +1,6 @@ | |||
| # Coming from CMD.EXE | |||
|
|
|||
| This table was last updated for Nu 0.67.0. | |||
| This table was last updated for Nu 0.99.1. | |||
There was a problem hiding this comment.
I did not go over the command table. I was unsure whether it should remain the previous, be updated to the new, or split across concerns.
I chose to update it for simplicity, thinking issues can still be resolved either way when they come up/get reported.
But given that this refers to the table specifically, maybe it should remain the previous version?
|
CI failure on a file I did not change => #1606 |
The documentation about shelling out cmd.exe commands was outdated, incomplete, and confusing. * It mixed past tense "used to" and the forwarded commands without being clear about their relationship and differences * There have been multiple undocumented changes across versions * Neither Nu release notes nor this or the book escaping [the shell] mention these version differences The docs receive a significant update to structure and information: * Introduce a headlined section for the forwarded commands * Introduce version-blocks to describe differences between versions * Describe forwarded command list changes across versions within a same-behavior block * Differentiates between CMD.EXE and `cmd.exe` (the shell and the executable/forward call) These version docs may not be useful in the long run, given the version release ages. Nevertheless, these docs will serve as a good, thorough reference even if the information about older versions will be removed at some point or even soon. The docs themselves provide enough context and source links to verify their correctness. I will not repeat those here in the commit description.
Kissaki
force-pushed
the
docs/cmdcommandforwards
branch
from
3c52809
to
85e5717
Compare
|
I don't really see the value of mentioning old versions of nushell here. |
|
Shall I update it only with the most recent info then? Or is merging this, and then doing a follow-up to reduce it to the recent version viable, which would produce a conclusive doc of the behavior changes in the git log? |
|
ya, i think it would be better to fix it here and only have info on the latest version. |
Kissaki
added a commit
to Kissaki/nushell.github.io
that referenced
this pull request
Nov 2, 2024
Replaces nushell#1605 (which documented behavior across versions). The "if no executable by that name exists" has been wrong since 0.94.0 (not disclosed in release notes, but consequence of 6c649809d38a687cd63b59ab028b7f30207e5663). The "used to" (prior version 0.67 2022-08-16) is very old, and no longer worth it to keep. Add information about forwarded commands overshadowing external files.
fdncred
added a commit
that referenced
this pull request
Nov 2, 2024
* Update forwarded cmd.exe commands docs Replaces #1605 (which documented behavior across versions). The "if no executable by that name exists" has been wrong since 0.94.0 (not disclosed in release notes, but consequence of 6c649809d38a687cd63b59ab028b7f30207e5663). The "used to" (prior version 0.67 2022-08-16) is very old, and no longer worth it to keep. Add information about forwarded commands overshadowing external files. * Improve wording * 'forwarded' -> 'internal' Co-authored-by: Darren Schroeder <[email protected]> --------- Co-authored-by: Darren Schroeder <[email protected]>
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.
The documentation about shelling out cmd.exe commands was outdated, incomplete, and confusing.
The docs receive a significant update to structure and information:
cmd.exe(the shell and the executable/forward call)These version docs may not be useful in the long run, given the version release ages. Nevertheless, these docs will serve as a good, thorough reference even if the information about older versions will be removed at some point or even soon.
The docs themselves provide enough context and source links to verify their correctness. I will not repeat those here in the commit description.