7b1c56e0 | 19-Oct-2022 |
Ilpo Järvinen <ilpo.jarvinen@linux.intel.com> |
Documentation: Make formatting consistent for rs485 docs
Tweak styling of names that come directly from the code.
Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com> Reviewed-by: Bagas Sanjaya <baga
Documentation: Make formatting consistent for rs485 docs
Tweak styling of names that come directly from the code.
Suggested-by: Bagas Sanjaya <bagasdotme@gmail.com> Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com> Link: https://lore.kernel.org/r/20221019093343.9546-6-ilpo.jarvinen@linux.intel.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
show more ...
|
891e9993 | 19-Oct-2022 |
Ilpo Järvinen <ilpo.jarvinen@linux.intel.com> |
Documentation: rs485: Fix struct referencing
Use "struct serial_rs485" to get the references properly recognized.
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com> Reviewed-by: Bagas Sanjaya
Documentation: rs485: Fix struct referencing
Use "struct serial_rs485" to get the references properly recognized.
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com> Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com> Link: https://lore.kernel.org/r/20221019093343.9546-5-ilpo.jarvinen@linux.intel.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
show more ...
|
0f4648a1 | 19-Oct-2022 |
Ilpo Järvinen <ilpo.jarvinen@linux.intel.com> |
Documentation: rs485: Mention uart_get_rs485_mode()
Add to rs485 documentation that serial core prepares the struct serial_rs485 when uart_get_rs485_mode() is called. Remove the wrong claim that the
Documentation: rs485: Mention uart_get_rs485_mode()
Add to rs485 documentation that serial core prepares the struct serial_rs485 when uart_get_rs485_mode() is called. Remove the wrong claim that the driver must fill it by itself.
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com> Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com> Link: https://lore.kernel.org/r/20221019093343.9546-4-ilpo.jarvinen@linux.intel.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
show more ...
|
851453ab | 19-Oct-2022 |
Ilpo Järvinen <ilpo.jarvinen@linux.intel.com> |
Documentation: rs485: Link reference properly
Link DT bindings reference properly.
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com> Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-
Documentation: rs485: Link reference properly
Link DT bindings reference properly.
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com> Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com> Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com> Link: https://lore.kernel.org/r/20221019093343.9546-3-ilpo.jarvinen@linux.intel.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
show more ...
|
9e5f399f | 28-Jul-2022 |
Jiri Slaby <jslaby@suse.cz> |
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 <jslaby@suse.cz> Link: https://lore.kernel.org/r/20220728061056.20799-6-jslaby@suse.cz Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
show more ...
|
987233b3 | 28-Jul-2022 |
Jiri Slaby <jslaby@suse.cz> |
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 <jslaby@suse.cz> Link: https://lore.kernel.org/r/20220728061056.20799-5-jslaby@suse.cz Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
show more ...
|
d34d7c4b | 28-Jul-2022 |
Jiri Slaby <jslaby@suse.cz> |
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 <jslaby@suse.cz> Link: https://lore.kernel.org/r/20220728061056.20799-4-jslaby@suse.cz Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
show more ...
|
27940abd | 28-Jul-2022 |
Jiri Slaby <jslaby@suse.cz> |
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 <jslaby@suse.cz> Link: https://lore.kernel.org/r/20220728061056.20799-3-jslaby@suse.cz Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
show more ...
|
c4bd17a6 | 28-Jul-2022 |
Jiri Slaby <jslaby@suse.cz> |
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 <jslaby@suse.cz> Link: https://lore.kernel.org/r/20220728061056.20799-2-jslaby@suse.cz Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
show more ...
|
5b437ae9 | 11-Apr-2022 |
Jiri Slaby <jslaby@suse.cz> |
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 <jslaby@suse.cz> Link: https://lore.kernel.org/r/20220411110143.10019-5-jslaby@suse.cz Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
show more ...
|
e2659503 | 11-Apr-2022 |
Jiri Slaby <jslaby@suse.cz> |
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 <jslaby@suse.cz
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 <jslaby@suse.cz> Link: https://lore.kernel.org/r/20220411110143.10019-4-jslaby@suse.cz Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
show more ...
|
7e6c0b22 | 26-Nov-2021 |
Jiri Slaby <jslaby@suse.cz> |
tty: move tty_ldisc docs to new Documentation/tty/
Create a new directory in Documentation/ called tty. We will create more documents in it in the next patches, so let's have this one in the very sa
tty: move tty_ldisc docs to new Documentation/tty/
Create a new directory in Documentation/ called tty. We will create more documents in it in the next patches, so let's have this one in the very same place.
Change title accordingly and all the headers. This is the way what other documents look like in this directory in the next patches. So make this unified.
And add a TOC.
Signed-off-by: Jiri Slaby <jslaby@suse.cz> Link: https://lore.kernel.org/r/20211126081611.11001-20-jslaby@suse.cz Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
show more ...
|
4072254f | 26-Nov-2021 |
Jiri Slaby <jslaby@suse.cz> |
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 <jslaby@suse.cz> Link: https://lore.kernel.org/r/20211126081611.11001-10-jslaby@suse.cz Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
show more ...
|
40f4268c | 26-Nov-2021 |
Jiri Slaby <jslaby@suse.cz> |
tty: combine tty_ldisc_ops docs into kernel-doc
In Documentation/driver-api/serial/tty.rst, there are duplicated texts about some struct tty_ldisc_ops' hooks. Combine them into existing kernel-doc c
tty: combine tty_ldisc_ops docs into kernel-doc
In Documentation/driver-api/serial/tty.rst, there are duplicated texts about some struct tty_ldisc_ops' hooks. Combine them into existing kernel-doc comments of struct tty_ldisc_ops and drop them from the Documentation/.
Signed-off-by: Jiri Slaby <jslaby@suse.cz> Link: https://lore.kernel.org/r/20211126081611.11001-9-jslaby@suse.cz Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
show more ...
|