Skip to content
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.

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

tools,doc: better manpage refs #9632

Closed
wants to merge 2 commits into from

Conversation

addaleax
Copy link
Member

@addaleax addaleax commented Nov 16, 2016

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 nodejs-github-bot added the tools Issues and PRs related to the tools directory. label Nov 16, 2016
@addaleax addaleax added the doc Issues and PRs related to the documentations. label Nov 16, 2016
Copy link
Member

@bnoordhuis bnoordhuis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@addaleax
Copy link
Member Author

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

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

PR-URL: nodejs#9632
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Removing backticks will make the doctool emit links to the man pages.

PR-URL: nodejs#9632
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@addaleax
Copy link
Member Author

@addaleax
Copy link
Member Author

addaleax commented Nov 19, 2016

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

@addaleax addaleax closed this Nov 19, 2016
@addaleax addaleax deleted the doc-manpage-refs branch November 19, 2016 23:55
addaleax added a commit that referenced this pull request Nov 19, 2016
In practice, manpage names may contain dots (e.g. `resolv.conf(5)`).

PR-URL: #9632
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
addaleax added a commit that referenced this pull request Nov 19, 2016
Removing backticks will make the doctool emit links to the man pages.

PR-URL: #9632
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
addaleax added a commit that referenced this pull request Nov 22, 2016
In practice, manpage names may contain dots (e.g. `resolv.conf(5)`).

PR-URL: #9632
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
addaleax added a commit that referenced this pull request Nov 22, 2016
Removing backticks will make the doctool emit links to the man pages.

PR-URL: #9632
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins pushed a commit that referenced this pull request Dec 20, 2016
In practice, manpage names may contain dots (e.g. `resolv.conf(5)`).

PR-URL: #9632
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins pushed a commit that referenced this pull request Dec 20, 2016
Removing backticks will make the doctool emit links to the man pages.

PR-URL: #9632
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins pushed a commit that referenced this pull request Dec 20, 2016
In practice, manpage names may contain dots (e.g. `resolv.conf(5)`).

PR-URL: #9632
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins pushed a commit that referenced this pull request Dec 20, 2016
Removing backticks will make the doctool emit links to the man pages.

PR-URL: #9632
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
In practice, manpage names may contain dots (e.g. `resolv.conf(5)`).

PR-URL: #9632
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
Removing backticks will make the doctool emit links to the man pages.

PR-URL: #9632
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
In practice, manpage names may contain dots (e.g. `resolv.conf(5)`).

PR-URL: #9632
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
Removing backticks will make the doctool emit links to the man pages.

PR-URL: #9632
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
This was referenced Dec 21, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants