Page MenuHomeFreeBSD

amdsmu.4: Canonicalize SYNOPSIS and HARDWARE
ClosedPublic

Authored by ziaee on Wed, Sep 16, 6:41 PM.
Tags
None
Referenced Files
F173065313: D59738.diff
Wed, Sep 23, 7:44 AM
F173041357: D59738.id186905.diff
Wed, Sep 23, 2:40 AM
F172991872: D59738.id.diff
Tue, Sep 22, 5:05 PM
Unknown Object (File)
Tue, Sep 22, 1:12 PM
Unknown Object (File)
Tue, Sep 22, 2:13 AM
Unknown Object (File)
Sun, Sep 20, 5:02 AM
Unknown Object (File)
Sat, Sep 19, 12:11 AM
Unknown Object (File)
Fri, Sep 18, 11:04 PM
Subscribers

Details

Summary

HARDWARE will allow us to list this in the hardware release note, and no
prose in SYNOPSIS. Also, you have your license format all mixed up :P

MFC after: no

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

ziaee requested review of this revision.Wed, Sep 16, 6:42 PM
share/man/man4/amdsmu.4
15

We could also list a ton of stuff here, but I feel like nobody really wants that (please correct me if I'm wrong). Also we have the precedent of omitting overly long usage throughout all mansects with things like "$command <options>"

Also, you have your license format all mixed up :P

how so?

This revision is now accepted and ready to land.Wed, Sep 16, 6:59 PM

Also, you have your license format all mixed up :P

how so?

style.9 and the license guide show it backwards from what you have, like this:

.\"
.\" Copyright (c) 2026 The FreeBSD Foundation
.\"
.\" SPDX-License-Identifier: BSD-2-Clause
.\"
.\" This software was developed by Aymeric Wibo <obiwac@freebsd.org>
.\" under sponsorship from the FreeBSD Foundation.
.\"

Also with a blank comment line at the beginning for consistency with C style comments.

This revision was automatically updated to reflect the committed changes.

style.9 and the license guide show it backwards from what you have, like this:

ah, i didn't know this ended up being added to style in the end

i still don't think it's better that way, because it puts the SPDX identifier far from the top when there's a lot of copyright information