Page MenuHomeFreeBSD

asmc.4: clean up/modernize manpage
Needs RevisionPublic

Authored by ngie on Sun, Sep 6, 10:28 PM.
Tags
None
Referenced Files
F170997263: D59470.id186097.diff
Tue, Sep 8, 2:23 AM
F170995426: D59470.id186095.diff
Tue, Sep 8, 2:08 AM
F170994924: D59470.id186096.diff
Tue, Sep 8, 2:03 AM
F170983628: D59470.id186095.diff
Tue, Sep 8, 12:29 AM
F170963926: D59470.id186097.diff
Mon, Sep 7, 9:44 PM
F170962257: D59470.id186081.diff
Mon, Sep 7, 9:31 PM
F170922705: D59470.id186096.diff
Mon, Sep 7, 3:10 PM
F170894505: D59470.id186096.diff
Mon, Sep 7, 9:34 AM

Details

Reviewers
ziaee
Group Reviewers
manpages
Summary
  • sysutils/ataidle is no more: it was superseded by camcontrol(8).
  • Sort the models table alphabetically.
  • Use the SPDX License ID instead of the longhand licensing tort in the manpage header.
  • Note that the driver has been heavily modified in 15.1 and later to support additional platforms and functionality.
  • Trim down SYNOPSIS.

MFC after: 2 weeks

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped
Build Status
Buildable 76621
Build 73504: arc lint + arc unit

Event Timeline

ngie requested review of this revision.Sun, Sep 6, 10:28 PM
share/man/man4/asmc.4
34–35

I don't like this degree of handwaving in the documentation. I need to figure out a) why this doesn't work on my MacBookPro 13,1 (T1 Mac) and b) try running this on my MacBookPro 16,1 (T2 Mac) system.

116–117

typo: park

Use .Pa when describing ada0 to match other manpage examples

Be more direct in the hardware section, like requested in D59467

ziaee requested changes to this revision.Mon, Sep 7, 10:02 PM
ziaee added a subscriber: rpaulo.

Ah, thank you so much for doing this! I've been fixing the SYNOPSIS and HARDWARE one at a time :P

share/man/man4/asmc.4
3

We can not remove or change existing text, unless @rpaulo approves the commit. The shortened license is the preferred text for new files only. Although sometimes I pester the authors for existing text because it has typos in the license and is causing me headaches :)

I'll see if we can ping him while you're on vacation though, the short license form is quite beautiful and useful.

12

Nm and Nd are always rendered together, so asmc as an acronym is already established.

155

While here, macros in list width specifiers is cursed. It renders as -1 spaces in some implementations and circumstances.

This revision now requires changes to proceed.Mon, Sep 7, 10:02 PM
share/man/man4/asmc.4
3

That not true .

A License text ca be compacted at the maintainer's discretion, as long as the actual license terms are not changed.

What you cannot do is remove copyright holders, change attribution requirements, or upgrade/downgrade the license without permission.

The license was replaced by 'SPDX-License-Identifier: BSD-2-Clause' which is the same.

There are also plenty of cases where asking the original author is simply impossible because they left the project, disappeared, or passed away. Requiring approval just to replace equivalent boilerplate with an SPDX identifier would make this kind of cleanup impossible forever.

Source: I got my own verbose MIT/GPL license compacted in 20+ projects by other maintainers without anyone pinging me first.

share/man/man4/asmc.4
3

That sounds very obviously reasonable to me, however I have been advised by members of the current core team that I can not. In any case, Rui is around, I just saw him on IRC just the other day.

share/man/man4/asmc.4
3

Fair.

Maybe the reason for that rule is to avoid commits that only go around cleaning up license text everywhere, basically like running a linter over the whole source tree and creating noise.

But when a file is already being rewritten, I think compacting the existing license to the equivalent SPDX identifier as part of that rewrite should be fine.