Skip to content

src: clarify OptionEnvvarSettings member names - #45057

Merged
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
legendecas:env-options
Oct 27, 2022
Merged

src: clarify OptionEnvvarSettings member names#45057
nodejs-github-bot merged 1 commit into
nodejs:mainfrom
legendecas:env-options

Conversation

@legendecas

@legendecaslegendecas commented Oct 18, 2022

Copy link
Copy Markdown
Member

The term Environment in kAllowedInEnvironment and
kDisallowedInEnvironment has nothing to do with the commonly used
term node::Environment. Rename the member to kAllowedInEnvvar and
kDisallowedInEnvvar respectively to reflect they are options of
OptionEnvvarSettings.

As OptionEnvvarSettings is part of the public embedder APIs, the
legacy names are still preserved.

@nodejs-github-bot

nodejs-github-bot commented Oct 18, 2022

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/startup

@nodejs-github-botnodejs-github-bot added c++ Issues and PRs that require attention from people who are familiar with C++. lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Oct 18, 2022
@targos

targos commented Oct 20, 2022

Copy link
Copy Markdown
Member

@nodejs/cpp-reviewers

RaisinTen
RaisinTen approved these changes Oct 20, 2022
View reviewed changes

@RaisinTenRaisinTen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The current name sounds better but one comment

Comment threadsrc/node.h Outdated
joyeecheung
joyeecheung approved these changes Oct 24, 2022
View reviewed changes
Comment threadsrc/node.h Outdated
@legendecas

legendecas commented Oct 24, 2022

Copy link
Copy Markdown
MemberAuthor

It came to me that embedders can actually parse the args from environment variables other than NODE_OPTIONS with the embedder API ProcessGlobalArgs. So I reverted the name to kAllowedInEnvvar and kDisallowedInEnvvar and documented these members and the API ProcessGlobalArgs.

@legendecas
src: clarify OptionEnvvarSettings member names
cb039c2
The term `Environment` in `kAllowedInEnvironment` and
`kDisallowedInEnvironment` has nothing to do with the commonly used
term `node::Environment`. Rename the member to `kAllowedInEnvvar`
and `kDisallowedInEnvvar` respectively to reflect they are options
of `OptionEnvvarSettings`.
As `OptionEnvvarSettings` is part of the public embedder APIs, the
legacy names are still preserved.
RafaelGSS
RafaelGSS approved these changes Oct 24, 2022
View reviewed changes

@RafaelGSSRafaelGSS left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM.

@legendecaslegendecas added commit-queue Add this label to land a pull request using GitHub Actions. request-ci Add this label to start a Jenkins CI on a PR. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Oct 26, 2022
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Oct 26, 2022
@nodejs-github-bot

nodejs-github-bot commented Oct 27, 2022

Copy link
Copy Markdown
Collaborator

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

@legendecaslegendecas added the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 27, 2022
@nodejs-github-botnodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 27, 2022
@nodejs-github-bot
nodejs-github-bot merged commit 68a3ce5 into nodejs:mainOct 27, 2022
@nodejs-github-bot

nodejs-github-bot commented Oct 27, 2022

Copy link
Copy Markdown
Collaborator

Landed in 68a3ce5

@legendecas
legendecas deleted the env-options branch October 27, 2022 16:26
RafaelGSS pushed a commit that referenced this pull request Nov 1, 2022
@legendecas@RafaelGSS
src: clarify OptionEnvvarSettings member names
3657f6a
The term `Environment` in `kAllowedInEnvironment` and
`kDisallowedInEnvironment` has nothing to do with the commonly used
term `node::Environment`. Rename the member to `kAllowedInEnvvar`
and `kDisallowedInEnvvar` respectively to reflect they are options
of `OptionEnvvarSettings`.
As `OptionEnvvarSettings` is part of the public embedder APIs, the
legacy names are still preserved.
PR-URL: #45057
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@RafaelGSSRafaelGSS mentioned this pull request Nov 1, 2022
Merged
RafaelGSS pushed a commit that referenced this pull request Nov 10, 2022
@legendecas@RafaelGSS
src: clarify OptionEnvvarSettings member names
243c141
The term `Environment` in `kAllowedInEnvironment` and
`kDisallowedInEnvironment` has nothing to do with the commonly used
term `node::Environment`. Rename the member to `kAllowedInEnvvar`
and `kDisallowedInEnvvar` respectively to reflect they are options
of `OptionEnvvarSettings`.
As `OptionEnvvarSettings` is part of the public embedder APIs, the
legacy names are still preserved.
PR-URL: #45057
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@danielleadams

danielleadams commented Dec 27, 2022

Copy link
Copy Markdown
Contributor

@legendecas this broke the build when landing in v18.x. Do you mind creating a backport? Thank you.

@legendecaslegendecas mentioned this pull request Dec 28, 2022
Closed
@legendecas

legendecas commented Dec 28, 2022

Copy link
Copy Markdown
MemberAuthor

@danielleadams created #45994.

This was referenced Jan 24, 2023
Merged
Merged
@LiviaMedeirosLiviaMedeiros mentioned this pull request Apr 6, 2023
Merged
legendecas added a commit to legendecas/node that referenced this pull request May 18, 2023
@legendecas
src: clarify OptionEnvvarSettings member names
37d7f81
The term `Environment` in `kAllowedInEnvironment` and
`kDisallowedInEnvironment` has nothing to do with the commonly used
term `node::Environment`. Rename the member to `kAllowedInEnvvar`
and `kDisallowedInEnvvar` respectively to reflect they are options
of `OptionEnvvarSettings`.
As `OptionEnvvarSettings` is part of the public embedder APIs, the
legacy names are still preserved.
PR-URL: nodejs#45057
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
danielleadams pushed a commit that referenced this pull request May 29, 2023
@legendecas@danielleadams
src: clarify OptionEnvvarSettings member names
0d5e324
The term `Environment` in `kAllowedInEnvironment` and
`kDisallowedInEnvironment` has nothing to do with the commonly used
term `node::Environment`. Rename the member to `kAllowedInEnvvar`
and `kDisallowedInEnvvar` respectively to reflect they are options
of `OptionEnvvarSettings`.
As `OptionEnvvarSettings` is part of the public embedder APIs, the
legacy names are still preserved.
PR-URL: #45057
Backport-PR-URL: #45994
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@danielleadamsdanielleadams mentioned this pull request Jul 10, 2023
Merged
aduh95 pushed a commit to aduh95/node that referenced this pull request Feb 18, 2025
@legendecas@RafaelGSS
src: clarify OptionEnvvarSettings member names
8809adf
The term `Environment` in `kAllowedInEnvironment` and
`kDisallowedInEnvironment` has nothing to do with the commonly used
term `node::Environment`. Rename the member to `kAllowedInEnvvar`
and `kDisallowedInEnvvar` respectively to reflect they are options
of `OptionEnvvarSettings`.
As `OptionEnvvarSettings` is part of the public embedder APIs, the
legacy names are still preserved.
PR-URL: nodejs#45057
Backport-PR-URL: nodejs#45994
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@addaleaxaddaleaxaddaleax approved these changes
@joyeecheungjoyeecheungjoyeecheung approved these changes
@RafaelGSSRafaelGSSRafaelGSS approved these changes
@RaisinTenRaisinTenRaisinTen approved these changes

Assignees

No one assigned

Labels

c++Issues and PRs that require attention from people who are familiar with C++.lib / srcIssues and PRs related to general changes in the lib or src directory.needs-ciPRs that need a full CI run.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

10 participants

@legendecas@nodejs-github-bot@targos@danielleadams@jasnell@addaleax@joyeecheung@RafaelGSS@RaisinTen@juanarbol