Re: [RFC PATCH 2/2] software node: Add documentation

2019-10-04 Thread Heikki Krogerus
On Thu, Oct 03, 2019 at 07:56:59PM -0700, Randy Dunlap wrote: > Hi, > Below are a few doc edits for you. Thank you for the review! I'll fix the v2 according to your comments. thanks, -- heikki

[RFC PATCH 1/2] software node: Add missing kernel-doc function descriptions

2019-10-02 Thread Heikki Krogerus
Some of the functions were missing kernel-doc style descriptions. Signed-off-by: Heikki Krogerus --- drivers/base/swnode.c | 23 +++ 1 file changed, 23 insertions(+) diff --git a/drivers/base/swnode.c b/drivers/base/swnode.c index a1f3f0994f9f..51c9e6c56c26 100644 --- a

[RFC PATCH 2/2] software node: Add documentation

2019-10-02 Thread Heikki Krogerus
API documentation for the software nodes. Signed-off-by: Heikki Krogerus --- Documentation/driver-api/software_node.rst | 197 + 1 file changed, 197 insertions(+) create mode 100644 Documentation/driver-api/software_node.rst diff --git a/Documentation/driver-api

[RFC PATCH 0/2] software node: API documentation

2019-10-02 Thread Heikki Krogerus
ld be added. [1] https://lkml.org/lkml/2019/9/11/8 thanks, Heikki Krogerus (2): software node: Add missing kernel-doc function descriptions software node: Add documentation Documentation/driver-api/software_node.rst | 197 + drivers/base/swnode.c

[PATCH] usb: typec: Improve Alt Mode documentation

2018-12-18 Thread Heikki Krogerus
Adding the document to the usb index file and fixing a few references. Also, exposing the code examples as "literal blocks" so they are more easy to read. Signed-off-by: Heikki Krogerus --- Documentation/driver-api/usb/index.rst | 1 + Documentation/driver-api/usb/typec.rs

Re: [PATCH] Documentation: driver-api: fix device_connection.rst kernel-doc error

2018-04-27 Thread Heikki Krogerus
oc" directive: > > Signed-off-by: Randy Dunlap > Cc: Heikki Krogerus FWIW: Reviewed-by: Heikki Krogerus > --- > Documentation/driver-api/device_connection.rst |2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > --- linux-next-20180426.orig/Document

[PATCH v2] Documentation: typec.rst: Use literal-block element with ascii art

2018-04-06 Thread Heikki Krogerus
Using reStructuredText literal-block element with ascii-art. That prevents the ascii art from being processed as reStructuredText. Reported-by: Masanari Iida Fixes: bdecb33af34f ("usb: typec: API for controlling USB Type-C Multiplexers") Signed-off-by: Heikki Krogerus --- Change

Re: make xmldocs failed with error after 4.17 merge period

2018-04-06 Thread Heikki Krogerus
Hi Markus, On Fri, Apr 06, 2018 at 12:03:55PM +0200, Markus Heiser wrote: > >> There are ways to do this, look at how the v4l2 and I think the drm > >> subsystems handle ascii art such that "real" drawings end up being > >> produced. > > > > Thanks. I did not actually find anything else except us

Re: [PATCH] Documentation: typec.rst: Mark ascii art as a comment

2018-04-06 Thread Heikki Krogerus
On Fri, Apr 06, 2018 at 11:22:29AM +0300, Heikki Krogerus wrote: > To prevent processing of ascii art as reStructuredText > elements, marking it as a comment. I will change this, and use literal-block instead. > Reported-by: Masanari Iida > Fixes: bdecb33af34f ("usb: typec: AP

Re: make xmldocs failed with error after 4.17 merge period

2018-04-06 Thread Heikki Krogerus
On Fri, Apr 06, 2018 at 10:30:10AM +0200, Greg KH wrote: > On Fri, Apr 06, 2018 at 11:15:55AM +0300, Heikki Krogerus wrote: > > On Fri, Apr 06, 2018 at 09:57:34AM +0200, Greg KH wrote: > > > On Fri, Apr 06, 2018 at 10:51:09AM +0300, Heikki Krogerus wrote: > > > > On F

[PATCH] Documentation: typec.rst: Mark ascii art as a comment

2018-04-06 Thread Heikki Krogerus
To prevent processing of ascii art as reStructuredText elements, marking it as a comment. Reported-by: Masanari Iida Fixes: bdecb33af34f ("usb: typec: API for controlling USB Type-C Multiplexers") Signed-off-by: Heikki Krogerus --- Documentation/driver-api/usb/typec.rst | 2 +- 1 fi

Re: make xmldocs failed with error after 4.17 merge period

2018-04-06 Thread Heikki Krogerus
On Fri, Apr 06, 2018 at 09:57:34AM +0200, Greg KH wrote: > On Fri, Apr 06, 2018 at 10:51:09AM +0300, Heikki Krogerus wrote: > > On Fri, Apr 06, 2018 at 12:38:42PM +0900, Masanari Iida wrote: > > > After merge following patch during 4.17 merger period, > > > make xmldo

Re: make xmldocs failed with error after 4.17 merge period

2018-04-06 Thread Heikki Krogerus
On Fri, Apr 06, 2018 at 12:38:42PM +0900, Masanari Iida wrote: > After merge following patch during 4.17 merger period, > make xmldocs start to fail with error. > > [bdecb33af34f79cbfbb656661210f77c8b8b5b5f] > usb: typec: API for controlling USB Type-C Multiplexers > > Error messages. > reST mar

Re: [PATCH] doc-rst: fixed kernel-doc directives in usb/typec.rst

2017-05-17 Thread Heikki Krogerus
On Sat, May 13, 2017 at 03:49:17PM +0200, Markus Heiser wrote: > 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"

Re: [PATCH 12/50] pinctrl: intel: Use devm_pinctrl_register() for pinctrl registration

2016-02-25 Thread Heikki Krogerus
On Wed, Feb 24, 2016 at 06:45:37PM +0530, Laxman Dewangan wrote: > Use devm_pinctrl_register() for pin control registration. > > Signed-off-by: Laxman Dewangan > Cc: Mika Westerberg > Cc: Heikki Krogerus > --- > drivers/pinctrl/intel/pinctrl-intel.c | 4 ++-- > 1 fi

Re: [PATCH 11/50] pinctrl: cherryview: Use devm_pinctrl_register() for pinctrl registration

2016-02-25 Thread Heikki Krogerus
Hi, On Wed, Feb 24, 2016 at 06:45:36PM +0530, Laxman Dewangan wrote: > Use devm_pinctrl_register() for pin control registration. > > Signed-off-by: Laxman Dewangan > Cc: Mika Westerberg > Cc: Heikki Krogerus > --- > drivers/pinctrl/intel/pinctrl-cherryview.c | 4 ++--