seq_buf: Fix kernel documentation
authorAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Thu, 15 Feb 2024 15:25:06 +0000 (17:25 +0200)
committerSteven Rostedt (Google) <rostedt@goodmis.org>
Thu, 15 Feb 2024 17:17:28 +0000 (12:17 -0500)
commit6efe4d18796934b8ada66c1c446510e7f2d9b972
tree69daa7168c9f9684e73ec6dffeb97ae3d0a89d05
parent8a566f94104df87a067458351675129bb4e1ece2
seq_buf: Fix kernel documentation

There are plenty of issues with the kernel documentation here:
  - misspelled word "sequence"
  - different style of returned value descriptions
  - missed Return sections
  - unaligned style of ASCII / NUL-terminated / etc
  - wrong function references

Fix all these.

Link: https://lkml.kernel.org/r/20240215152506.598340-1-andriy.shevchenko@linux.intel.com
Cc: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
include/linux/seq_buf.h
lib/seq_buf.c