From 5af4822d1cd67ee034aa294a32c30af4bcd4458a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Rodr=C3=ADguez=20Baquero?= Date: Sun, 17 Dec 2017 21:46:37 -0500 Subject: [PATCH 1/4] tools: fix man pages linking regex The change to word boundary was breaking many doc pages. This reverts the word boundary back to space. Fixes: https://github.com/nodejs/node/issues/17637 Fixes: https://github.com/nodejs/node/issues/17694 Refs: https://github.com/nodejs/node/pull/17479 --- tools/doc/html.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/doc/html.js b/tools/doc/html.js index f2d3fcdbba6860..1c44c5f7d3c239 100644 --- a/tools/doc/html.js +++ b/tools/doc/html.js @@ -416,7 +416,7 @@ const BSD_ONLY_SYSCALLS = new Set(['lchmod']); // 'open(2)' function linkManPages(text) { return text.replace( - /\b([a-z.]+)\((\d)([a-z]?)\)/gm, + / ([a-z.]+)\((\d)([a-z]?)\)/gm, (match, name, number, optionalCharacter) => { // name consists of lowercase letters, number is a single digit const displayAs = `${name}(${number}${optionalCharacter})`; From fa42177743ef26832669bf648f6e5a4ef1f055fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Rodr=C3=ADguez=20Baquero?= Date: Tue, 19 Dec 2017 16:27:32 -0500 Subject: [PATCH 2/4] tools: fix man pages linking regex The change to word boundary was breaking many doc pages. This replace the word boundary with a matching group of space or beginning of line. Fixes: https://github.com/nodejs/node/issues/17637 Fixes: https://github.com/nodejs/node/issues/17694 Refs: https://github.com/nodejs/node/pull/17479 --- tools/doc/html.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tools/doc/html.js b/tools/doc/html.js index 1c44c5f7d3c239..acea7475c9bf57 100644 --- a/tools/doc/html.js +++ b/tools/doc/html.js @@ -416,10 +416,10 @@ const BSD_ONLY_SYSCALLS = new Set(['lchmod']); // 'open(2)' function linkManPages(text) { return text.replace( - / ([a-z.]+)\((\d)([a-z]?)\)/gm, - (match, name, number, optionalCharacter) => { + /(^|\s)([a-z.]+)\((\d)([a-z]?)\)/gm, + (match, beginning, name, number, optionalCharacter) => { // name consists of lowercase letters, number is a single digit - const displayAs = `${name}(${number}${optionalCharacter})`; + const displayAs = `${beginning}${name}(${number}${optionalCharacter})`; if (BSD_ONLY_SYSCALLS.has(name)) { return ` ${displayAs}`; From b8499564953c1175356862142f5803101cbde5a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Rodr=C3=ADguez=20Baquero?= Date: Tue, 19 Dec 2017 16:32:29 -0500 Subject: [PATCH 3/4] tools: remove space in man pages returned link --- tools/doc/html.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/doc/html.js b/tools/doc/html.js index acea7475c9bf57..d206788677c2a6 100644 --- a/tools/doc/html.js +++ b/tools/doc/html.js @@ -421,10 +421,10 @@ function linkManPages(text) { // name consists of lowercase letters, number is a single digit const displayAs = `${beginning}${name}(${number}${optionalCharacter})`; if (BSD_ONLY_SYSCALLS.has(name)) { - return ` ${displayAs}`; } else { - return ` ${displayAs}`; } }); From 34a9db09feb952b5ae64356c0a2bbb557fcd1b43 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Rodr=C3=ADguez=20Baquero?= Date: Wed, 20 Dec 2017 11:31:27 -0500 Subject: [PATCH 4/4] tools: move beginning regex matching group This moves the beginning regex matching group to the beginning of the resulting HTML man pages link --- tools/doc/html.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tools/doc/html.js b/tools/doc/html.js index d206788677c2a6..f2e7ed396b7cc4 100644 --- a/tools/doc/html.js +++ b/tools/doc/html.js @@ -419,12 +419,12 @@ function linkManPages(text) { /(^|\s)([a-z.]+)\((\d)([a-z]?)\)/gm, (match, beginning, name, number, optionalCharacter) => { // name consists of lowercase letters, number is a single digit - const displayAs = `${beginning}${name}(${number}${optionalCharacter})`; + const displayAs = `${name}(${number}${optionalCharacter})`; if (BSD_ONLY_SYSCALLS.has(name)) { - return `${displayAs}`; } else { - return `${displayAs}`; } });