Page MenuHomeFreeBSD
Differential D10278

create man page for etherswitch driver
ClosedPublic
Actions

Authored by yamori813_yahoo.co.jp on Apr 5 2017, 2:30 AM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Dec 14, 2:23 PM
Unknown Object (File)
Nov 25 2024, 11:43 AM
Unknown Object (File)
Nov 24 2024, 2:40 AM
Unknown Object (File)
Nov 12 2024, 11:16 AM
Unknown Object (File)
Nov 1 2024, 2:56 AM
Unknown Object (File)
Oct 29 2024, 7:33 PM
Unknown Object (File)
Oct 25 2024, 4:04 PM
Unknown Object (File)
Oct 19 2024, 1:40 AM
View All 100 Files
Subscribers
bcr
emaste

Details

Reviewers
mizhka
adrian
Group Reviewers
manpages
Commits
rS317867: [etherswitch] add manpages for etherswitch supported devices.
Summary

make e6060sw, adm6996fc, ksz8995ma man page

Diff Detail

Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 8544
Build 8851: arc lint + arc unit

Event Timeline

yamori813_yahoo.co.jp created this revision.Apr 5 2017, 2:30 AM
yamori813_yahoo.co.jp added a reviewer: manpages.Apr 5 2017, 2:36 AM
bcr added a subscriber: bcr.Apr 5 2017, 7:54 AM

Thank you for writing these man pages. I added some corrections. It seems like a lot, but they can be easily fixed.
You should install textproc/igor and run it over thes man pages. It will show you where the errors are and suggests fixes. When there are no more errors reported, you can create a new patch and update this review.
Thanks again.

share/man/man4/adm6996fc.4
43–55

You need to have a hard line break after the sentence stop (after chip).
Also, I would rephrase the next sentence to this:
This driver uses the smi interface of the ethernet interface. (Not sure what you mean by "by ethernet interface").

45

This driver supports port and dot1q vlan. Also, line break after the sentence stop.

47

Configure dot1q vlan with the etherswitchcfg command.

51

Configure port 5 as the tagging port.

share/man/man4/e6060sw.4
43–57

Another line break here after the sentence stop.

45

88E6060 supports only the vlan port. Line break after that sentence.
88E6065 supports port and dot1q vlan. Another line break.
dot1q supports group based tag/untag.

47

Configure dot1q vlan on 88E6065 with the etherswitchcfg command.

51

Yet another line break between the two sentences.
Also: This example is using port0 as vlan 2.

share/man/man4/ksz8995ma.4
43–56

Line break between the sentences. The second sentence should be:
This driver uses the spi interface.

45

This driver supports port and dot1q vlan. Line break.
dot1q supports port based tag/untag. (Same as in the other man page above).

47

Same as in the other man pages.

51

is => as the

yamori813_yahoo.co.jp updated this revision to Diff 27085.Apr 5 2017, 8:33 AM
  • review refict
Harbormaster completed remote builds in B8524: Diff 27085.Apr 5 2017, 8:33 AM
yamori813_yahoo.co.jp added a comment.Apr 5 2017, 8:36 AM

I use igor tools and fixed all error. Thnaks.

adrian accepted this revision.Apr 5 2017, 5:38 PM

thanks!

This revision is now accepted and ready to land.Apr 5 2017, 5:38 PM
yamori813_yahoo.co.jp updated this revision to Diff 27120.Apr 5 2017, 11:22 PM
yamori813_yahoo.co.jp edited edge metadata.
  • change spibus and add vertion infomation
This revision now requires review to proceed.Apr 5 2017, 11:22 PM
Harbormaster completed remote builds in B8544: Diff 27120.Apr 5 2017, 11:22 PM
yamori813_yahoo.co.jp updated this revision to Diff 27121.Apr 5 2017, 11:24 PM
  • fixed igor error
mizhka accepted this revision.Apr 13 2017, 3:06 PM
This revision is now accepted and ready to land.Apr 13 2017, 3:06 PM
emaste added a subscriber: emaste.Apr 18 2017, 3:28 PM
emaste added inline comments.
share/man/man4/adm6996fc.4
43–55

to /the/ Infineon

44

Can you explain further? Is the case here that adm6996fc is connected by SMI to some (other) Ethernet interface in the system, and configured over SMI?

Also, should expand acronym on first use, e.g. the Serial Management Interface (SMI)
Ethernet should have a capital E

yamori813_yahoo.co.jp added a comment.Apr 19 2017, 6:23 AM

Mavell e6060 datasheet use SMI word. That is MDC/MDIO. But Infineon data sheet not use SMI work. Do I change "MDC/MDIO interface" from "SMI". I want say difference i2c or spi bus.

adrian added a comment.May 6 2017, 5:56 AM

hi,

This is .. doing git like things to try and find /copies/ from th eoriginal source files, so the diff as downloaded doesn't work :(

Closed by commit rS317867: [etherswitch] add manpages for etherswitch supported devices. (authored by adrian). · Explain WhyMay 6 2017, 6:01 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathSize
share/
man/
man4/
adm6996fc.4
etherswitch.4
57 lines
e6060sw.4
etherswitch.4
59 lines
5 lines
ksz8995ma.4
etherswitch.4
58 lines

Diff 27120

View Options

share/man/man4/adm6996fc.4

Loading...
View Options

share/man/man4/e6060sw.4

Loading...
View Options

share/man/man4/etherswitch.4

Loading...
View Options

share/man/man4/ksz8995ma.4

Loading...