summaryrefslogtreecommitdiff
path: root/BUILDING.md
AgeCommit message (Collapse)Author
2017-04-07doc: update OS level support for AIXMichael Dawson
Update OS level supprot for AIX. Based on discussions with the AIX team we've have decided that the minimum support level should be 7.1. This is because support for AIX 6.1 will likely end during the lifespan of the upcoming Node version 8 release. PR-URL: https://github.com/nodejs/node/pull/12235 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2017-04-04doc: change Mac OS X to macOSJR McEntee
This update changes references to "Mac OS X", "OS X", and "OSX" in markdown files to "macOS". PR-URL: https://github.com/nodejs/node/pull/12106 Fixes: https://github.com/nodejs/node/issues/12086 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2017-04-04doc: minor improvements in BUILDING.mdSakthipriyan Vairamani (thefourtheye)
1. necessarily reliably => necessarily reliable 2. projects root directory => project's root directory 3. remove `console` highlighting, as `test` alone is highlighted 4. fix broken link for Android NDK 5. highlight the directory location `/usr/local/ssl/fips-2.0` 6. update expected output to an example for `process.versions.openssl` as the version displayed is not mentioned in the document PR-URL: https://github.com/nodejs/node/pull/11963 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2017-03-20doc: add supported platforms listMichael Dawson
PR-URL: https://github.com/nodejs/node/pull/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>
2017-03-16doc: gcc version is at least 4.8.5 in BUILDING.mddetailyang
>= 4.8.5 is required because of compiler bugs in earlier versions PR-URL: https://github.com/nodejs/node/pull/11840 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2017-01-21Revert "doc: correct vcbuild options for windows testing"Gibson Fahnestock
This reverts commit ed9b6c1264a07084e44f1d269bfe82e0f1b37c74. PR-URL: https://github.com/nodejs/node/pull/10839 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com>
2017-01-10doc: correct vcbuild options for windows testingJonathan Boarman
Corrected parameter for running tests on Windows. Without the corrected parameters, Windows users encounter an error about failing to sign the build, "Failed to sign exe", which can be discouraging to new Windows community members. PR-URL: https://github.com/nodejs/node/pull/10686 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
2017-01-09doc: update BUILDING.mdLukasz Gasior
Added a note about Visual Studio 2015 feature which should be installed for building Node.js source code. PR-URL: https://github.com/nodejs/node/pull/10669 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
2016-12-22doc: clarify macosx-firewall suggestion BUILDINGChase Starr
`./tools/macosx-firewall.sh` fails if run before build step. Since the suggestion comes before the build steps in the document, this change clarifies that the script should be run after building. PR-URL: https://github.com/nodejs/node/pull/10311 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-12-18build: change nosign flag to sign and flips logicJoe Doyle
Makes the default build on Windows not try to sign the node.exe binary after a build. Instead the 'sign' flag now indicates that the binary should be signed. The 'nosign' flag is left as a noop. Reviewed-By: Nikolai Vavilov <vvnicholas@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: João Reis <reis@janeasystems.com> PR-URL: https://github.com/nodejs/node/pull/10156
2016-12-09doc: add note to parallelize makeJonathan Darling
Adds a note to the BUILDING doc to encourage parallelizing make. When I first built node I didn't know this trick and thought that the build was just stuck in an infinite loop after waiting for 10 minutes. Refs: https://github.com/nodejs/node/issues/8286 Refs: https://github.com/nodejs/node/pull/9881 PR-URL: https://github.com/nodejs/node/pull/9961 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
2016-12-09tools: add macosx-firwall script to avoid popupsDaniel Bevenius
Currently, there are a number of popups that get displayed when running the tests asking to accept incoming network connections. Rules can be added manually to the socket firewall on Mac OS X but getting this right might not be obvious and quite a lot of time can be wasted trying to get the rules right. This script hopes to simplify things a little so that it can be re-run when needed. The script should be runnable from both the projects root directory and from the tools directory, for example: $ sudo ./tools/macosx-firewall.sh Fixes: https://github.com/nodejs/node/issues/8911 PR-URL: https://github.com/nodejs/node/pull/10114 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2016-11-21tools: disallow trailing whitespace for markdownSam Roberts
markdown had a dispensation because 2 or more trailing spaces triggers a new paragraph. There are no examples of that usage in Node, all trailing whitespace found were mistakes, and the dispensation is now removed. See: https://github.com/nodejs/node/pull/9620 PR-URL: https://github.com/nodejs/node/pull/9676 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2016-11-20doc: fix typo in BUILDING.mdmonkick
e.g., to e.g. at BUILDING.md line 116 PR-URL: https://github.com/nodejs/node/pull/9569 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Shigeki Ohtsu <ohtsu@ohtsu.org> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-11-01doc: update OpenSSL linkskobelb
PR-URL: https://github.com/nodejs/node/pull/9338 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-09-28doc: remove failing workaround in BUILDING.mdChristopher Fujino
Updated BUILDING.md, removing workaround for Python conflicts that didn't work. PR-URL: https://github.com/nodejs/node/pull/8763 Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Bryan English <bryan@bryanenglish.com> Reviewed-By: James M Snell <jasnell@gmail.com> Refs: https://github.com/nodejs/node/pull/8763
2016-09-27doc: enable first-heading-level remark-lint ruleСковорода Никита Андреевич
This makes sure that the first heading in all markdown files is h1. Only three files needed to be changed to conform: 1. BUILDING.md 2. CODE_OF_CONDUCT.md 3. doc/onboarding-extras.md Also, .remarkrc is updated to include the `first-heading-level: 1` rule in order to catch similar issues in the future. PR-URL: https://github.com/nodejs/node/pull/8716 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2016-09-24doc: update BUILDING.mdrainabba
Added note about vcbuild being included as batch to clarify that it's not needed from msbuild tools or visual studio. PR-URL: https://github.com/nodejs/node/pull/8704 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2016-09-06doc: update BUILDING.mdRich Trott
* General copy-editing * Move `[sudo] make install` step from general Unix build to own step * Remove `make test-addons` as that is now covered by `make test` * Standardize on `/path/to/foo` as used elsewhere in the doc * Change `node -e` to `./node -e` to avoid using different node binary PR-URL: https://github.com/nodejs/node/pull/8398 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-08-12doc: update windows prerequisitesBen Noordhuis
Visual Studio 2013 is no longer supported. Update the Windows build prerequisites. Refs: https://github.com/nodejs/node/issues/7484 PR-URL: https://github.com/nodejs/node/pull/8049 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: João Reis <reis@janeasystems.com>
2016-08-04doc: *.md formatting fixes in the top-level dirСковорода Никита Андреевич
Continuing what a58b48bc3bcf43f7090d4cc914606af68fe55815 did for the doc/ dir, this fixes some formatting issues in the *.md files that are placed directly in the top-level directory. README.md changes are excluded as they are covered by https://github.com/nodejs/node/pull/7971 Refs: https://github.com/nodejs/node/pull/7637 PR-URL: https://github.com/nodejs/node/pull/7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-23doc: update build instructions for WindowsJoão Reis
The Visual C++ Build Tools are supported to build Node on Windows and already used in CI, so they should be included in the build instructions. Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> PR-URL: https://github.com/nodejs/node/pull/7285
2016-05-10build: add Make `doc-only` targetJesse McCarthy
Allows building just docs using existing Node instead of building Node first. PR-URL: https://github.com/nodejs/node/pull/3888 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com> Reviewed-By: Rod Vagg <rod@vagg.org> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
2016-05-09doc: add steps for running addons + npm testsMyles Borins
Currently we do not document how to run the test suite for native modules or for npm. This commit updates BUILDING.md with the information needed to do so. It includes a caveat about Node v4 and earlier requiring `make install` to be run before running the npm test suite. PR-URL: https://github.com/nodejs/node/pull/6231 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2016-05-04tools: Check in tools for shrinking ICU size, change default to small-icuSteven R. Loomis
* Change configure default to "small-icu" (Intl on, English only) * add "--without-intl" and "vcbuild without-intl" options, equivalent to --with-intl=none * update BUILDING.md with above changes * Checks in tools that generate the deps/icu-small source directory from ICU source * Tools and process for updating ICU documented in tools/icu/README.md Fixes: https://github.com/nodejs/node/issues/3476 PR-URL: https://github.com/nodejs/node/pull/6088 Reviewed-By: James M Snell <jasnell@gmail.com>
2016-04-28doc: update build instructions for OS XRich Trott
Building Node.js on OS X requires XCode (because node-gyp requires XCode). Add that information to BUILDING.md. Additionally, this changes references to `Macintosh` in BUILDING.md to refer to `OS X`. This is consistent with the way other references are to operating system families (`Unix`, `Windows`) and not brand names or hardware architectures. PR-URL: https://github.com/nodejs/node/pull/6309 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
2016-04-06doc: note about Android supportRich Trott
PR-URL: https://github.com/nodejs/node/pull/6040 Refs: https://github.com/nodejs/node/issues/6035 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
2016-03-14doc: move build instructions to a new documentJohan Bergström
This makes README.md easier to consume and likely less confusing for people that get it as part of a binary download. PR-URL: https://github.com/nodejs/node/pull/5634 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: James M Snell <jasnell@gmail.com>
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-23 16:44:48 +0000