Differential D28724

Update manpage for AMD 10GbE driver
ClosedPublic
Actions

Authored by rajeshasp on Feb 17 2021, 4:21 AM.

Tags

None

Referenced Files

	Unknown Object (File)
	Tue, Nov 12, 8:29 PM

	Unknown Object (File)
	Sat, Nov 9, 2:39 AM

	Unknown Object (File)
	Wed, Nov 6, 11:35 AM

	Unknown Object (File)
	Wed, Nov 6, 11:35 AM

	Unknown Object (File)
	Sep 22 2024, 2:19 PM

	Unknown Object (File)
	Sep 5 2024, 2:51 PM

	Unknown Object (File)
	Sep 5 2024, 7:28 AM

	Unknown Object (File)
	Sep 5 2024, 5:14 AM

View All 81 Files

Subscribers

Contributor Reviews (src)

Details

Reviewers

vmaffione
gallatin

Group Reviewers

Commits

rG2845cb445f76: Update manpage for AMD 10GbE driver
rGec786886661a: Update manpage for AMD 10GbE driver

Summary

Removed the description above removed sysctl "single_fl"
Added the description for sysctl "link_workaround"

Test Plan

Verified no warnings with igor and mandoc

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

rajeshasp created this revision.Feb 17 2021, 4:21 AM

Herald added a reviewer: manpages. · View Herald TranscriptFeb 17 2021, 4:21 AM

Herald added subscribers: Contributor Reviews (src), imp. · View Herald Transcript

rajeshasp requested review of this revision.Feb 17 2021, 4:21 AM

Harbormaster completed remote builds in B37083: Diff 84063.Feb 17 2021, 4:21 AM

rajeshasp added reviewers: vmaffione, gallatin.Feb 17 2021, 4:22 AM

yuripv added a subscriber: yuripv.Feb 17 2021, 8:39 AM

yuripv added inline comments.

share/man/man4/axp.4
150	This should be documented in LOADER TUNABLES section then.
155–156
161–162
161–162	This sentence should be first in description.
161–162	This seems to be redundant and stating obvious.
161–162
170	Let's name it consistently.
173	It was already said that it is workaround.

It may also help to use these commands (available on freefall) to look for style issues

$ mandoc -Tlint manpage.8
$ igor manpage.8

@vmaffione, I have used igor and mandoc to ensure no warnings before submitting the patch. I have informed the same in Test plan section

share/man/man4/axp.4
150	Added LOADER TUNABLES section and moved this variable there.
161–162	Removed these two lines.

Addressed review comments on v1 patch

Harbormaster completed remote builds in B37151: Diff 84182.Feb 18 2021, 7:32 AM

gallatin added inline comments.Feb 18 2021, 2:58 PM

share/man/man4/axp.4
167–168	I would rephrase to remove the word "test". Perhaps something like "To use netmap with this device, split header support must be disabled (set this variable to 0)"

Addressed comments on V2 patch

Harbormaster completed remote builds in B37174: Diff 84238.Feb 19 2021, 4:06 AM

@vmaffione, @gallatin and @yuripv,

Comments so far has been addressed. Please let me know if there are any other comments.

vmaffione accepted this revision.Feb 19 2021, 7:02 AM

This revision is now accepted and ready to land.Feb 19 2021, 7:02 AM

gallatin accepted this revision.Feb 19 2021, 2:49 PM

Also LGTM from manpages.

Thanks everyone for accepting the changes.

Closed by commit rGec786886661a: Update manpage for AMD 10GbE driver (authored by rajeshasp). · Explain WhyFeb 24 2021, 5:04 AM

This revision was automatically updated to reflect the committed changes.

rajeshasp added a commit: rGec786886661a: Update manpage for AMD 10GbE driver.

rajeshasp added a commit: rG2845cb445f76: Update manpage for AMD 10GbE driver.Mar 3 2021, 6:59 PM

Revision Contents
Changeset List

Path

Size

share/

man/

man4/

69 lines

Diff 84598

share/man/man4/axp.4

Loading...