Skip to content

Commit

Permalink
net/tipc: add TIPC chapter to networking Documentation
Browse files Browse the repository at this point in the history
Add a TIPC chapter to the networking docbook.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
  • Loading branch information
Randy Dunlap authored and Jakub Kicinski committed Dec 1, 2020
1 parent 637b77f commit 2fc30de
Show file tree
Hide file tree
Showing 2 changed files with 101 additions and 0 deletions.
1 change: 1 addition & 0 deletions Documentation/networking/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ Contents:
tcp-thin
team
timestamping
tipc
tproxy
tuntap
udplite
Expand Down
100 changes: 100 additions & 0 deletions Documentation/networking/tipc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
.. SPDX-License-Identifier: GPL-2.0
=================
Linux Kernel TIPC
=================

TIPC (Transparent Inter Process Communication) is a protocol that is
specially designed for intra-cluster communication.

For more information about TIPC, see http://tipc.sourceforge.net.

TIPC Base Types
---------------

.. kernel-doc:: net/tipc/subscr.h
:internal:

.. kernel-doc:: net/tipc/bearer.h
:internal:

.. kernel-doc:: net/tipc/name_table.h
:internal:

.. kernel-doc:: net/tipc/name_distr.h
:internal:

.. kernel-doc:: net/tipc/bcast.c
:internal:

TIPC Bearer Interfaces
----------------------

.. kernel-doc:: net/tipc/bearer.c
:internal:

.. kernel-doc:: net/tipc/udp_media.c
:internal:

TIPC Crypto Interfaces
----------------------

.. kernel-doc:: net/tipc/crypto.c
:internal:

TIPC Discoverer Interfaces
--------------------------

.. kernel-doc:: net/tipc/discover.c
:internal:

TIPC Link Interfaces
--------------------

.. kernel-doc:: net/tipc/link.c
:internal:

TIPC msg Interfaces
-------------------

.. kernel-doc:: net/tipc/msg.c
:internal:

TIPC Name Interfaces
--------------------

.. kernel-doc:: net/tipc/name_table.c
:internal:

.. kernel-doc:: net/tipc/name_distr.c
:internal:

TIPC Node Management Interfaces
-------------------------------

.. kernel-doc:: net/tipc/node.c
:internal:

TIPC Socket Interfaces
----------------------

.. kernel-doc:: net/tipc/socket.c
:internal:

TIPC Network Topology Interfaces
--------------------------------

.. kernel-doc:: net/tipc/subscr.c
:internal:

TIPC Server Interfaces
----------------------

.. kernel-doc:: net/tipc/topsrv.c
:internal:

TIPC Trace Interfaces
---------------------

.. kernel-doc:: net/tipc/trace.c
:internal:

0 comments on commit 2fc30de

Please sign in to comment.