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

man: fix wrong .Xr macros usages #11845

Merged
merged 1 commit into from
Apr 6, 2021
Merged

Conversation

gmelikov
Copy link
Member

@gmelikov gmelikov commented Apr 5, 2021

In addition, html doc will have working hyperlinks.

Signed-off-by: George Melikov mail@gmelikov.ru

Motivation and Context

Wrong .Xr usage leads to not working links in html doc, for ex. look at zpoolprops in https://openzfs.github.io/openzfs-docs/man/8/zpool-import.8.html?highlight=zpoolprops

How Has This Been Tested?

mandoc -W all doesn't have warnings about .Xr macros.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Performance enhancement (non-breaking change which improves efficiency)
  • Code cleanup (non-breaking change which makes code smaller or more readable)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Library ABI change (libzfs, libzfs_core, libnvpair, libuutil and libzfsbootenv)
  • Documentation (a change to man pages or other documentation)

In addition, html doc will have working hyperlinks.

Signed-off-by: George Melikov <mail@gmelikov.ru>
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

Wonderful! It would be nice to get these man pages in shape for passing mandoc -Tlint in CI, eventually.

@behlendorf behlendorf added the Status: Accepted Ready to integrate (reviewed, tested) label Apr 6, 2021
@behlendorf behlendorf merged commit d35708b into openzfs:master Apr 6, 2021
behlendorf pushed a commit that referenced this pull request Apr 7, 2021
In addition, html doc will have working hyperlinks.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: George Melikov <mail@gmelikov.ru>
Closes #11845
mcmilk pushed a commit to mcmilk/zfs that referenced this pull request Apr 9, 2021
In addition, html doc will have working hyperlinks.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: George Melikov <mail@gmelikov.ru>
Closes openzfs#11845
mcmilk pushed a commit to mcmilk/zfs that referenced this pull request Apr 9, 2021
In addition, html doc will have working hyperlinks.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: George Melikov <mail@gmelikov.ru>
Closes openzfs#11845
adamdmoss pushed a commit to adamdmoss/zfs that referenced this pull request Apr 10, 2021
In addition, html doc will have working hyperlinks.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: George Melikov <mail@gmelikov.ru>
Closes openzfs#11845
ghost pushed a commit to truenas/zfs that referenced this pull request May 6, 2021
In addition, html doc will have working hyperlinks.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: George Melikov <mail@gmelikov.ru>
Closes openzfs#11845
ghost pushed a commit to truenas/zfs that referenced this pull request May 6, 2021
In addition, html doc will have working hyperlinks.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: George Melikov <mail@gmelikov.ru>
Closes openzfs#11845
ghost pushed a commit to truenas/zfs that referenced this pull request May 6, 2021
In addition, html doc will have working hyperlinks.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: George Melikov <mail@gmelikov.ru>
Closes openzfs#11845
ghost pushed a commit to truenas/zfs that referenced this pull request May 7, 2021
In addition, html doc will have working hyperlinks.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: George Melikov <mail@gmelikov.ru>
Closes openzfs#11845
ghost pushed a commit to truenas/zfs that referenced this pull request May 10, 2021
In addition, html doc will have working hyperlinks.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: George Melikov <mail@gmelikov.ru>
Closes openzfs#11845
ghost pushed a commit to truenas/zfs that referenced this pull request May 10, 2021
In addition, html doc will have working hyperlinks.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: George Melikov <mail@gmelikov.ru>
Closes openzfs#11845
ghost pushed a commit to truenas/zfs that referenced this pull request May 10, 2021
In addition, html doc will have working hyperlinks.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: George Melikov <mail@gmelikov.ru>
Closes openzfs#11845
ghost pushed a commit to truenas/zfs that referenced this pull request May 13, 2021
In addition, html doc will have working hyperlinks.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: George Melikov <mail@gmelikov.ru>
Closes openzfs#11845
behlendorf pushed a commit that referenced this pull request May 20, 2021
In addition, html doc will have working hyperlinks.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: George Melikov <mail@gmelikov.ru>
Closes #11845
sempervictus pushed a commit to sempervictus/zfs that referenced this pull request May 31, 2021
In addition, html doc will have working hyperlinks.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: George Melikov <mail@gmelikov.ru>
Closes openzfs#11845
tonyhutter pushed a commit that referenced this pull request Jun 23, 2021
In addition, html doc will have working hyperlinks.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Ryan Moeller <ryan@iXsystems.com>
Signed-off-by: George Melikov <mail@gmelikov.ru>
Closes #11845
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Accepted Ready to integrate (reviewed, tested)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants