Page MenuHomeFreeBSD

14.2 Release HW Notes: cleanup keyboard/pointing
ClosedPublic

Authored by ziaee on Nov 22 2024, 2:57 AM.
Tags
None
Referenced Files
F109792388: D47699.id147143.diff
Sun, Feb 9, 2:31 PM
Unknown Object (File)
Wed, Feb 5, 7:21 PM
Unknown Object (File)
Wed, Feb 5, 11:19 AM
Unknown Object (File)
Tue, Feb 4, 7:12 AM
Unknown Object (File)
Wed, Jan 29, 2:50 AM
Unknown Object (File)
Wed, Jan 29, 2:42 AM
Unknown Object (File)
Sun, Jan 26, 12:13 AM
Unknown Object (File)
Sat, Jan 25, 3:41 PM
Subscribers

Details

Summary

For the Release HW Note template and 14.2:
Move keyboards and pointing devices to the top of the Misc section.
Remove inaccurate architecture limitation labels. Fill them in a bit,
and note that human input devices are in Misc in the USB section,
and clean those up a little.

Looking at past HW release notes, these architecture limitation labels
appear to come from 7.0R when all the different hardware architecture
release notes were merged. Back then, this section said:
[amd64, i386, ia64, pc98]. I assume ia64 and pc98 were dropped as they
were dropped, and that is why amd64 and i386 remained.

This commit removes FAX-Modem/PCCARD (requested by emaste).

Reported by: cperciva, emaste, wulf
Reported by: Ronald Klop <ronald-lists@klop.ws>

If this is acceptable, please git commit --amend --author="Alexander Ziaee <concussious@runbox.com>" so that I can demonstrate my activity. Thanks!

Test Plan

% cd website; make DOC_LANG=en; firefox public/releases/14.2R/hardware/index.html

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

ziaee requested review of this revision.Nov 22 2024, 2:57 AM
ziaee created this revision.

If there's favor in continuing this work. these also please:

https://reviews.freebsd.org/D47637
https://reviews.freebsd.org/D47566
https://reviews.freebsd.org/D47564

Getting the fictitious entries out of the way first gives a lot more freedom to add or restructure reasonably, and keeps me busy with simpler more "intern" work, and the leaves the bigger "decisions" to people who might dislike someone so junior making them, or have better ideas.

ziaee retitled this revision from Release HW Notes: cleanup keyboard/pointing to 14.2 Release HW Notes: cleanup keyboard/pointing.Nov 22 2024, 3:16 AM
ziaee edited the summary of this revision. (Show Details)
website/content/en/releases/14.2R/hardware.adoc
4478–4479

Supported HID backends are: USB, I2C and Apple SPi

4482

+ HyperV keyboards (hv_kbd, no man)

4507–4508

Supported HID backends are: USB, I2C, HyperV and Apple SPi

4509

wsp(4) is better supported for now than apt(4)

4511

+ ELAN I2C touchpads ietp(4)
+ Cypress I2C touchpads cyapa(4)

emaste added inline comments.
website/content/en/releases/14.2R/hardware.adoc
3869

We should make this (type of) change in website/archetypes/release/hardware.adoc at the same time.

4724–4728

We should just delete this

We should make this (type of) change in website/archetypes/release/hardware.adoc at the same time.

How far should we go with this? I prefer to remove the fictitious entries from all the release notes they didn't ship in (Ok'd by cperciva), limited back to FreeBSD 12 at Warner's request. I've been doing them one at a time with (what I hope is) a proper history in the commit log. Can I do that in this one commit?

IMO it's most important to get the notes into shape for 14.2, and archetypes must receive the same change. (Ideally we would have updated archetypes just before creating the 14.2 notes.) I wouldn't bother changing the old release notes for these. Removing references to drivers that were excised from the tree long ago makes sense, but not for reordering the sections etc.

ziaee edited the summary of this revision. (Show Details)

+ add content reported by wulf
+ remove content reported by emaste
+ update the template the same way
(Thanks!)
+ remove joy(4)

Can I, in this commit, add the supported gamepads? I'm thinking below pointing devices.

Here are proper commits removing mse(4) and joy(4). If those are good then I can remove it from this commit message, which would make me feel more hygienic about this.

https://reviews.freebsd.org/D47702
https://reviews.freebsd.org/D47703

Is there a way that I can look and see if $foo is actually [amd64, i386] only? I suspect that most of these are fictitious, but some of them are obviously not. The git log on the HW Relnotes template only goes back two years.

Rebased, this time I just started at the top of Misc instead of moving the other stuff out of the way.

Oops, typo (capitalization).

ziaee edited the test plan for this revision. (Show Details)

I think everything in scope in this commit is done.

Humble ping? I feel it's time for me to get started on 13.5 hw notes.

May I please commit this or change something?

Approved. The improvements are straightforward. Code owners/page maintainers have had their chance to give feedback. Thanks for your patience.

website/content/en/releases/14.2R/hardware.adoc
3903

Tweaks like this are useful and correct "while here", but it is obviously beyond the scope of the proposed change (keyboard/pointing).

There is no use in changing it now, but just keep in mind that the more unrelated things you modify in a single commit, the more taxing it becomes to review. Sometimes, these extraneous tweaks are what makes the difference between something that is easily understood and accepted, or just fuzzy enough that the reviewer loses interest.

I am speaking generally, more than about this commit specifically. I think you've done the right thing here. Myself, I am guilty of being on both sides of it this type of thing.

4510

Should it be "SPI"?

This revision is now accepted and ready to land.Fri, Feb 7, 3:49 PM