Skip to content

Commit f21edb3

Browse files
committed
docs: add env var description
1 parent cc39c9e commit f21edb3

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

tools/make/lib/install/addons.mk

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,18 @@ install_node_addons_list_addons_flags := "--pattern $(node_addons_pattern)"
5555
#
5656
# ## Notes
5757
#
58-
# - If unable to install a native add-on, the target prints an error message and proceeds to try installing the next add-on.
58+
# - When `FAST_FAIL` is `0`, if unable to install a native add-on, the recipe prints an error message and proceeds to try installing the next add-on.
59+
#
60+
# @param {integer} [FAST_FAIL] - flag indicating whether to immediately exit if unable to install a native add-on (default: 1)
5961
#
6062
# @example
6163
# make install-node-addons
64+
#
65+
# @example
66+
# FAST_FAIL=0 make install-node-addons
67+
#
68+
# @example
69+
# FAST_FAIL=1 make install-node-addons
6270
#/
6371
install-node-addons: $(NODE_MODULES) clean-node-addons
6472
ifeq ($(FAIL_FAST), true)
@@ -96,8 +104,20 @@ endif
96104
#/
97105
# Removes all compiled and generated files for Node.js native add-ons.
98106
#
107+
# ## Notes
108+
#
109+
# - When `FAST_FAIL` is `0`, if unable to clean a native add-on, the recipe prints an error message and proceeds to try cleaning the next add-on.
110+
#
111+
# @param {integer} [FAST_FAIL] - flag indicating whether to immediately exit if unable to clean a native add-on (default: 1)
112+
#
99113
# @example
100114
# make clean-node-addons
115+
#
116+
# @example
117+
# FAST_FAIL=0 make clean-node-addons
118+
#
119+
# @example
120+
# FAST_FAIL=1 make clean-node-addons
101121
#/
102122
clean-node-addons: $(NODE_MODULES)
103123
ifeq ($(FAIL_FAST), true)

0 commit comments

Comments
 (0)