mbox series

[v5,0/5] serial: RS485 kerneldoc/documentation improvements

Message ID 20221019093343.9546-1-ilpo.jarvinen@linux.intel.com
Headers
Series serial: RS485 kerneldoc/documentation improvements |

Message

Ilpo Järvinen Oct. 19, 2022, 9:33 a.m. UTC 
  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(-)

Comments

Bagas Sanjaya Oct. 20, 2022, 3:54 a.m. UTC | #1 
On Wed, Oct 19, 2022 at 12:33:38PM +0300, Ilpo Järvinen wrote:
> 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(-)
> 

The doc LGTM, thanks.

For the series,

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>