From patchwork Wed Jul 12 16:29:07 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Hemminger X-Patchwork-Id: 787357 X-Patchwork-Delegate: davem@davemloft.net Return-Path: X-Original-To: patchwork-incoming@ozlabs.org Delivered-To: patchwork-incoming@ozlabs.org Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 3x74Cl1lsnz9ryr for ; Thu, 13 Jul 2017 02:29:23 +1000 (AEST) Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=networkplumber-org.20150623.gappssmtp.com header.i=@networkplumber-org.20150623.gappssmtp.com header.b="Gs1gJ3g2"; dkim-atps=neutral Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753576AbdGLQ3V (ORCPT ); Wed, 12 Jul 2017 12:29:21 -0400 Received: from mail-pg0-f48.google.com ([74.125.83.48]:32901 "EHLO mail-pg0-f48.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753527AbdGLQ3T (ORCPT ); Wed, 12 Jul 2017 12:29:19 -0400 Received: by mail-pg0-f48.google.com with SMTP id k14so15606470pgr.0 for ; Wed, 12 Jul 2017 09:29:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=networkplumber-org.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=0Z76SvYGxvE1rvMNWe2V4jVcSLL1MtbWx3iHLWYba+M=; b=Gs1gJ3g2gFwbK8a+WNysmNdIjvgJzcy3whPSLiiScQ8gjDqVKZ7uuPBA6HBxtKdsu5 bBcDchKj1DJiwpllAsBTNdj4e2N5npS9A/FI9pVmHop16DwJ1P10SeIKjVbc+WgQjfT+ VtEfyFMBh0ixFqNt31IVlrRfnOsfX6jX9lIrVVVyl1tCmxiI41V/+Vq8l9p+ngUMgfhz uWJ3M69I+5a3rSz5eb0xaehoUXhGFjLTWjYfJAjOSFuwzF6Q4RmxDaOJnXVDy254563c rS31RUvf+LHItJ5xdFH+iREG5FTUEkjdc6GzAUg2KVQg5+d2xOTr9h/txs3x7srY+LmJ Hk/A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=0Z76SvYGxvE1rvMNWe2V4jVcSLL1MtbWx3iHLWYba+M=; b=bDLMFOZytSa86G7msSRZlFLLvd5Se8N22ZkW+edghZ5+swHpXzJyWUt5dfbSCDNqGQ Fq1OBPkTwIuArovKOB410fJSY0Eq1Q3yaH9r+aFUDWDDTJRbEbb0TjPnu6aTcshBXdQO hvrc9rTIMkKu8/csfls+eXBDl9RhwOGHhuL5WFx6oM75leYcLOcqsRBZeE6MnE6iTJjp ldwbd/0WMUVEGHNbc+8rESHxyHK+60Tc3ADs7Rsa3ifwCQgNIp9/E+sAlVYcXEiNeG/Q ZQ67FoXD3N2OZrTsYt7P7A8tRJoIYhaLcP0xpyh28B5575NZVCo9f41CwFsXMpHAJFhU I3eA== X-Gm-Message-State: AIVw113kIYzuG9ELfoV9nocjYyllZqXLfLuqGxtTTDLTKZjUaaJxukM5 PoVfK4g8XPhOzk6X7Wzyfw== X-Received: by 10.98.19.78 with SMTP id b75mr56013860pfj.212.1499876958515; Wed, 12 Jul 2017 09:29:18 -0700 (PDT) Received: from xeon-e3.wavecable.com (76-14-207-240.or.wavecable.com. [76.14.207.240]) by smtp.gmail.com with ESMTPSA id h3sm6014064pfj.72.2017.07.12.09.29.17 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 12 Jul 2017 09:29:17 -0700 (PDT) From: Stephen Hemminger X-Google-Original-From: Stephen Hemminger To: davem@davemloft.net Cc: netdev@vger.kernel.org, linux-doc@vger.kernel.org, Stephen Hemminger Subject: [PATCH net 2/2] datagram: fix kernel-doc comments Date: Wed, 12 Jul 2017 09:29:07 -0700 Message-Id: <20170712162907.18465-3-sthemmin@microsoft.com> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20170712162907.18465-1-sthemmin@microsoft.com> References: <20170712162907.18465-1-sthemmin@microsoft.com> Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org An underscore in the kernel-doc comment section has special meaning and mis-use generates an errors. ./net/core/datagram.c:207: ERROR: Unknown target name: "msg". ./net/core/datagram.c:379: ERROR: Unknown target name: "msg". ./net/core/datagram.c:816: ERROR: Unknown target name: "t". Signed-off-by: Stephen Hemminger --- net/core/datagram.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/net/core/datagram.c b/net/core/datagram.c index 6877c43cc92d..ee5647bd91b3 100644 --- a/net/core/datagram.c +++ b/net/core/datagram.c @@ -203,7 +203,7 @@ struct sk_buff *__skb_try_recv_from_queue(struct sock *sk, /** * __skb_try_recv_datagram - Receive a datagram skbuff * @sk: socket - * @flags: MSG_ flags + * @flags: MSG\_ flags * @destructor: invoked under the receive lock on successful dequeue * @peeked: returns non-zero if this packet has been seen before * @off: an offset in bytes to peek skb from. Returns an offset @@ -375,7 +375,7 @@ EXPORT_SYMBOL(__sk_queue_drop_skb); * skb_kill_datagram - Free a datagram skbuff forcibly * @sk: socket * @skb: datagram skbuff - * @flags: MSG_ flags + * @flags: MSG\_ flags * * This function frees a datagram skbuff that was received by * skb_recv_datagram. The flags argument must match the one @@ -809,7 +809,7 @@ EXPORT_SYMBOL(skb_copy_and_csum_datagram_msg); * sequenced packet sockets providing the socket receive queue * is only ever holding data ready to receive. * - * Note: when you _don't_ use this routine for this protocol, + * Note: when you *don't* use this routine for this protocol, * and you use a different write policy from sock_writeable() * then please supply your own write_space callback. */