/node

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: doc-only deprecation for util.log() #6161

Closed
wants to merge 1 commit into
base: master
from

Conversation

Reviewers
No reviews
Assignees
No one assigned
Labels
Projects
None yet
Milestone
  6.0.0
9 participants
@JacksonTian @benjamingr @jasnell @mscdex @evanlucas @thefourtheye @Fishrock123 @eljefedelrodeodeljefe @ChALkeR
@JacksonTian
Contributor

JacksonTian commented Apr 12, 2016

Checklist
  • documentation is changed or added
  • the commit message follows commit guidelines
Affected core subsystem(s)

util

Description of change

There are more powerful loggers in user land like debug, soft
deprecate it.

see #4497 .
@jasnell

jasnell reviewed Apr 12, 2016
View changes

doc/api/util.markdown Outdated
@@ -551,6 +551,8 @@ util.isUndefined(null)
## util.log(string)
Stability: 0 - Deprecated

This comment has been minimized.

Sign in to view
Copy link
@jasnell

jasnell Apr 12, 2016

Member

Perhaps include some alternative recommendation?

This comment has been minimized.

Sign in to view
Copy link
@JacksonTian

JacksonTian Apr 12, 2016

Contributor

Could we recommend 3rd package?

This comment has been minimized.

Sign in to view
Copy link
@jasnell

jasnell Apr 12, 2016

Member

Recommending a specific third party package would be problematic, but saying something like, "Use a third party userland module instead" would be ok.

This comment has been minimized.

Sign in to view
Copy link
@JacksonTian

JacksonTian Apr 12, 2016

Contributor

ok.
@JacksonTian
doc: doc-only deprecation for util.log() 
There are more powerful loggers in user land like `debug`, soft
deprecate it.
d5ce698

@JacksonTian JacksonTian force-pushed the JacksonTian:util_log branch to d5ce698 Apr 12, 2016

@JacksonTian

This comment has been minimized.

Sign in to view
Contributor

JacksonTian commented Apr 12, 2016

@jasnell I updated it.
doc/api/util.markdown
@@ -551,6 +551,8 @@ util.isUndefined(null)
## util.log(string)
Stability: 0 - Deprecated: Use a third party userland module instead.

This comment has been minimized.

Sign in to view
Copy link
@eljefedelrodeodeljefe

eljefedelrodeodeljefe Apr 12, 2016

Contributor

userland is maybe redundant here? Maybe also just point to .debuglog()? Even though there are no timestamps.

This comment has been minimized.

Sign in to view
Copy link
@Fishrock123

Fishrock123 Apr 20, 2016

Member

debuglog() is quite different. See below:

Output with timestamp on stdout.
@benjamingr

This comment has been minimized.

Sign in to view
Member

benjamingr commented Apr 12, 2016

Deprecating a method on a stable module should be semver major and ctc agenda.

+1 for deprecating it though.

@benjamingr benjamingr added doc semver-major labels Apr 12, 2016

@mscdex mscdex added the util label Apr 12, 2016

@jasnell jasnell added the ctc-agenda label Apr 19, 2016

@jasnell

This comment has been minimized.

Sign in to view
Member

jasnell commented Apr 19, 2016

This LGTM but adding it to the CTC agenda for a quick review
@jasnell

This comment has been minimized.

Sign in to view
Member

jasnell commented Apr 19, 2016

@nodejs/ctc
@mscdex

This comment has been minimized.

Sign in to view
Contributor

mscdex commented Apr 19, 2016

LGTM

@rvagg rvagg referenced this pull request Apr 20, 2016

Closed

Node.js Foundation Core Technical Committee (CTC) Meeting 2016-04-20 #6304

doc/api/util.markdown
@@ -49,7 +49,7 @@ where `3245` is the process id. If it is not run with that
environment variable set, then it will not print anything.
You may separate multiple `NODE_DEBUG` environment variables with a
comma. For example, `NODE_DEBUG=fs,net,tls`.
comma. For example, `NODE_DEBUG=fs,net,tls`.

This comment has been minimized.

Sign in to view
Copy link
@thefourtheye

thefourtheye Apr 20, 2016

Contributor

Unrelated change and it is possibly accepted by many.
@evanlucas

This comment has been minimized.

Sign in to view
Member

evanlucas commented Apr 20, 2016

LGTM with @thefourtheye nit addressed
@jasnell

This comment has been minimized.

Sign in to view
Member

jasnell commented Apr 20, 2016

@nodejs/ctc discussed this and decided to move forward with it. If there are no further objections by monday I will land before v6 is cut. There may need to be some additional tweaks to the actual text in the docs.

@jasnell jasnell added this to the 6.0.0 milestone Apr 22, 2016

@jasnell

This comment has been minimized.

Sign in to view
Member

jasnell commented Apr 25, 2016

LGTM. Fixing a couple of nits on landing

jasnell added a commit that referenced this pull request Apr 25, 2016

@JacksonTian @jasnell
doc: doc-only deprecation for util.log() 
There are more powerful loggers in user land like `debug`, soft
deprecate it.

PR-URL: #6161
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Evan Lucas <evanlucas@me.com>
236b7e8
@jasnell

This comment has been minimized.

Sign in to view
Member

jasnell commented Apr 25, 2016

Landed in 236b7e8

@jasnell jasnell closed this Apr 25, 2016

joelostrowski added a commit to joelostrowski/node that referenced this pull request Apr 25, 2016

@JacksonTian @joelostrowski
doc: doc-only deprecation for util.log() 
There are more powerful loggers in user land like `debug`, soft
deprecate it.

PR-URL: nodejs#6161
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Evan Lucas <evanlucas@me.com>
358cee0

jasnell added a commit that referenced this pull request Apr 26, 2016

@JacksonTian @jasnell
doc: doc-only deprecation for util.log() 
There are more powerful loggers in user land like `debug`, soft
deprecate it.

PR-URL: #6161
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Evan Lucas <evanlucas@me.com>
fa74805

@ChALkeR ChALkeR removed the ctc-agenda label Apr 27, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment