All of lore.kernel.org
 help / color / mirror / Atom feed
From: Johan Hovold <johan@kernel.org>
To: "Tobin C. Harding" <me@tobin.cc>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Jiri Slaby <jslaby@suse.com>,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH 2/3] tty_port: Fix function name and brief desc
Date: Wed, 12 Sep 2018 11:31:16 +0200	[thread overview]
Message-ID: <20180912093116.GC1089@localhost> (raw)
In-Reply-To: <20180912075044.8695-3-me@tobin.cc>

On Wed, Sep 12, 2018 at 05:50:43PM +1000, Tobin C. Harding wrote:
> File contains kernel-doc function comments that are not in the correct
> style.
> 
>  - Add '()' to function names
>  - Capitalise brief description and append a full stop.

Cleaning up these comments may not be a bad idea, but I have my doubts
about this particular item. Many descriptions aren't full sentences and
still won't be even if you capitalise and slap a full stop there, for
example:

> - *	tty_port_hangup		-	hangup helper
> + * tty_port_hangup() - Hangup helper.
	
There's no requirement to use full sentences, and the old kernel-doc
nano doc uses incomplete ones, as do most (?) kernel-doc comments
throughout the kernel.

I'd just drop this part of the patch. 

>  - Use correct spacing for function name / brief description as per the
>    kernel docs (Documentation/doc-guide/kernel-doc.rst)
> 
> 	/**
> 	 * function_name() - Brief description of function.
> 	 * @arg1: Describe the first argument.
> 
>  - Fix spacing for kernel-doc function comments (no tab space after '*').
> 
> These changes all touch the same lines so do them in a single patch.
> 
> Signed-off-by: Tobin C. Harding <me@tobin.cc>

Thanks,
Johan

  reply	other threads:[~2018-09-12  9:31 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-12  7:50 [PATCH 0/3] ttp_port: Clean up kernel-docs Tobin C. Harding
2018-09-12  7:50 ` [PATCH 1/3] tty_port: Remove incorrect whitespace after comments Tobin C. Harding
2018-09-12  7:50 ` [PATCH 2/3] tty_port: Fix function name and brief desc Tobin C. Harding
2018-09-12  9:31   ` Johan Hovold [this message]
2018-09-12 21:08     ` Tobin C. Harding
2018-09-18 13:37   ` Greg Kroah-Hartman
2018-09-12  7:50 ` [PATCH 3/3] tty_port: Fix kernel-docs warnings Tobin C. Harding
2018-09-18 13:38   ` Greg Kroah-Hartman
2018-09-18 22:02     ` Tobin C. Harding
2018-09-19  5:15       ` Greg Kroah-Hartman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180912093116.GC1089@localhost \
    --to=johan@kernel.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=jslaby@suse.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=me@tobin.cc \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.