Update iic.4 to reflect new I2CSADDR ioctl and per-fd addressing state
Details
Details
- Reviewers
wblock imp - Commits
- rS282966: Update iic(4) man page to reflect recent changes
Made sure things looked sane w/ 'man ./iic.4'
Diff Detail
Diff Detail
- Repository
- rS FreeBSD src repository - subversion
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
Comment Actions
Run 'igor -R iic.4 | less -RS' (from textproc/igor) and 'mandoc -tlint iic.4' to check for various errors.
| share/man/man4/iic.4 | ||
|---|---|---|
| 28 ↗ | (On Diff #5226) | Remember to update this on commit. |
| 58 ↗ | (On Diff #5226) | Not your fault, but please fix this run-on, halting, comma-less sentence: A read operation is initiated when the read/write bit is set, or a write operation when it is cleared. |
| 60 ↗ | (On Diff #5226) | The new sentence should start on a new line. Use active voice when possible: If successful, this command acquires Can this sentence be simplified? There are a lot of trailing ofs and fors that make it kind of confusing. For example (maybe): If successful, exclusive ownership of the specified file descriptor's underlying iicbus instance is acquired. |
| 70 ↗ | (On Diff #5226) | Again, start a new sentence on a new line. |
| 72 ↗ | (On Diff #5226) | "the I2CSTART command" might be redundant here. It could be just ...succeed, |
| 78 ↗ | (On Diff #5226) | As above about "the I2CSTART command". "this command will" is passive. Consider: ...file descriptor, the current transaction is terminated and exclusive ownership of the underlying iicbus instance is released. |
| 80 ↗ | (On Diff #5226) | New sentence on a new line. Also, passive->active: Otherwise, no action is performed. |
| 87 ↗ | (On Diff #5226) | Good on not saying "the I2CSTART command"! (But new sentence on new line.) |
| 88 ↗ | (On Diff #5226) | "this command" and passive voice can be avoided: issued, exclusive ownership of the underlying iicbus instance is released. |
| 96 ↗ | (On Diff #5226) | "command" is not needed. Agreed that "must" is better than "should" here. |
| 116 ↗ | (On Diff #5226) | "command" not needed. |
| 136 ↗ | (On Diff #5226) | "the ... command" not needed. |
| 167 ↗ | (On Diff #5226) | s/Associates/Associate/ |
| 173 ↗ | (On Diff #5226) | "should" is a recommendation, not a requirement. But this is probably a requirement, and "is" or "must" are better for those: The argument is an 8-bit address (that is, a 7-bit address << 1). (i.e. and e.g. are academic things. Here, it probably should have been e.g., meaning "that is" rather than i.e.'s "for example". Best to avoid the Latin versions when possible.) |
| 212 ↗ | (On Diff #5226) | "the ... calls" can be removed: It is also possible to use |
| 224 ↗ | (On Diff #5226) | Passive->active: |
| 228 ↗ | (On Diff #5226) | .Dv I2CSADDR , |
| 229 ↗ | (On Diff #5226) | Passive->active: stops any transaction established by a not-yet-terminated (.Pq can be used for sections in parentheses, but they are asides which are best avoided.) |
| 235 ↗ | (On Diff #5226) | Start new sentence on new line. Also, passive->active: Concurrent transactions on those descriptors are |