Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

em.4: add igb to name section #1134

Closed
wants to merge 1 commit into from
Closed

Conversation

concussious
Copy link
Contributor

@concussious concussious commented Mar 6, 2024

Improving first-glance comprehension that this manual page applies to igb/lem interfaces provided by the em(4) driver.

While here, tag SPDX and shuffle a sentence to fix linter warning.

Change inspired by new users on IRC erroneously looking for em0 interface for their I211 NIC, and hilariously being told to use supported hardware.

@concussious concussious changed the title em.4: add igb0 to name macro em.4: add igb to name macro Mar 6, 2024
@concussious concussious changed the title em.4: add igb to name macro em.4: add igb to name section Mar 6, 2024
Copy link
Contributor

@mhorne mhorne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is good, but the page is also installed as "lem(4)". See the MLINKS in share/man/man4/Makefile. So please add that to the name section too. (The if_-prefixed links don't need a .Nm entry, IMO).

Also, you should check instances of "lem" and "igb" strings in the page, some of them need markup.

Copy link
Contributor

@mhorne mhorne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, a couple more tweaks required.

share/man/man4/em.4 Outdated Show resolved Hide resolved
share/man/man4/em.4 Outdated Show resolved Hide resolved
@concussious
Copy link
Contributor Author

Sorry, a couple more tweaks required.

No need to apologize, thanks for helping me!

Improving first-glance comprehension that this manual page
applies to igb/lem interfaces provided by the em(4) driver.

While here, tag SPDX, link the framework, and
shuffle a sentence to fix linter warning.

Co-authored-by: Mitchell Horne <mhorne063@gmail.com>
freebsd-git pushed a commit that referenced this pull request Mar 21, 2024
Improving first-glance comprehension that this manual page applies to
igb/lem interfaces provided by the em(4) driver.

While here, tag SPDX, link the framework, and shuffle a sentence to fix
linter warning.

Co-authored-by: mhorne
Reviewed by:	mhorne
MFC after:	1 week
Pull Request:	#1134
@mhorne
Copy link
Contributor

mhorne commented Mar 21, 2024

Thanks! Pushed to main. You can close this PR (I can't).

@bsdimp
Copy link
Member

bsdimp commented Mar 21, 2024

Pushed to main

@bsdimp bsdimp closed this Mar 21, 2024
freebsd-git pushed a commit that referenced this pull request Apr 18, 2024
Improving first-glance comprehension that this manual page applies to
igb/lem interfaces provided by the em(4) driver.

While here, tag SPDX, link the framework, and shuffle a sentence to fix
linter warning.

Co-authored-by: mhorne
Reviewed by:	mhorne
MFC after:	1 week
Pull Request:	#1134

(cherry picked from commit 501f7e7)
@concussious concussious deleted the em.4 branch April 24, 2024 01:38
bsdjhb pushed a commit to bsdjhb/cheribsd that referenced this pull request Aug 5, 2024
Improving first-glance comprehension that this manual page applies to
igb/lem interfaces provided by the em(4) driver.

While here, tag SPDX, link the framework, and shuffle a sentence to fix
linter warning.

Co-authored-by: mhorne
Reviewed by:	mhorne
MFC after:	1 week
Pull Request:	freebsd/freebsd-src#1134
bsdjhb pushed a commit to bsdjhb/cheribsd that referenced this pull request Aug 6, 2024
Improving first-glance comprehension that this manual page applies to
igb/lem interfaces provided by the em(4) driver.

While here, tag SPDX, link the framework, and shuffle a sentence to fix
linter warning.

Co-authored-by: mhorne
Reviewed by:	mhorne
MFC after:	1 week
Pull Request:	freebsd/freebsd-src#1134
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants