From patchwork Sun Nov 29 18:32:51 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 335078 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER, INCLUDES_PATCH, MAILING_LIST_MULTI, SPF_HELO_NONE, SPF_PASS, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 7CA29C71155 for ; Sun, 29 Nov 2020 18:34:53 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 4113A207FF for ; Sun, 29 Nov 2020 18:34:53 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="QAM2aZyz" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728800AbgK2SeZ (ORCPT ); Sun, 29 Nov 2020 13:34:25 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33464 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728681AbgK2SeY (ORCPT ); Sun, 29 Nov 2020 13:34:24 -0500 Received: from merlin.infradead.org (merlin.infradead.org [IPv6:2001:8b0:10b:1231::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A1299C061A4C for ; Sun, 29 Nov 2020 10:33:27 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=merlin.20170209; h=Content-Transfer-Encoding:MIME-Version: References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To: Content-Type:Content-ID:Content-Description; bh=k1lcdTPkYRVvrNt5oSUqA18SpI7MH6gIKHEfNnvqbXM=; b=QAM2aZyzdjWSvfnoOYU8RwtRw/ 6M1Kw5237/kR127t3OftzXY56wLRaLndJNqOrYyo3pqveGNykV/GqR5c7n/ngeaEEV1kn/x1sNgyI iAVi+Jqt4wGP2UD9SCxfkg/mAiWuRqxL5besAeDfpkLCPCypMqOUfqsyO/XeeL60hZEZn2wbJ5t6i aGtuqLz8NJaIltTwv+sHmaXCzWiqsLcqmrqBmi3X627nAFhdJVBUiLC/c2QGgfhTITBHjpv6TbsyB 04F1JjHr8sC23tRyKxcdp/VSSYZuvXBtvMwTzML9eFxhLuDn03Yp0xDTolW30V8faFkhrOiYDODd4 cXLlk9Mg==; Received: from [2601:1c0:6280:3f0::cc1f] (helo=smtpauth.infradead.org) by merlin.infradead.org with esmtpsa (Exim 4.92.3 #3 (Red Hat Linux)) id 1kjRVl-00011y-8Q; Sun, 29 Nov 2020 18:33:25 +0000 From: Randy Dunlap To: netdev@vger.kernel.org Cc: Randy Dunlap , Jon Maloy , Ying Xue , tipc-discussion@lists.sourceforge.net, "David S. Miller" , Jakub Kicinski Subject: [PATCH 10/10 net-next v2] net/tipc: add TIPC chapter to networking Documentation Date: Sun, 29 Nov 2020 10:32:51 -0800 Message-Id: <20201129183251.7049-11-rdunlap@infradead.org> X-Mailer: git-send-email 2.26.2 In-Reply-To: <20201129183251.7049-1-rdunlap@infradead.org> References: <20201129183251.7049-1-rdunlap@infradead.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Add a TIPC chapter to the networking docbook. Signed-off-by: Randy Dunlap Cc: Jon Maloy Cc: Ying Xue Cc: tipc-discussion@lists.sourceforge.net Cc: "David S. Miller" Cc: Jakub Kicinski --- v2: rebase to current net-next Documentation/networking/index.rst | 1 Documentation/networking/tipc.rst | 101 +++++++++++++++++++++++++++ 2 files changed, 102 insertions(+) --- net-next.orig/Documentation/networking/index.rst +++ net-next/Documentation/networking/index.rst @@ -101,6 +101,7 @@ Contents: tcp-thin team timestamping + tipc tproxy tuntap udplite --- /dev/null +++ net-next/Documentation/networking/tipc.rst @@ -0,0 +1,101 @@ +.. 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: +