Skip to content

Commit 695fe2f

Browse files
committed
line length
1 parent 82d9f2b commit 695fe2f

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ To install, clone this repository into your `$(nodenv root)/plugins` directory.
1313

1414
node >= 4.0
1515

16-
Unlike virtually every other nodenv plugin, node-build-update-defs actually depends on node. (The scraper runs on node.) A somewhat recent version of node is required – it is recommended to configure a node-version within the plugin directory itself (substitute your chosen version):
16+
Unlike virtually every other nodenv plugin, node-build-update-defs actually depends on node.
17+
(The scraper runs on node.)
18+
A somewhat recent version of node is required – it is recommended to configure a node-version within the plugin directory itself (substitute your chosen version):
1719

1820
$ cd "$(nodenv root)"/plugins/node-build-update-defs
1921
$ nodenv local 4.0
@@ -22,23 +24,35 @@ Unlike virtually every other nodenv plugin, node-build-update-defs actually depe
2224

2325
$ nodenv update-version-defs
2426

25-
By default, this will create build definitions in the plugin's `share/node-build/` directory. This directory can be overridden with `--destination`.
27+
By default, this will create build definitions in the plugin's `share/node-build/` directory.
28+
This directory can be overridden with `--destination`.
2629

27-
Only definitions that aren't already in node-build's lookup path (`NODE_BUILD_DEFINITIONS`) will be created. That is, under typical usage only definitions not already shipped with node-build will be created. To override this and write definitions for *all* available node/io versions, use `--force`. (This will overwrite any conflicting definition files that already exist in the destination directory.)
30+
Only definitions that aren't already in node-build's lookup path (`NODE_BUILD_DEFINITIONS`) will be created.
31+
That is, under typical usage only definitions not already shipped with node-build will be created.
32+
To override this and write definitions for *all* available node/io versions, use `--force`.
33+
(This will overwrite any conflicting definition files that already exist in the destination directory.)
2834

2935
### Special environment variables
3036

31-
- `NODE_BUILD_DEFINITIONS` can be a list of colon-separated paths that get additionally searched when looking up build definitions. All nodenv plugins' `share/node-build/` directories are appended to this path. Definitions already found in these paths will be skipped (unless `--force`).
37+
- `NODE_BUILD_DEFINITIONS` can be a list of colon-separated paths that get additionally searched when looking up build definitions.
38+
All nodenv plugins' `share/node-build/` directories are appended to this path.
39+
Definitions already found in these paths will be skipped (unless `--force`).
3240

3341
## Cleanup/Pruning
3442

35-
In normal operation, build definitions will gradually build up in this plugin's `share/node-build` directory (or elsewhere if overridden with `--destination`). Eventually, as the scraped definitions are added to node-build itself, these user-scraped definitions will become duplicates when their node-build installation is updated. In order to ensure one is frequently running on the "proper" build definitions from node-build, any duplicates in the plugin directory ought to be removed.
43+
In normal operation, build definitions will gradually build up in this plugin's `share/node-build` directory (or elsewhere if overridden with `--destination`).
44+
Eventually, as the scraped definitions are added to node-build itself, these user-scraped definitions will become duplicates when their node-build installation is updated.
45+
In order to ensure one is frequently running on the "proper" build definitions from node-build, any duplicates in the plugin directory ought to be removed.
3646

3747
$ nodenv prune-version-defs
3848

39-
This subcommand removes (or lists with `--dry-run`) any duplicate build definitions. Like `update-version-defs`, `--destination <dir>` overrides the default value of `<plugin-root>/share/node-build` as the directory from which duplicates are removed. Duplicates are searched for under `NODE_BUILD_DEFINITIONS` and are determined by both filename *and* contents. The file contents check can be overridden with `--force`, which will delete duplicates based solely on filename.
49+
This subcommand removes (or lists with `--dry-run`) any duplicate build definitions.
50+
Like `update-version-defs`, `--destination <dir>` overrides the default value of `<plugin-root>/share/node-build` as the directory from which duplicates are removed.
51+
Duplicates are searched for under `NODE_BUILD_DEFINITIONS` and are determined by both filename *and* contents.
52+
The file contents check can be overridden with `--force`, which will delete duplicates based solely on filename.
4053

41-
This subcommand is silent by default, only printing removed duplicates if `--verbose`. (`--dry-run` implies `--verbose`)
54+
This subcommand is silent by default, only printing removed duplicates if `--verbose`.
55+
(`--dry-run` implies `--verbose`)
4256

4357
[nodenv]: https://github.com/nodenv/nodenv
4458
[node-build]: https://github.com/nodenv/node-build

0 commit comments

Comments
 (0)