| 9e5f399f | 28-Jul-2022 |
Jiri Slaby <[email protected]> |
tty: serial: document uart_get_console()
This was the only function mentioned in the text, but was neither linked nor documented. So document and link it, so that hyperlinking works in the text.
Si
tty: serial: document uart_get_console()
This was the only function mentioned in the text, but was neither linked nor documented. So document and link it, so that hyperlinking works in the text.
Signed-off-by: Jiri Slaby <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Greg Kroah-Hartman <[email protected]>
show more ...
|
| 987233b3 | 28-Jul-2022 |
Jiri Slaby <[email protected]> |
tty: serial: serial_core, reformat kernel-doc for functions
There are many annotated functions in serial_core.c, but they do not completely conform to the kernel-doc style. So reformat them and link
tty: serial: serial_core, reformat kernel-doc for functions
There are many annotated functions in serial_core.c, but they do not completely conform to the kernel-doc style. So reformat them and link them from the Documentation.
Signed-off-by: Jiri Slaby <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Greg Kroah-Hartman <[email protected]>
show more ...
|
| d34d7c4b | 28-Jul-2022 |
Jiri Slaby <[email protected]> |
Documentation: serial: link uart_ops properly
The syntax to reference a struct in text is "struct XY". So reference uart_ops properly, so that hyperlinks work.
Signed-off-by: Jiri Slaby <jslaby@sus
Documentation: serial: link uart_ops properly
The syntax to reference a struct in text is "struct XY". So reference uart_ops properly, so that hyperlinks work.
Signed-off-by: Jiri Slaby <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Greg Kroah-Hartman <[email protected]>
show more ...
|
| 27940abd | 28-Jul-2022 |
Jiri Slaby <[email protected]> |
Documentation: serial: move GPIO kernel-doc to the functions
The GPIO uart functions are documented in Documentation. Move and transform this documentation into kernel-doc directly in the code and r
Documentation: serial: move GPIO kernel-doc to the functions
The GPIO uart functions are documented in Documentation. Move and transform this documentation into kernel-doc directly in the code and reference it in Documentation using kernel-doc:.
This makes it easier to update, maintain and check by the build.
Signed-off-by: Jiri Slaby <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Greg Kroah-Hartman <[email protected]>
show more ...
|
| c4bd17a6 | 28-Jul-2022 |
Jiri Slaby <[email protected]> |
Documentation: serial: dedup kernel-doc for uart functions
Some of the serial (uart_*) functions are documented twice. Once as kernel-doc along their sources and once in Documentation. So deduplicat
Documentation: serial: dedup kernel-doc for uart functions
Some of the serial (uart_*) functions are documented twice. Once as kernel-doc along their sources and once in Documentation. So deduplicate these texts, merge them into kernel-doc in the sources, and link them using kernel-doc: from the Documentation.
To be properly linked and rendered, tabulators had to be removed from the comments.
Signed-off-by: Jiri Slaby <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Greg Kroah-Hartman <[email protected]>
show more ...
|
| 5b437ae9 | 11-Apr-2022 |
Jiri Slaby <[email protected]> |
Documentation: tty: move moxa-smartio.rst to tty
It is a tty_driver, not serial -- uart_driver. So move it to the tty docs dir too. (The same as the driver itself.)
Signed-off-by: Jiri Slaby <jslab
Documentation: tty: move moxa-smartio.rst to tty
It is a tty_driver, not serial -- uart_driver. So move it to the tty docs dir too. (The same as the driver itself.)
Signed-off-by: Jiri Slaby <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Greg Kroah-Hartman <[email protected]>
show more ...
|
| e2659503 | 11-Apr-2022 |
Jiri Slaby <[email protected]> |
Documentation: tty: move n_gsm to tty
We have n_tty documented in Documentation/driver-api/tty/. n_gsm belongs there too, so move from serial/ to tty/ too.
Signed-off-by: Jiri Slaby <[email protected]
Documentation: tty: move n_gsm to tty
We have n_tty documented in Documentation/driver-api/tty/. n_gsm belongs there too, so move from serial/ to tty/ too.
Signed-off-by: Jiri Slaby <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Greg Kroah-Hartman <[email protected]>
show more ...
|
| 4072254f | 26-Nov-2021 |
Jiri Slaby <[email protected]> |
tty: reformat tty_struct::flags into kernel-doc
Move the partial tty_struct::flags documentation from tty_ldisc to the tty.h header and combine it with the one-liners present there. Convert all thos
tty: reformat tty_struct::flags into kernel-doc
Move the partial tty_struct::flags documentation from tty_ldisc to the tty.h header and combine it with the one-liners present there. Convert all those to kernel-doc. This way, we can simply reference the documentation in Documentation while the text is still along the definitions.
Signed-off-by: Jiri Slaby <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Greg Kroah-Hartman <[email protected]>
show more ...
|