Hi Greg, Thanks! I add linux-doc@xxxxxxxxxxxxxxx and Johnathan to CC for info. -- Markus -- Am 17.05.2017 um 11:54 schrieb <gregkh@xxxxxxxxxxxxxxxxxxx>: > > This is a note to let you know that I've just added the patch titled > > doc-rst: fixed kernel-doc directives in usb/typec.rst > > to my usb git tree which can be found at > git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/usb.git > in the usb-linus branch. > > The patch will show up in the next release of the linux-next tree > (usually sometime within the next 24 hours during the week.) > > The patch will hopefully also be merged in Linus's tree for the > next -rc kernel release. > > If you have any questions about this process, please let me know. > > > From 5383fae76b8224a8f0465be6ab9c7a645042951a Mon Sep 17 00:00:00 2001 > From: Markus Heiser <markus.heiser@xxxxxxxxxxx> > Date: Sat, 13 May 2017 15:49:17 +0200 > Subject: doc-rst: fixed kernel-doc directives in usb/typec.rst > > Even if this file is not yet included in any toctree, it is parsed by > Sphinx since it is named '.rst'. This patch fixes the following two > ERRORs from Sphinx build: > > Documentation/usb/typec.rst:116: ERROR: Error in "kernel-doc" directive: > invalid option block. > > .. kernel-doc:: drivers/usb/typec/typec.c > :functions: typec_register_cable typec_unregister_cable typec_register_plug > typec_unregister_plug > > Documentation/usb/typec.rst:139: ERROR: Error in "kernel-doc" directive: > invalid option block. > > .. kernel-doc:: drivers/usb/typec/typec.c > :functions: typec_set_data_role typec_set_pwr_role typec_set_vconn_role > typec_set_pwr_opmode > > Signed-off-by: Markus Heiser <markus.heiser@xxxxxxxxxxx> > Signed-off-by: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx> > --- > Documentation/usb/typec.rst | 6 ++---- > 1 file changed, 2 insertions(+), 4 deletions(-) > > diff --git a/Documentation/usb/typec.rst b/Documentation/usb/typec.rst > index b67a46779de9..8a7249f2ff04 100644 > --- a/Documentation/usb/typec.rst > +++ b/Documentation/usb/typec.rst > @@ -114,8 +114,7 @@ the details during registration. The class offers the following API for > registering/unregistering cables and their plugs: > > .. kernel-doc:: drivers/usb/typec/typec.c > - :functions: typec_register_cable typec_unregister_cable typec_register_plug > - typec_unregister_plug > + :functions: typec_register_cable typec_unregister_cable typec_register_plug typec_unregister_plug > > The class will provide a handle to struct typec_cable and struct typec_plug if > the registration is successful, or NULL if it isn't. > @@ -137,8 +136,7 @@ during connection of a partner or cable, the port driver must use the following > APIs to report it to the class: > > .. kernel-doc:: drivers/usb/typec/typec.c > - :functions: typec_set_data_role typec_set_pwr_role typec_set_vconn_role > - typec_set_pwr_opmode > + :functions: typec_set_data_role typec_set_pwr_role typec_set_vconn_role typec_set_pwr_opmode > > Alternate Modes > ~~~~~~~~~~~~~~~ > -- > 2.13.0 > > -- To unsubscribe from this list: send the line "unsubscribe linux-doc" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
