ice.4: Editorial pass
AbandonedPublic
Actions

Authored by ziaee on Tue, Nov 4, 11:22 PM.

Details

Reviewers

Group Reviewers

manpages
Intel Networking

Commits

rGf30335c5cb5e: ice.4: Add ToC and E835 and editorial pass

Summary

Sorry, Intel networking, this is way too big of a diff, but the hardware
release notes is currently broken on this file and its easiest to do
these things all at once. I think the final output is a lot easier too.

+ Move supported adapters into HARDWARE
+ Move subsections about the hardware into DESCRIPTION
+ Strip unnecessary copyright symbols which choke up HW Relnotes
+ Strip escaped hyphens, while we're stripping unnecessary characters
+ Make a Table of Contents so I can pull off the above without breakage
+ Adjust subsection names to be compatible with linked table of contents

MFC after: Before Friday

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Build Status

Buildable 68435
Build 65318: arc lint + arc unit

Event Timeline

ziaee created this revision.Tue, Nov 4, 11:22 PM

Herald added a subscriber: imp. · View Herald TranscriptTue, Nov 4, 11:22 PM

ziaee requested review of this revision.Tue, Nov 4, 11:22 PM

Harbormaster completed remote builds in B68424: Diff 165850.Tue, Nov 4, 11:22 PM

ziaee added a reviewer: Intel Networking.Tue, Nov 4, 11:22 PM

Reading though it again, I will merge this tonight with my suggested change unless there are objections.

share/man/man4/ice.4
926–958	For Find in Page `Intel 800`

Thank you! LGTM

I added recently device ids for E835 adapters (https://reviews.freebsd.org/D52782),
but man syntax is still a kind of dark magic to me. Would you mind adding them to the list?

This revision is now accepted and ready to land.Wed, Nov 5, 8:19 PM

In D53592#1223700, @kgalazka wrote:

Thank you! LGTM

Don't thank me, thank @erj, he is the hero who provided this content for our community!

I added recently device ids for E835 adapters (https://reviews.freebsd.org/D52782),
but man syntax is still a kind of dark magic to me. Would you mind adding them to the list?

Yes, happy to. I also hacked on this a bit more while I was in a meeting, but now I had to step into the datacenter.

It's really massively better if this is done in the same commit as the hardware support is added, because then the commit an atomic idea. That can really help downstream and with things like bisection. Otherwise we have one commit introducing a doc bug, and then another commit fixing that bug.

(try to merge diff, that was accidentally made against stable/15, and
the imperative tone patch was not backported)

This revision now requires review to proceed.Wed, Nov 5, 10:06 PM

Harbormaster completed remote builds in B68435: Diff 165909.Wed, Nov 5, 10:06 PM

ziaee abandoned this revision.Wed, Nov 5, 10:45 PM

ziaee added a commit: rGf30335c5cb5e: ice.4: Add ToC and E835 and editorial pass.