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

Jump to bottom

tools,doc: better manpage refs #9632

Closed

addaleax wants to merge 2 commits into nodejs:master from addaleax:doc-manpage-refs

Member

addaleax commented Nov 16, 2016 •

edited

Loading

Minor doc cleanup to make the doctool emit manpage references in more cases where it’s appropriate:

tools: use better regexp for manpage references:
In practice, manpage names may contain dots (e.g. resolv.conf(5)) ~~but can only have a section in the range 1–9 as opposed to 0–9~~.
doc: remove backtick escaping for manpage refs:
Removing backticks will make the doctool emit links to the man pages.

nodejs-github-bot added the tools label

addaleax added the doc label

bnoordhuis approved these changes

View reviewed changes

Member

bnoordhuis left a comment

LGTM although man0 is a thing on some systems; e.g., man aio.h comes from man0p.

addaleax force-pushed the doc-manpage-refs branch from 1f6ef7e to d8e77ec Compare

November 16, 2016 16:25

Member Author

addaleax commented Nov 16, 2016

@bnoordhuis Thanks, I didn’t know that – I’ve undone that change and kept it as \d.

Fishrock123 approved these changes

View reviewed changes

jasnell approved these changes

View reviewed changes

addaleax added 2 commits

November 18, 2016 21:54


          tools: use better regexp for manpage references

In practice, manpage names may contain dots (e.g. `resolv.conf(5)`).

PR-URL: nodejs#9632
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>


          doc: remove backtick escaping for manpage refs

04ad631

Removing backticks will make the doctool emit links to the man pages.

PR-URL: nodejs#9632
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

addaleax force-pushed the doc-manpage-refs branch from d8e77ec to 04ad631 Compare

November 18, 2016 21:03

Member Author

addaleax commented Nov 18, 2016

CI: https://ci.nodejs.org/job/node-test-commit/6072/

targos approved these changes

View reviewed changes

lpinca approved these changes

View reviewed changes

Member Author

addaleax commented Nov 19, 2016 •

edited

Loading

Landed in 79c3827, 8a6b37b. Thanks for reviewing! (edit: force-pushed)

addaleax closed this

addaleax deleted the doc-manpage-refs branch

November 19, 2016 23:55

addaleax added a commit that referenced this pull request


          tools: use better regexp for manpage references

79c3827

In practice, manpage names may contain dots (e.g. `resolv.conf(5)`).

PR-URL: #9632
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

addaleax added a commit that referenced this pull request


          doc: remove backtick escaping for manpage refs

8a6b37b

Removing backticks will make the doctool emit links to the man pages.

PR-URL: #9632
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

addaleax added a commit that referenced this pull request


          tools: use better regexp for manpage references

29bf871

In practice, manpage names may contain dots (e.g. `resolv.conf(5)`).

PR-URL: #9632
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

addaleax added a commit that referenced this pull request


          doc: remove backtick escaping for manpage refs

39f0482

Removing backticks will make the doctool emit links to the man pages.

PR-URL: #9632
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

MylesBorins pushed a commit that referenced this pull request


          tools: use better regexp for manpage references

fd6b305

In practice, manpage names may contain dots (e.g. `resolv.conf(5)`).

PR-URL: #9632
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

MylesBorins pushed a commit that referenced this pull request


          doc: remove backtick escaping for manpage refs

4f2e254

Removing backticks will make the doctool emit links to the man pages.

PR-URL: #9632
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

MylesBorins pushed a commit that referenced this pull request


          tools: use better regexp for manpage references

0256b7b

In practice, manpage names may contain dots (e.g. `resolv.conf(5)`).

PR-URL: #9632
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

MylesBorins pushed a commit that referenced this pull request


          doc: remove backtick escaping for manpage refs

7a02eb2

Removing backticks will make the doctool emit links to the man pages.

PR-URL: #9632
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

MylesBorins added land-on-v4.x labels

MylesBorins pushed a commit that referenced this pull request


          tools: use better regexp for manpage references

ad20889

In practice, manpage names may contain dots (e.g. `resolv.conf(5)`).

PR-URL: #9632
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

MylesBorins pushed a commit that referenced this pull request


          doc: remove backtick escaping for manpage refs

03f3519

Removing backticks will make the doctool emit links to the man pages.

PR-URL: #9632
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

MylesBorins pushed a commit that referenced this pull request


          tools: use better regexp for manpage references

4c8933d

In practice, manpage names may contain dots (e.g. `resolv.conf(5)`).

PR-URL: #9632
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

MylesBorins pushed a commit that referenced this pull request


          doc: remove backtick escaping for manpage refs

54b4c81

Removing backticks will make the doctool emit links to the man pages.

PR-URL: #9632
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

This was referenced Dec 21, 2016

V6.9.3 proposal #10394

Merged

V4.7.1 proposal #10395

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

targos targos approved these changes

lpinca lpinca approved these changes

Fishrock123 Fishrock123 approved these changes

jasnell jasnell approved these changes

bnoordhuis bnoordhuis approved these changes

Labels

doc tools