From mboxrd@z Thu Jan 1 00:00:00 1970 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=-4.1 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE, SPF_PASS autolearn=no 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 5D987C2BA19 for ; Thu, 9 Apr 2020 20:18:22 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 130CB2084D for ; Thu, 9 Apr 2020 20:18:22 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1586463502; bh=70hc4273hiK15yHAKjn5vVdCiHqt5lUWqhFI11qhA+Y=; h=Date:From:To:Cc:Subject:In-Reply-To:References:List-ID:From; b=dHIv7oMoc69sQaX85bmd0CWGG/eczo3paspAU894KFHHEUaU6XpUXmDDUFrOJCvYy dpHCspgA6ILhCxj6ES8IGcRMqj1MHYaJjROaR4cyLd9Uwc5RjIYaPu7MhA92/SwTmi wieeQe0wezDL56wTj6G6uYu1uRakT8OCiBsnwUuA= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726875AbgDIUSU (ORCPT ); Thu, 9 Apr 2020 16:18:20 -0400 Received: from mail.kernel.org ([198.145.29.99]:39524 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726638AbgDIUSU (ORCPT ); Thu, 9 Apr 2020 16:18:20 -0400 Received: from kicinski-fedora-PC1C0HJN (unknown [163.114.132.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 3CD8220757; Thu, 9 Apr 2020 20:18:20 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1586463500; bh=70hc4273hiK15yHAKjn5vVdCiHqt5lUWqhFI11qhA+Y=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=DRGfcSfQVjj7r8bMrx6BZYVxucEW6EVMcwWE3gcbOxZVnzxEtDpBhkIwb7i/jPRXZ n2oF8saQtW8R5LMrXMQdoRMHDGJvoimYzilLkg9qJN5gMOgvVEpm3QFojc457mrUKv EqSnaV8umMY2IOOuh/1SENs0L/ERzZWOalsXT+1w= Date: Thu, 9 Apr 2020 13:18:18 -0700 From: Jakub Kicinski To: Randy Dunlap Cc: davem@davemloft.net, netdev@vger.kernel.org, kernel-team@fb.com, talgi@mellanox.com, leon@kernel.org, jacob.e.keller@intel.com Subject: Re: [PATCH net] docs: networking: add full DIM API Message-ID: <20200409131818.7f4fa0bf@kicinski-fedora-PC1C0HJN> In-Reply-To: <0a2f9a52-6abb-b9ca-45c1-cc74f6d276d7@infradead.org> References: <20200409175704.305241-1-kuba@kernel.org> <20200409124221.128d6327@kicinski-fedora-PC1C0HJN> <0a2f9a52-6abb-b9ca-45c1-cc74f6d276d7@infradead.org> MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org On Thu, 9 Apr 2020 13:06:50 -0700 Randy Dunlap wrote: > On 4/9/20 12:42 PM, Jakub Kicinski wrote: > > On Thu, 9 Apr 2020 12:27:17 -0700 Randy Dunlap wrote: > >> From: Randy Dunlap > >> > >> Add the full net DIM API to the net_dim.rst file. > >> > >> Signed-off-by: Randy Dunlap > >> Cc: davem@davemloft.net > >> Cc: Jakub Kicinski > >> Cc: netdev@vger.kernel.org, talgi@mellanox.com, leon@kernel.org, jacob.e.keller@intel.com > > > > Ah, very nice, I didn't know how to do that! > > > > Do you reckon we should drop the .. c:function and .. c:type marking I > > added? So that the mentions of net_dim and the structures point to the > > kdoc? > > My understanding is that if functions have an ending (), then the c:function > is not needed/wanted. I don't know about the c:type uses. > > But there is some duplication that might be cleaned up some. I think you're thinking about :c:func:, I was talking about .. c:function which basically renders very similar entries to kdoc. If you have the doc rendered check out what networking/net_dim.html#c.dim takes us to right now.