Skip to content

serial: RS485 kerneldoc/documentation improvements

Ilpo Järvinen linux-doc linux-serial lkml 5 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v5 Latest5 patches 1 replyIn review
  2. v44 patches 1 replySuperseded
  3. v34 patches 7 repliesSuperseded
Earlier versions · 2
VersionPostedPatchesRepliesStatus
v21 patch3 repliesSuperseded
v11 patch1 replySuperseded

Changes in v5 from the cover letter

- Make formatting of names more consistent
- serial_rs485::flags bits are: -> The flag bits are:

Patches in v5 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/5serial: Convert serial_rs485 to kernel docDocumentation/driver-api/serial/serial-rs485.rst include/uapi/linux/serial.h+43 -250 replies
2/5Documentation: rs485: Link reference properlyDocumentation/driver-api/serial/serial-rs485.rst+4 -40 replies
3/5Documentation: rs485: Mention uart_get_rs485_mode()Documentation/driver-api/serial/serial-rs485.rst+4 -30 replies
4/5Documentation: rs485: Fix struct referencingDocumentation/driver-api/serial/serial-rs485.rst+11 -100 replies
5/5Documentation: Make formatting consistent for rs485 docsDocumentation/driver-api/serial/serial-rs485.rst+19 -180 replies

Reviews trailers per patch

4 of 5 patches have a Reviewed-by or Acked-by of their own; the series has one for all of them.

PatchAndy ShevchenkoBagas Sanjaya
SeriesR-b
1/5R-b
2/5R-b
3/5R-b
4/5R-b
5/5

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v5 thread

Cover letter [PATCH v5 0/5] serial: RS485 kerneldoc/documentation improvements

RS485 documentation improvements. While doing the kerneldoc conversion, a few other items came up so they're now included in this series.

v5:
- Make formatting of names more consistent
- serial_rs485::flags bits are: -> The flag bits are:

v4:
- Remove wrong private: markers
- Fix grammar problems

v3:
- More fixes to kernel doc formatting (thanks to Jiri)
- Added a few other related improvements

v2:
- Include serial_rs485 into documentation
- Add * to multi-line flag descriptions

Ilpo Järvinen (5):
serial: Convert serial_rs485 to kernel doc
Documentation: rs485: Link reference properly
Documentation: rs485: Mention uart_get_rs485_mode()
Documentation: rs485: Fix struct referencing
Documentation: Make formatting consistent for rs485 docs

 .../driver-api/serial/serial-rs485.rst        | 56 ++++++++++---------
 include/uapi/linux/serial.h                   | 55 +++++++++++-------
 2 files changed, 66 insertions(+), 45 deletions(-)
Signature · 1 line
2.30.2