All of lore.kernel.org
 help / color / mirror / Atom feed
From: Simon Wunderlich <sw@simonwunderlich.de>
To: b.a.t.m.a.n@lists.open-mesh.org
Subject: Re: [B.A.T.M.A.N.] [PATCH] batman-adv: use inline kernel-doc for uapi constants
Date: Mon, 23 Oct 2017 17:21:16 +0200	[thread overview]
Message-ID: <2426942.o1Iv1Lg3Ss@prime> (raw)
In-Reply-To: <20171021094546.8299-1-sven@narfation.org>

[-- Attachment #1: Type: text/plain, Size: 602 bytes --]

On Saturday, October 21, 2017 11:45:46 AM CEST Sven Eckelmann wrote:
> The enums of constants for netlink tends to become rather large over time.
> Documenting them is easier when the kernel-doc is actually next to constant
> and not in a different block above the enum.
> 
> Also inline kernel-doc allows multi-paragraph description. This could be
> required to better document the netlink command types and the expected
> return values.
> 
> Signed-off-by: Sven Eckelmann <sven@narfation.org>

Thanks Sven, I think this really improves readability. Applied in commit 
dcad23d0.

Thank you,
     Simon

[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

      parent reply	other threads:[~2017-10-23 15:21 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-10-21  9:45 [B.A.T.M.A.N.] [PATCH] batman-adv: use inline kernel-doc for uapi constants Sven Eckelmann
2017-10-21 11:46 ` Sven Eckelmann
2017-10-23 15:21 ` Simon Wunderlich [this message]

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=2426942.o1Iv1Lg3Ss@prime \
    --to=sw@simonwunderlich.de \
    --cc=b.a.t.m.a.n@lists.open-mesh.org \
    /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.