Skip to content
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.

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

doc: fix os.version() Windows API #32156

Merged
merged 1 commit into from
Mar 13, 2020
Merged

doc: fix os.version() Windows API #32156

merged 1 commit into from
Mar 13, 2020

Conversation

cjihrig
Copy link
Contributor

@cjihrig cjihrig commented Mar 9, 2020

pRtlGetVersion is not a thing. This text was likely a result of copying the variable name used in libuv. This commit updates the documentation to reference the correct Windows API call.

Refs: #31732

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. os Issues and PRs related to the os subsystem. labels Mar 9, 2020
@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 9, 2020
@juanarbol
Copy link
Member

I suggest adding the RtlGetVersion() also on os.release() docs, as long as is basically doing the same, if RtlGetVersion() is not available the fallback is GetVersionExW()

@cjihrig
Copy link
Contributor Author

cjihrig commented Mar 9, 2020

I suggest adding the RtlGetVersion() also on os.release() docs, as long as is basically doing the same, if RtlGetVersion() is not available the fallback is GetVersionExW()

Honestly, I don't think Node should be calling out these implementation details. If anything, I'd direct users to the libuv docs. Not because the libuv docs are particularly good, but because Node uses libuv directly, and if implementation changes are made in libuv, the docs there are more likely to get updated properly.

@juanarbol
Copy link
Member

Honestly, I don't think Node should be calling out these implementation details. If anything, I'd direct users to the libuv docs. Not because the libuv docs are particularly good, but because Node uses libuv directly, and if implementation changes are made in libuv, the docs there are more likely to get updated properly.

Yeah, I think you're right.

I'm +1 on this.

@addaleax addaleax removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 11, 2020
pRtlGetVersion is not a thing. This text was likely a result of
copying the variable name used in libuv. This commit updates the
documentation to reference the correct Windows API call.

PR-URL: nodejs#32156
Refs: nodejs#31732
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Bartosz Sosnowski <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. os Issues and PRs related to the os subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.