Skip to content

tools,doc: fix 404 broken links in docs #27168

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.

Sign up for GitHub

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

Closed
07Gond wants to merge 3 commits into from
Closed

tools,doc: fix 404 broken links in docs #27168

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eecc04c
tools,doc: fix 404 broken links in docs
07Gond Apr 10, 2019
fdd3d16
Remove last else if
07Gond Apr 15, 2019
b6744e8
tools,doc: Fix lint and remove elses
07Gond Apr 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
tools,doc: fix 404 broken links in docs 
Change the linkManPages function to catch the uname and curl
correct websites on the docs page.

Fixes: #26074
  • Loading branch information
@07Gond
07Gond committed Apr 10, 2019
commit eecc04cc24207120035baa26cc93b8cb3b2d8279
12 changes: 10 additions & 2 deletions tools/doc/html.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@ function preprocessText() {

// Syscalls which appear in the docs, but which only exist in BSD / macOS.
const BSD_ONLY_SYSCALLS = new Set(['lchmod']);
const LINUX_DIE_ONLY_SYSCALLS = new Set(['uname']);
const HAXX_ONLY_SYSCALLS = new Set(['curl']);
const MAN_PAGE = /(^|\s)([a-z.]+)\((\d)([a-z]?)\)/gm;

// Handle references to man pages, eg "open(2)" or "lchmod(2)".
Expand All @@ -135,9 +137,15 @@ function linkManPages(text) {
if (BSD_ONLY_SYSCALLS.has(name)) {
return `${beginning}<a href="https://www.freebsd.org/cgi/man.cgi` +
`?query=${name}&sektion=${number}">${displayAs}</a>`;
} else if (LINUX_DIE_ONLY_SYSCALLS.has(name)) {
return `${beginning}<a href="https://linux.die.net/man/` +
`${number}/${name}">${displayAs}</a>`;
} else if (HAXX_ONLY_SYSCALLS.has(name)) {
Comment thread
07Gond marked this conversation as resolved.
Outdated
return `${beginning}<a href="https://${name}.haxx.se/docs/manpage.html">${displayAs}</a>`;
} else {
Comment thread
07Gond marked this conversation as resolved.
Outdated
return `${beginning}<a href="http://man7.org/linux/man-pages/man${number}` +
`/${name}.${number}${optionalCharacter}.html">${displayAs}</a>`;
}
return `${beginning}<a href="http://man7.org/linux/man-pages/man${number}` +
`/${name}.${number}${optionalCharacter}.html">${displayAs}</a>`;
});
}

Expand Down