linux-toradex.git/Documentation/driver-api/serial, branch v5.17-rc4

docs/driver-api: Replace a comma in the n_gsm.rst with a double colon

2021-12-21T09:18:36+00:00

Since b9e851cd4a87 ("tty: n_gsm: Add some instructions and code for requester") which
introduced a warning:

linux/Documentation/driver-api/serial/n_gsm.rst:23: WARNING: Definition list ends without a blank line; unexpected unindent.
linux/Documentation/driver-api/serial/n_gsm.rst:100: WARNING: Definition list ends without a blank line; unexpected unindent.
linux/Documentation/driver-api/serial/n_gsm.rst:115: WARNING: Inline emphasis start-string without end-string.
linux/Documentation/driver-api/serial/n_gsm.rst:118: WARNING: Inline emphasis start-string without end-string.
linux/Documentation/driver-api/serial/n_gsm.rst:120: WARNING: Inline emphasis start-string without end-string.
linux/Documentation/driver-api/serial/n_gsm.rst:122: WARNING: Inline emphasis start-string without end-string.
linux/Documentation/driver-api/serial/n_gsm.rst:125: WARNING: Inline emphasis start-string without end-string.
linux/Documentation/driver-api/serial/n_gsm.rst:139: WARNING: Inline emphasis start-string without end-string.

A paragraph consisting of two colons ("::") signifies that the following text block(s) comprise a literal block.
Add soome blank lines.

Signed-off-by: Yanteng Si 
Link: https://lore.kernel.org/r/20211209092439.562433-1-siyanteng@loongson.cn
Signed-off-by: Greg Kroah-Hartman

tty: move tty_ldisc docs to new Documentation/tty/

2021-11-26T15:27:43+00:00

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 
Link: https://lore.kernel.org/r/20211126081611.11001-20-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman

tty: reformat tty_struct::flags into kernel-doc

2021-11-26T15:27:42+00:00

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 
Link: https://lore.kernel.org/r/20211126081611.11001-10-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman

tty: combine tty_ldisc_ops docs into kernel-doc

2021-11-26T15:27:42+00:00

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 
Link: https://lore.kernel.org/r/20211126081611.11001-9-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman

tty: combine tty_operations triple docs into kernel-doc

2021-11-26T15:27:42+00:00

In Documentation/driver-api/serial/tty.rst, there are triplicated texts
about some struct tty_operations' hooks. Combine them into existing
kernel-doc comments of struct tty_operations and drop them from the
Documentation/.

Signed-off-by: Jiri Slaby 
Link: https://lore.kernel.org/r/20211126081611.11001-8-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman

tty: make tty_ldisc_ops::hangup return void

2021-09-22T14:59:13+00:00

The documentation says that the return value of tty_ldisc_ops::hangup
hook is ignored. And it really is, so there is no point for its return
type to be int. Switch it to void and all the hooks too.

Cc: Dmitry Torokhov 
Cc: Wolfgang Grandegger 
Cc: Marc Kleine-Budde 
Cc: "David S. Miller" 
Cc: Jakub Kicinski 
Cc: Paul Mackerras 
Cc: Liam Girdwood 
Cc: Mark Brown 
Cc: Jaroslav Kysela 
Cc: Takashi Iwai 
Cc: Peter Ujfalusi 
Acked-by: Dmitry Torokhov 
Acked-by: Mark Brown 
Acked-by: Marc Kleine-Budde 
Signed-off-by: Jiri Slaby 
Link: https://lore.kernel.org/r/20210914091134.17426-4-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman

tty: n_gsm: Add some instructions and code for requester

2021-09-14T08:50:27+00:00

The gsm driver can configure initiator or requester by parameter
initiator,but the config code and using are different ,the doc has
initiator instructions only,it should be add instructions for requester.

Signed-off-by: Zhenguo Zhao 
Link: https://lore.kernel.org/r/1629461872-26965-1-git-send-email-zhenguo6858@gmail.com
Signed-off-by: Greg Kroah-Hartman

mxser: Documentation, fix typos

2021-06-18T11:10:03+00:00

Fix some typos in the mxser's documentation.

Signed-off-by: Jiri Slaby 
Link: https://lore.kernel.org/r/20210618061516.662-70-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman

mxser: Documentation, make the docs up-to-date

2021-06-18T11:10:03+00:00

Remove all the obsolete information from the documentation of mxser
driver. Either it was about the out-of-tree driver, or it was superseded
by udev et al.

Signed-off-by: Jiri Slaby 
Link: https://lore.kernel.org/r/20210618061516.662-69-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman

mxser: Documentation, remove traces of callout device

2021-06-18T11:10:03+00:00

Callout devices are ancient history, so remove its traces from mxser's
documentation.

Signed-off-by: Jiri Slaby 
Link: https://lore.kernel.org/r/20210618061516.662-68-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman