Skip to content

Modernise all (most) remaining .TH manpages#12125

Closed
nabijaczleweli wants to merge 17 commits intoopenzfs:masterfrom
nabijaczleweli:new-old-stock
Closed

Modernise all (most) remaining .TH manpages#12125
nabijaczleweli wants to merge 17 commits intoopenzfs:masterfrom
nabijaczleweli:new-old-stock

Conversation

@nabijaczleweli
Copy link
Copy Markdown
Contributor

@nabijaczleweli nabijaczleweli commented May 26, 2021 •
edited
Loading

Motivation and Context

What if manpages, but stronger?

Description

See individual messages for what happened beside that.

One thing that might be of particular import is that I moved

Developed at Lawrence Livermore National Laboratory (LLNL-CODE-403049)

in zed.8 from the trailer to the comment at the top.
Not sure what the laboratory's requirements on this stanza are.

These are left:

How Has This Been Tested?

Looked at'em

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)

Checklist:

@nabijaczleweli nabijaczleweli changed the title Modernise all (most) remaining manpages Modernise all (most) remaining .TH manpages May 26, 2021
@ghost
Copy link
Copy Markdown

ghost commented May 26, 2021

Here's a fun test: find man -type f -name '*[1-9]*' -exec mandoc -Tlint {} \+
I'm not sure if any of that relates to your changes, it's quite a list though 😅

@ghost ghost added Status: Code Review Needed Ready for review and testing Type: Documentation Indicates a requested change to the documentation labels May 26, 2021
@nabijaczleweli
Copy link
Copy Markdown
Contributor Author

nabijaczleweli commented May 26, 2021 •
edited
Loading

I was about to say that that's weird and it passes mancheck for me, but apparently mancheck is only run on man8 :v

@nabijaczleweli
Copy link
Copy Markdown
Contributor Author

nabijaczleweli commented May 26, 2021

Fixed my new pages (mostly minor things that didn't affect rendered output much if at all, it's not as bad as you'd think from the error log, heh) and widened mancheck to catch all of man (and the test runner), seems that all other pages were already clean; thanks for the heads-up!

@behlendorf
Copy link
Copy Markdown
Contributor

behlendorf commented May 26, 2021

It looks like the mancheck target is setting -Werror as well and only checking for errors. Is seems there's a bunch of additional STYLE and WARNING issues reported as well. Well, one step at a time it'll be nice to check all the manages for ERRORS.

@nabijaczleweli
Copy link
Copy Markdown
Contributor Author

nabijaczleweli commented May 26, 2021 •
edited
Loading

Ah, hm. Good point; I'll beat down the warnings down to the default level on the all-new pages, we can drop the minimum level on the existing ones in mancheck later (but it's gonna be very dirty, considering the main WARNING is "new sentence, new line").

@nabijaczleweli
Copy link
Copy Markdown
Contributor Author

nabijaczleweli commented May 26, 2021 •
edited
Loading

Okay, beside outdated mandoc.db and referenced manual not found, these are the WARNINGs that remain in the new pages and zgenhostid:

mandoc: man/man1/zhack.1:35:2: WARNING: sections out of conventional order: Sh SYNOPSIS
mandoc: man/man8/zinject.8:38:2: WARNING: sections out of conventional order: Sh SYNOPSIS

Since they use a subcommand-forward layout. I've added them to the head comments, and will make use of those in an improved variant of mancheck.

@nabijaczleweli nabijaczleweli mentioned this pull request May 27, 2021
Closed
13 tasks
@ghost
Copy link
Copy Markdown

ghost commented May 27, 2021

Please s/sexoin/section/ in one of the commit messages.

@nabijaczleweli
Copy link
Copy Markdown
Contributor Author

nabijaczleweli commented May 27, 2021

Done

@ghost ghost mentioned this pull request May 28, 2021
Closed
13 tasks
@nabijaczleweli nabijaczleweli mentioned this pull request May 29, 2021
Closed
13 tasks
@nabijaczleweli
ztest.1: modernise
16129ff 
I fixed a few typos, but avoided changing anything beyond that;
the sould of the document should be preserved

Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
arcstat.1: modernise
7b9abf8 
Also slim down the description a tad

Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
fsck.zfs.8: modernise
92aa210 
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
zpoolprops.8: fix spacing in ashift
12d02c1 
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
raidz_test.1: modernise
3a6e6f3 
Also re-add articles left out by the slav who wrote this

Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
zinject.8: modernise
d4c1483 
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
@nabijaczleweli
zpool_influxdb.8: modernise
fd156ab 
Also rip out the section about potentially including in the OpenZFS
distribution and simplify -e description

Signed-off-by: Ahelenia Ziemiańska <[email protected]>
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 3, 2021
@nabijaczleweli @behlendorf
cstyle.1: modernise
f809e8c 
Also remove note about the OS/Net consolidation, now the illumos gate

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 3, 2021
@nabijaczleweli @behlendorf
zed.8: modernise
c122a3b 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 3, 2021
@nabijaczleweli @behlendorf
man: use Nm/Cm/Fl consistently
31b63cf 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 3, 2021
@nabijaczleweli @behlendorf
vdev_id.conf.5: modernise
928c53b 
Also yeet pci_slot since it doesn't seem to exist?

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 3, 2021
@nabijaczleweli @behlendorf
zfs-events.5: modernise
6f1fffc 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 3, 2021
@nabijaczleweli @behlendorf
test-runner.1: modernise
a65cc18 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 3, 2021
@nabijaczleweli @behlendorf
Widen mancheck to all of man and test-runner
e1b481e 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 3, 2021
@nabijaczleweli @behlendorf
ztest.1: modernise
1c7466d 
I fixed a few typos, but avoided changing anything beyond that;
the sould of the document should be preserved

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
zgenhostid.8: use single-line indent macro for single-line examples
30ebb3f 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
ztest.1: modernise
a2725cd 
I fixed a few typos, but avoided changing anything beyond that;
the sould of the document should be preserved

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
arcstat.1: modernise
8c5e8ca 
Also slim down the description a tad

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
fsck.zfs.8: modernise
d9bd4d7 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
zpoolprops.8: fix spacing in ashift
f4a889a 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
raidz_test.1: modernise
6c21ba7 
Also re-add articles left out by the slav who wrote this

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
zinject.8: modernise
34a4dc3 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
zpool_influxdb.8: modernise
32439c0 
Also rip out the section about potentially including in the OpenZFS
distribution and simplify -e description

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
zhack.1: modernise
b00209c 
The spacing on zhack    feature stat    pool is a bit iffy(?)

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
vdev_id.8: modernise, note scsi topology
8ab0a2e 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
cstyle.1: modernise
625f844 
Also remove note about the OS/Net consolidation, now the illumos gate

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
zed.8: modernise
ba11095 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
man: use Nm/Cm/Fl consistently
0d17895 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
vdev_id.conf.5: modernise
f460d3e 
Also yeet pci_slot since it doesn't seem to exist?

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
zfs-events.5: modernise
ffce48a 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
test-runner.1: modernise
8bb2888 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 8, 2021
@nabijaczleweli @behlendorf
Widen mancheck to all of man and test-runner
a33ccf7 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 9, 2021
@nabijaczleweli @behlendorf
zgenhostid.8: use single-line indent macro for single-line examples
8ed0462 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 9, 2021
@nabijaczleweli @behlendorf
ztest.1: modernise
68a310d 
I fixed a few typos, but avoided changing anything beyond that;
the sould of the document should be preserved

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 9, 2021
@nabijaczleweli @behlendorf
arcstat.1: modernise
a037205 
Also slim down the description a tad

Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 9, 2021
@nabijaczleweli @behlendorf
fsck.zfs.8: modernise
55b6d4a 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
behlendorf pushed a commit to behlendorf/zfs that referenced this pull request Jun 9, 2021
@nabijaczleweli @behlendorf
zpoolprops.8: fix spacing in ashift
5d08b10 
Reviewed-by: Brian Behlendorf <[email protected]>
Signed-off-by: Ahelenia Ziemiańska <[email protected]>
Closes openzfs#12125
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@behlendorf behlendorf behlendorf approved these changes

Assignees

@tonynguien tonynguien

Labels

Status: Accepted Ready to integrate (reviewed, tested) Type: Documentation Indicates a requested change to the documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@nabijaczleweli @behlendorf @tonynguien