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: add supported platforms list #11872

Closed
wants to merge 2 commits into from
Closed

Conversation

mhdawson
Copy link
Member

Checklist

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

doc

Talked to Rod, going to take over landing the supported platform list from him. Earlier review/discussion was in: d883278

@mhdawson mhdawson self-assigned this Mar 15, 2017
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Mar 15, 2017
BUILDING.md Outdated

### Shared libraries & dependencies

Node.js intends to support building against shared representations of dependencies found in the [*deps*][./deps/] directory.
Copy link
Contributor

Choose a reason for hiding this comment

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

[*deps*](./deps/) ?

Copy link
Member Author

Choose a reason for hiding this comment

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

done.

BUILDING.md Outdated
| GNU/Linux | Tier 1 | kernel >= 2.6.18, glibc >= 2.5 | x86, x64, arm, arm64 | |
| macOS | Tier 1 | >= 10.10 | x64 | |
| Windows | Tier 1 | >= Windows 7 or >= Windows2008R2 | x86, x64 | |
| SmartOS | Tier 2 | >= 14 < 16.4 | x86, x64 | see note1 |
Copy link
Member

Choose a reason for hiding this comment

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

On master, I think it's >=15

Copy link
Member Author

Choose a reason for hiding this comment

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

will update

Copy link
Member

@bnoordhuis bnoordhuis left a comment

Choose a reason for hiding this comment

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

Aside: can you wrap lines at 80 columns?

BUILDING.md Outdated

#### Unix

* GCC 4.8 or newer
Copy link
Member

Choose a reason for hiding this comment

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

I'd specify this as 4.8.5 per the discussion in #11840 and nodejs/v8#5.

Copy link
Member Author

Choose a reason for hiding this comment

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

ok, I guess we can then fix up for earlier versions in the backports

BUILDING.md Outdated

#### Windows

* Building Node: Visual Studio 2015¹ or Visual C++ Build Tools 2015 or newer
Copy link
Contributor

Choose a reason for hiding this comment

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

where is this <sup>1</sup> trying to link to?

Copy link
Member Author

Choose a reason for hiding this comment

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

nowhere that I can find, will remove.

@mhdawson
Copy link
Member Author

@targos @bnoordhuis @vsemozhetbyt @Fishrock123 addressed initial set of commments.

@bnoordhuis I wrapped at 80 were I thought that would work. I'm guessing it won't for the table although I did not have time today to try that. Do you believe that should be able to be wrapped as well and not mess up the table formatting ?

@jasnell
Copy link
Member

jasnell commented Mar 16, 2017

Needs a quick rebase

BUILDING.md Outdated
### Shared libraries & dependencies

Node.js intends to support building against shared representations of
dependencies found in the [*deps*](./deps/) directory.
Copy link
Member

Choose a reason for hiding this comment

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

I'd leave this out. With c-ares it was broken for years. The numerous V8 patches we float basically mean it's only guaranteed to work with our fork.

Historically, we made no promises except that we'll consider patches.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll remove for now, and we can add back in through follow PRs if appropriate after more discussion. What I think makes sense is that once this PR lands, I can open a new one adding that back in and we can have the discussion there as opposed to blocking getting the reset of the info in.

@bnoordhuis
Copy link
Member

@mhdawson Leaving the table unchanged is fine.

@gibfahn
Copy link
Member

gibfahn commented Mar 17, 2017

@mhdawson I see that the original PR was targeting v6, should the target branch of this one be changed to v6, or is it the supported platforms list for Node 8 (or Node 9, as there's already a v8.x branch)?

The other question is how this will be updated, is the plan to make sure a commit lands revising it before each major release of Node?

@mhdawson
Copy link
Member Author

mhdawson commented Mar 17, 2017

@gibfahn my plan is to land this for master as a base and then submit PRs to the other branches which reflect what is supported for those levels.

In terms of new releases, I think we should try to keep it up to date generally but definitely make sure it is updated to just before each major release of Node.

@mhdawson
Copy link
Member Author

Ok rebased, and addressed @bnoordhuis comment.

Copy link
Member

@gibfahn gibfahn left a comment

Choose a reason for hiding this comment

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

LGTM, this has been open since October, let's land it.

BUILDING.md Outdated
#### Windows

* Building Node: Visual Studio 2015 or Visual C++ Build Tools 2015 or newer
* Building native add-ons: Visual Studio 2013 or Visual C++ Build Tools 2015 or newer
Copy link
Member

Choose a reason for hiding this comment

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

Long line.

@mhdawson
Copy link
Member Author

Ok fixed long line, will now land.

@mhdawson
Copy link
Member Author

CI run, to be safe

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

mhdawson added a commit that referenced this pull request Mar 20, 2017
PR-URL: #11872
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
@mhdawson
Copy link
Member Author

Landed as ef47687.

Next steps

  1. Submit PR for part about supporting deps for additional discussion
  2. Submit PRs for 6.X and 4.X as backport/tweak to be appropriate for those levels

mhdawson added a commit to mhdawson/io.js that referenced this pull request Mar 20, 2017
- In the review of nodejs#11872 we
pulled out the discussion of supporting dependencies.  This
PR adds back that statement.
- Update README.md to indicatte BUILDING.md contains the list
of supported platforms.
@mhdawson
Copy link
Member Author

PR for discussion around what we should say about supporting dependencies: #11942

@thefourtheye
Copy link
Contributor

Closing this PR as the commit has landed in ef47687

@mhdawson
Copy link
Member Author

PR to add supported platform list to 6.X - #11943

jungx098 pushed a commit to jungx098/node that referenced this pull request Mar 21, 2017
PR-URL: nodejs#11872
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
mhdawson added a commit to mhdawson/io.js that referenced this pull request Mar 21, 2017
PR-URL: nodejs#11872
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
jasnell pushed a commit that referenced this pull request Mar 22, 2017
Original Commit Message:
  PR-URL: #11872
  Reviewed-By: James M Snell <jasnell@gmail.com>
  Reviewed-By: Rich Trott <rtrott@gmail.com>
  Reviewed-By: Roman Reiss <me@silverwind.io>
  Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
  Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

Backport-Of: #11872
PR-URL: #11943
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Apr 4, 2017
Original Commit Message:
  PR-URL: #11872
  Reviewed-By: James M Snell <jasnell@gmail.com>
  Reviewed-By: Rich Trott <rtrott@gmail.com>
  Reviewed-By: Roman Reiss <me@silverwind.io>
  Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
  Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

Backport-Of: #11872
PR-URL: #11943
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
mhdawson added a commit to mhdawson/io.js that referenced this pull request Apr 4, 2017
Original Commit Message:
  PR-URL: nodejs#11872
  Reviewed-By: James M Snell <jasnell@gmail.com>
  Reviewed-By: Rich Trott <rtrott@gmail.com>
  Reviewed-By: Roman Reiss <me@silverwind.io>
  Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
  Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

Backport-Of: nodejs#11872
PR-URL: nodejs#11943
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
@jasnell jasnell mentioned this pull request Apr 4, 2017
mhdawson added a commit that referenced this pull request Apr 11, 2017
Original Commit Message:
  PR-URL: #11872
  Reviewed-By: James M Snell <jasnell@gmail.com>
  Reviewed-By: Rich Trott <rtrott@gmail.com>
  Reviewed-By: Roman Reiss <me@silverwind.io>
  Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
  Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

Backport-Of: #11872
PR-URL: #11943
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Apr 17, 2017
Original Commit Message:
  PR-URL: #11872
  Reviewed-By: James M Snell <jasnell@gmail.com>
  Reviewed-By: Rich Trott <rtrott@gmail.com>
  Reviewed-By: Roman Reiss <me@silverwind.io>
  Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
  Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

Backport-Of: #11872
PR-URL: #11943
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Apr 19, 2017
Original Commit Message:
  PR-URL: #11872
  Reviewed-By: James M Snell <jasnell@gmail.com>
  Reviewed-By: Rich Trott <rtrott@gmail.com>
  Reviewed-By: Roman Reiss <me@silverwind.io>
  Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
  Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

Backport-Of: #11872
PR-URL: #11943
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
@mhdawson mhdawson deleted the docsupport branch June 28, 2017 19:22
andrew749 pushed a commit to michielbaird/node that referenced this pull request Jul 19, 2017
Original Commit Message:
  PR-URL: nodejs/node#11872
  Reviewed-By: James M Snell <jasnell@gmail.com>
  Reviewed-By: Rich Trott <rtrott@gmail.com>
  Reviewed-By: Roman Reiss <me@silverwind.io>
  Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
  Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>

Backport-Of: nodejs/node#11872
PR-URL: nodejs/node#11943
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.