From: Sven Eckelmann <sven@narfation.org>
To: b.a.t.m.a.n@lists.open-mesh.org
Subject: [B.A.T.M.A.N.] [PATCH 0/8] batman-adv: kernel-doc enhancements
Date: Sat, 2 Dec 2017 19:51:45 +0100 [thread overview]
Message-ID: <20171202185153.552-1-sven@narfation.org> (raw)
Hi,
more and more functions/struct/enums/... in batman-adv have at least some
brief documentation. But there were still some externally visible (as
"visible" in other source files) elements which completely missed any kind
of kernel-doc. Accoring to the kernel-doc dicumentation [1], having these
documented "properly" is currently a goal.
This patchset now tries to unify the formatting slightly and then add
more (brief) documentation to these elements.
Kind regards,
Sven
[1] https://www.kernel.org/doc/html/v4.14/doc-guide/kernel-doc.html#recommendations
Sven Eckelmann (8):
batman-adv: Add missing kernel-doc to packet.h
batman-adv: Use parentheses in function kernel-doc
batman-adv: Use inline kernel-doc for enum/struct
batman-adv: Fix kernel-doc references to struct members
batman-adv: Add kernel-doc to structs in headers
batman-adv: Add kernel-doc to enums in headers
batman-adv: Add kernel-doc to functions in headers
batman-adv: Add kernel-doc to externally visible functions
net/batman-adv/bat_algo.c | 34 +-
net/batman-adv/bat_iv_ogm.c | 102 +-
net/batman-adv/bat_v.c | 48 +-
net/batman-adv/bat_v_elp.c | 24 +-
net/batman-adv/bat_v_ogm.c | 34 +-
net/batman-adv/bitarray.c | 2 +-
net/batman-adv/bitarray.h | 9 +-
net/batman-adv/bridge_loop_avoidance.c | 109 +-
net/batman-adv/bridge_loop_avoidance.h | 4 +-
net/batman-adv/debugfs.c | 28 +-
net/batman-adv/distributed-arp-table.c | 77 +-
net/batman-adv/distributed-arp-table.h | 6 +-
net/batman-adv/fragmentation.c | 20 +-
net/batman-adv/fragmentation.h | 2 +-
net/batman-adv/gateway_client.c | 62 +-
net/batman-adv/gateway_common.c | 27 +-
net/batman-adv/gateway_common.h | 5 +-
net/batman-adv/hard-interface.c | 62 +-
net/batman-adv/hard-interface.h | 58 +-
net/batman-adv/hash.c | 17 +-
net/batman-adv/hash.h | 27 +-
net/batman-adv/icmp_socket.c | 13 +-
net/batman-adv/log.c | 17 +
net/batman-adv/log.h | 61 +-
net/batman-adv/main.c | 47 +-
net/batman-adv/main.h | 120 +-
net/batman-adv/multicast.c | 78 +-
net/batman-adv/multicast.h | 16 +-
net/batman-adv/netlink.c | 22 +-
net/batman-adv/network-coding.c | 120 +-
net/batman-adv/originator.c | 119 +-
net/batman-adv/originator.h | 9 +-
net/batman-adv/packet.h | 25 +-
net/batman-adv/routing.c | 53 +-
net/batman-adv/send.c | 63 +-
net/batman-adv/send.h | 4 +-
net/batman-adv/soft-interface.c | 61 +-
net/batman-adv/sysfs.c | 52 +-
net/batman-adv/sysfs.h | 13 +
net/batman-adv/tp_meter.c | 70 +-
net/batman-adv/translation-table.c | 226 ++--
net/batman-adv/tvlv.c | 38 +-
net/batman-adv/types.h | 1992 ++++++++++++++++++++++----------
43 files changed, 2694 insertions(+), 1282 deletions(-)
--
2.11.0
next reply other threads:[~2017-12-02 18:51 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-12-02 18:51 Sven Eckelmann [this message]
2017-12-02 18:51 ` [B.A.T.M.A.N.] [PATCH 1/8] batman-adv: Add missing kernel-doc to packet.h Sven Eckelmann
2017-12-02 18:51 ` [B.A.T.M.A.N.] [PATCH 2/8] batman-adv: Use parentheses in function kernel-doc Sven Eckelmann
2017-12-02 18:51 ` [B.A.T.M.A.N.] [PATCH 3/8] batman-adv: Use inline kernel-doc for enum/struct Sven Eckelmann
2017-12-02 18:51 ` [B.A.T.M.A.N.] [PATCH 4/8] batman-adv: Fix kernel-doc references to struct members Sven Eckelmann
2017-12-02 18:51 ` [B.A.T.M.A.N.] [PATCH 5/8] batman-adv: Add kernel-doc to structs in headers Sven Eckelmann
2017-12-02 18:51 ` [B.A.T.M.A.N.] [PATCH 6/8] batman-adv: Add kernel-doc to enums " Sven Eckelmann
2017-12-02 18:51 ` [B.A.T.M.A.N.] [PATCH 7/8] batman-adv: Add kernel-doc to functions " Sven Eckelmann
2017-12-02 18:51 ` [B.A.T.M.A.N.] [PATCH 8/8] batman-adv: Add kernel-doc to externally visible functions Sven Eckelmann
2017-12-06 10:42 ` [B.A.T.M.A.N.] [PATCH 0/8] batman-adv: kernel-doc enhancements Sven Eckelmann
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=20171202185153.552-1-sven@narfation.org \
--to=sven@narfation.org \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).