From mboxrd@z Thu Jan 1 00:00:00 1970 From: Randy Dunlap Date: Thu, 17 Oct 2019 01:52:34 +0000 Subject: Re: [PATCH] staging: sm750fb: format description of parameters the to kernel doc format Message-Id: MIME-Version: 1 Content-Type: multipart/mixed; boundary="------------B227F5DA5237A52E62CCD8AE" List-Id: References: <20191017011849.6081-1-gabrielabittencourt00@gmail.com> <799632e2-a328-d72b-397d-3ee6b5e87e06@infradead.org> In-Reply-To: To: gbittencourt , outreachy-kernel@googlegroups.com, sudipm.mukherjee@gmail.com, teddy.wang@siliconmotion.com, gregkh@linuxfoundation.org, linux-fbdev@vger.kernel.org, devel@driverdev.osuosl.org, linux-kernel@vger.kernel.org, lkcamp@lists.libreplanetbr.org, trivial@kernel.org This is a multi-part message in MIME format. --------------B227F5DA5237A52E62CCD8AE Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit On 10/16/19 6:29 PM, gbittencourt wrote: > Hi Randy, > > On 10/16/19 10:25 PM, Randy Dunlap wrote: >> Hi, >> >> On 10/16/19 6:18 PM, Gabriela Bittencourt wrote: >>> Cluster comments that describes parameters of functions and create one >>> single comment before the function in kernel doc format. >> Good plan. >> >> How did you test this patch? > I haven't test it. How can I do it? Hm. There used to be a comment in a (now deleted) document named Documentation/kernel-doc-nano-HOWTO.txt about how to test kernel-doc. I took that comment and made a script from it. I'll attach the script. It's easy to use, but it is made to test only one function or struct or union or enum at a time. You need to have a script named 'kernel-doc' in your PATH or you can specify where the script is located by using $ KERNDOC=path/to/scripts/kernel-doc kdoc_function _parameters_ Its usage is: kdoc_function filename funcname [text|man|html|docbook|xml] where funcname can be a function, struct, union, or enum name. The output format can be any of those listed, but the default is "text". Let me know if you have any questions or problems. >>> Signed-off-by: Gabriela Bittencourt >>> --- >>>   drivers/staging/sm750fb/sm750_accel.c | 65 +++++++++++++++------------ >>>   1 file changed, 37 insertions(+), 28 deletions(-) -- ~Randy --------------B227F5DA5237A52E62CCD8AE Content-Type: text/plain; charset=UTF-8; name="kdoc_function" Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="kdoc_function" IyEgL2Jpbi9zaAojIGZyb20gbGludXgvRG9jdW1lbnRhdGlvbi9rZXJuZWwtZG9jLW5hbm8t SE9XVE8udHh0CiMgdXNlcyBsaW51eC9zY3JpcHRzL2tlcm5lbC1kb2Mgb3IgYSBjb3B5IG9m IGl0IChpbiAkUEFUSCkuCiMgdXNpbmcgIkxBTkc9QyBvciBMQ19BTEw9QyBrZG9jX2Z1bmN0 aW9uIDxwcm1zPiIgY2FuIGJlIHVzZWZ1bC4KIyBDYW4gdXNlICJLRVJORE9DPTxzY3JpcHRf ZmlsZW5hbWU+IGtkb2NfZnVuY3Rpb24gPHBybXM+IiB0byB2YXJ5CiMgd2hpY2gga2VybmVs LWRvYyBzY3JpcHQgaXMgdXNlZC4KCnZlcmJvc2U9CmRlYnVnPQppZiBbICIkS0VSTkRPQyIg PSAiIiBdOyB0aGVuCglLRVJORE9DPWtlcm5lbC1kb2MKZmkKCiMgY2FyZWZ1bDogbXVzdCBl bnRlciAtdiBiZWZvcmUgLXg6CmlmIFsgIiQxIiA9ICItdiIgXTsgdGhlbgoJdmVyYm9zZT0i LXYiCglzaGlmdApmaQppZiBbICIkMSIgPSAiLXgiIF07IHRoZW4KCWRlYnVnPSIteCIKCXNo aWZ0CmZpCgpmaWxlPSIkMSIKZm49IiQyIgojIGZtdCBjYW4gYmUgInRleHR8bWFufGh0bWx8 ZG9jYm9va3x4bWwiIChkZWZhdWx0IGlzICJ0ZXh0IikKIyBkb2Nib29rIHByb2R1Y2VzIHht bApmbXQ9IiQzIgppZiBbIHgkMyA9IHggXTsgdGhlbgoJZm10PSJ0ZXh0IgpmaQoKaWYgWyAi JDIiID0gIiIgXTsgdGhlbgoJZWNobyAidXNhZ2U6IGtkb2NfZnVuY3Rpb24gZmlsZW5hbWUg ZnVuY25hbWUgW3RleHR8bWFufGh0bWx8ZG9jYm9va3x4bWxdIgoJZXhpdCAxCmZpCgpjYXNl ICRmbXQgaW4KICAgIG1hbikKCSRLRVJORE9DICR2ZXJib3NlICRkZWJ1ZyAtbWFuIC1mdW5j dGlvbiAkZm4gJGZpbGUgfCBucm9mZiAtbWFuIHwgbGVzcwoJOzsKICAgIGh0bWwpCgkkS0VS TkRPQyAkdmVyYm9zZSAkZGVidWcgLWh0bWwgLWZ1bmN0aW9uICRmbiAkZmlsZSA+a2VybmVs ZG9jLmh0bWwKCWVjaG8gInNlZSBrZXJuZWxkb2MuaHRtbCIKCTs7CiAgICBkb2Nib29rfHht bCkKCSRLRVJORE9DICR2ZXJib3NlICRkZWJ1ZyAtZG9jYm9vayAtZnVuY3Rpb24gJGZuICRm aWxlID5rZXJuZWxkb2MueG1sCgllY2hvICJzZWUga2VybmVsZG9jLnhtbCIKCTs7CiAgICAq KQoJJEtFUk5ET0MgJHZlcmJvc2UgJGRlYnVnIC10ZXh0IC1mdW5jdGlvbiAkZm4gJGZpbGUg fCBsZXNzCgk7Owplc2FjCg== --------------B227F5DA5237A52E62CCD8AE--