mbox series

[00/10,net-next,v2] net/tipc: fix all kernel-doc and add TIPC networking chapter

Message ID 20201129183251.7049-1-rdunlap@infradead.org
Headers show
Series net/tipc: fix all kernel-doc and add TIPC networking chapter | expand

Message

Randy Dunlap Nov. 29, 2020, 6:32 p.m. UTC 
Fix lots of net/tipc/ kernel-doc warnings. Add many struct field and
function parameter descriptions.

Then add a TIPC chapter to the networking documentation book.

All patches have been rebased to current net-next.


Note: some of the struct members and function parameters are marked
with "FIXME". They could use some additional descriptions if
someone could help add to them. Thanks.


Cc: Jon Maloy <jmaloy@redhat.com>
Cc: Ying Xue <ying.xue@windriver.com>
Cc: tipc-discussion@lists.sourceforge.net
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>

[PATCH 01/10 net-next v2] net/tipc: fix tipc header files for kernel-doc
[PATCH 02/10 net-next v2] net/tipc: fix various kernel-doc warnings
[PATCH 03/10 net-next v2] net/tipc: fix bearer.c for kernel-doc
[PATCH 04/10 net-next v2] net/tipc: fix link.c kernel-doc
[PATCH 05/10 net-next v2] net/tipc: fix name_distr.c kernel-doc
[PATCH 06/10 net-next v2] net/tipc: fix name_table.c kernel-doc
[PATCH 07/10 net-next v2] net/tipc: fix node.c kernel-doc
[PATCH 08/10 net-next v2] net/tipc: fix socket.c kernel-doc
[PATCH 09/10 net-next v2] net/tipc: fix all function Return: notation
[PATCH 10/10 net-next v2] net/tipc: add TIPC chapter to networking Documentation


 Documentation/networking/index.rst |    1 
 Documentation/networking/tipc.rst  |  101 +++++++++++++++++++++++++++
 net/tipc/bearer.c                  |   22 +++++
 net/tipc/bearer.h                  |   10 +-
 net/tipc/crypto.c                  |   55 ++++++++------
 net/tipc/crypto.h                  |    6 -
 net/tipc/discover.c                |    5 -
 net/tipc/link.c                    |   46 ++++++++++--
 net/tipc/msg.c                     |   29 ++++---
 net/tipc/name_distr.c              |   29 +++++++
 net/tipc/name_distr.h              |    2 
 net/tipc/name_table.c              |   46 +++++++++---
 net/tipc/name_table.h              |    9 +-
 net/tipc/node.c                    |   37 ++++++++-
 net/tipc/socket.c                  |   92 +++++++++++++++---------
 net/tipc/subscr.c                  |    8 +-
 net/tipc/subscr.h                  |   11 +-
 net/tipc/trace.c                   |    2 
 net/tipc/udp_media.c               |    8 +-
 19 files changed, 405 insertions(+), 114 deletions(-)

Comments

Jakub Kicinski Dec. 1, 2020, 11:56 p.m. UTC | #1 
On Sun, 29 Nov 2020 10:32:41 -0800 Randy Dunlap wrote:
> Fix lots of net/tipc/ kernel-doc warnings. Add many struct field and

> function parameter descriptions.

> 

> Then add a TIPC chapter to the networking documentation book.

> 

> All patches have been rebased to current net-next.

> 

> 

> Note: some of the struct members and function parameters are marked

> with "FIXME". They could use some additional descriptions if

> someone could help add to them. Thanks.


Applied, thanks!