Page MenuHomeFreeBSD
Differential D25939

gpiokeys: add a basic manual page
ClosedPublic
Actions

Authored by avg on Aug 4 2020, 6:22 AM.
Tags
None
Referenced Files
Unknown Object (File)
Feb 21 2024, 2:39 AM
Unknown Object (File)
Feb 21 2024, 2:39 AM
Unknown Object (File)
Feb 21 2024, 2:39 AM
Unknown Object (File)
Dec 22 2023, 10:36 AM
Unknown Object (File)
Dec 22 2023, 10:36 AM
Unknown Object (File)
Dec 22 2023, 10:32 AM
Unknown Object (File)
Dec 20 2023, 4:51 AM
Unknown Object (File)
Nov 9 2023, 8:32 AM
View All 44 Files
Subscribers
0mp
bcr
bjk
imp

Details

Reviewers
gonzo
manu
bjk
0mp
Group Reviewers
manpages
Commits
rS363905: gpiokeys: add a basic manual page
Summary

A man page.

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 32745
Build 30186: arc lint + arc unit

Event Timeline

avg created this revision.Aug 4 2020, 6:22 AM
Herald added a reviewer: manpages. · View Herald TranscriptAug 4 2020, 6:22 AM
Herald added a subscriber: imp. · View Herald Transcript
avg requested review of this revision.Aug 4 2020, 6:22 AM
Harbormaster completed remote builds in B32737: Diff 75338.Aug 4 2020, 6:22 AM
bcr added a subscriber: bcr.Aug 4 2020, 6:42 AM

The man page looks good. Can you check it with "mandoc -Tlint" and textproc/igor and see if they give you any warnings?
Thanks for writing that man page.

bjk added a subscriber: bjk.Aug 4 2020, 6:44 AM

I agree with Benedict -- the man page looks very good on first read!

share/man/man4/gpiokeys.4
71

I expect mandoc -Tlint to complain about an argument to .Nm here.

avg added a comment.Aug 4 2020, 6:57 AM

Thank you for the reviews!
igor was happy, but mandoc complained about the order of cross-references.

avg marked an inline comment as done.Aug 4 2020, 6:58 AM
avg added inline comments.
share/man/man4/gpiokeys.4
71

Actually, it didn't.
I'll fix this.

avg updated this revision to Diff 75342.Aug 4 2020, 6:59 AM
avg marked an inline comment as done.

address reviews and complaints from mandoc -Tlint

Harbormaster completed remote builds in B32741: Diff 75342.Aug 4 2020, 6:59 AM
bjk accepted this revision.Aug 4 2020, 7:01 AM
This revision is now accepted and ready to land.Aug 4 2020, 7:01 AM
0mp accepted this revision.Aug 4 2020, 7:56 AM
0mp added a subscriber: 0mp.

LGTM!

(I was wondering if it would be better to put properties description into a list, but the manual page looks fine as it is now.)

manu added inline comments.Aug 4 2020, 9:04 AM
share/man/man4/gpiokeys.4
61

This sounds weird to me, I think that s/FDT/DTS/ would sound better.

99

Mhm, I didn't knew we still had this.
It's an old file that might not be accurate anymore and we don't import the dt-bindings files, maybe we should, I've been saying for a long time that they would be useful to reference in a manpage ...

avg marked an inline comment as done.Aug 4 2020, 9:24 AM
avg added inline comments.
share/man/man4/gpiokeys.4
61

Okay.

99

I took this from from gpioled(4).
If you can make a suggestion on how to improve this part, please do.
Maybe it is acceptable that this manual page will be improved later.
I did not have a hope of writing a perfect man page since I am very new to this driver and FDT and GPIO.
But I thought that having some page would be a good start and better than nothing.

avg updated this revision to Diff 75345.Aug 4 2020, 9:26 AM
avg marked an inline comment as done.

s/FDT/DTS/ for clarity

This revision now requires review to proceed.Aug 4 2020, 9:26 AM
Harbormaster completed remote builds in B32743: Diff 75345.Aug 4 2020, 9:26 AM
manu accepted this revision.Aug 4 2020, 9:27 AM
manu added inline comments.
share/man/man4/gpiokeys.4
99

Yeah we can improve later, this is way better that what we currently have :)

This revision is now accepted and ready to land.Aug 4 2020, 9:27 AM
avg added inline comments.Aug 4 2020, 9:29 AM
share/man/man4/gpiokeys.4
99

BTW, that document seems to have a fairly accurate, if a bit vague, description of the gpios property\

avg updated this revision to Diff 75347.Aug 4 2020, 10:12 AM

I misunderstood the code: "name" property is used to get the node name
if "label" property is not set.

This revision now requires review to proceed.Aug 4 2020, 10:12 AM
Harbormaster completed remote builds in B32745: Diff 75347.Aug 4 2020, 10:12 AM
This revision was not accepted when it landed; it landed in state Needs Review.Aug 5 2020, 11:38 AM
Closed by commit rS363905: gpiokeys: add a basic manual page (authored by avg). · Explain Why
This revision was automatically updated to reflect the committed changes.
avg added a commit: rS363905: gpiokeys: add a basic manual page.

Revision Contents
Changeset List

PathSize
share/
man/
man4/
152 lines

Diff 75347

View Options

share/man/man4/gpiokeys.4

Loading...