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.

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

adds deprication warning to errname() #23597

Closed
wants to merge 1 commit into from
Closed

adds deprication warning to errname() #23597

wants to merge 1 commit into from

Conversation

dtoki
Copy link
Contributor

@dtoki dtoki commented Oct 12, 2018

adds deprecations warning to errname()
@jasnell

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. libuv Issues and PRs related to the libuv dependency or the uv binding. labels Oct 12, 2018
jasnell
jasnell reviewed Oct 12, 2018
View reviewed changes
doc/api/deprecations.md
### DEP0XXX: process.binding('uv').errname() private api

Type: Documentation-only (supports [`--pending-deprecation`][])

Copy link
Member

Choose a reason for hiding this comment

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

to whomever lands this: should add a bit more detail here on landing

@jasnell jasnell added semver-minor PRs that contain new features and should be released in the next minor version. code-and-learn Issues related to the Code-and-Learn events and PRs submitted during the events. labels Oct 12, 2018
addaleax
addaleax reviewed Oct 12, 2018
View reviewed changes
src/uv.cc Outdated
@@ -43,6 +43,15 @@ using v8::Value;
// lib/util.getSystemErrorName()
Copy link
Member

Choose a reason for hiding this comment

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

I guess you can remove this TODO comment, if you like?

vsemozhetbyt
vsemozhetbyt reviewed Oct 12, 2018
View reviewed changes
doc/api/deprecations.md Outdated
@@ -2230,6 +2230,12 @@ like `dns.lookup(false)` due to backward compatibility.
This behavior is undocumented and is thought to be unused in real world apps.
It will become an error in future versions of Node.js.

<a id="DEP0XXX"></a>
### DEP0XXX: process.binding('uv').errname() private api
Copy link
Contributor

Choose a reason for hiding this comment

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

Possible nit for a lander: api -> API

vsemozhetbyt
vsemozhetbyt reviewed Oct 12, 2018
View reviewed changes
doc/api/deprecations.md

Type: Documentation-only (supports [`--pending-deprecation`][])


Copy link
Contributor

Choose a reason for hiding this comment

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

Possible nit for a lander: extra empty line.

Copy link
Member

Choose a reason for hiding this comment

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

@vsemozhetbyt I’d count that under @jasnell’s comment. We want a description here rather than removing empty lines :)

@vsemozhetbyt vsemozhetbyt added the deprecations Issues and PRs related to deprecations. label Oct 12, 2018
@ChALkeR
Copy link
Member

ChALkeR commented Oct 12, 2018 •
edited
Loading

👍, but the commit message should be updated:

https://github.com/nodejs/node/blob/master/doc/guides/contributing/pull-requests.md#commit-message-guidelines

{The first line should} be prefixed with the name of the changed subsystem and start with an imperative verb. Check the output of git log --oneline files/you/changed to find out what subsystems your changes touch.

The first line of the commit message should have a subsystem prefix and look something like
src: deprecate process.binding('uv').errname()

ChALkeR
ChALkeR approved these changes Oct 12, 2018
View reviewed changes
Copy link
Member

@ChALkeR ChALkeR left a comment

Choose a reason for hiding this comment

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

LGTM.
The commit message could be fixed on landing.

thefourtheye
thefourtheye approved these changes Oct 13, 2018
View reviewed changes
src/env.h
@@ -842,6 +842,11 @@ class Environment {
emit_env_nonstring_warning_ = false;
return current_value;
}
inline bool EmitErrNameWarning() {
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: One empty line above this would be more readable.

@vsemozhetbyt
Copy link
Contributor

One more note for a lander: deprication -> deprecation in the commit message.

@addaleax
Copy link
Member

CI: https://ci.nodejs.org/job/node-test-pull-request/17833/

@addaleax
Copy link
Member

Landed in 91fe7e5, with nits addressed while landing

Thanks for the contribution! 🎉

(If you're interested in other possible contributions to Node.js but don't have a good idea of where to start looking, some ideas are posted at https://www.nodetodo.org/next-steps/.)

@addaleax addaleax closed this Oct 16, 2018
addaleax pushed a commit that referenced this pull request Oct 16, 2018
@dtoki @addaleax
src: add deprecation warning to errname()
91fe7e5 
PR-URL: #23597
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
jasnell pushed a commit that referenced this pull request Oct 17, 2018
@dtoki @jasnell
src: add deprecation warning to errname()
b61d31a 
PR-URL: #23597
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@addaleax addaleax addaleax approved these changes

@vsemozhetbyt vsemozhetbyt vsemozhetbyt left review comments

@ChALkeR ChALkeR ChALkeR approved these changes

@jasnell jasnell jasnell approved these changes

@thefourtheye thefourtheye thefourtheye approved these changes

@gireeshpunathil gireeshpunathil gireeshpunathil approved these changes

Assignees
No one assigned
Labels
c++ Issues and PRs that require attention from people who are familiar with C++. code-and-learn Issues related to the Code-and-Learn events and PRs submitted during the events. deprecations Issues and PRs related to deprecations. libuv Issues and PRs related to the libuv dependency or the uv binding. semver-minor PRs that contain new features and should be released in the next minor version.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@dtoki @ChALkeR @vsemozhetbyt @addaleax @jasnell @thefourtheye @gireeshpunathil @nodejs-github-bot