From patchwork Mon Aug 12 16:07:05 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?J=2E_Neusch=C3=A4fer?= X-Patchwork-Id: 1145796 X-Patchwork-Delegate: davem@davemloft.net Return-Path: X-Original-To: patchwork-incoming-netdev@ozlabs.org Delivered-To: patchwork-incoming-netdev@ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=netdev-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=gmx.net Authentication-Results: ozlabs.org; dkim=pass (1024-bit key; secure) header.d=gmx.net header.i=@gmx.net header.b="a0Q7VXbY"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 466gjv58M0z9sNF for ; Tue, 13 Aug 2019 02:08:03 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726792AbfHLQH7 (ORCPT ); Mon, 12 Aug 2019 12:07:59 -0400 Received: from mout.gmx.net ([212.227.17.20]:56593 "EHLO mout.gmx.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725843AbfHLQH7 (ORCPT ); Mon, 12 Aug 2019 12:07:59 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=gmx.net; s=badeba3b8450; t=1565626054; bh=x7tRP3TUDgUF+IKb4TvatQotKrueobFDeaa3admljZw=; h=X-UI-Sender-Class:From:To:Cc:Subject:Date:In-Reply-To:References; b=a0Q7VXbYNp3W+/Ei587ZUwIEgJhelIsUA+4wVX4pWFGA0hEamcXv0uz1hPIJOfnNC /ROv+Y466tpf+uY7RitJLB9SkWwHAM60Y1ZgmGRyuZlKhRRgxV1wU2MRE4+7AaPgTn 2L2f0q5XJSdZhkeyuOIIXlwsRWXt+y5em8Xccel0= X-UI-Sender-Class: 01bb95c1-4bf8-414a-932a-4f6e2808ef9c Received: from longitude ([78.34.97.158]) by mail.gmx.com (mrgmx103 [212.227.17.168]) with ESMTPSA (Nemesis) id 0McUnM-1hffyH2C0W-00HfT8; Mon, 12 Aug 2019 18:07:34 +0200 From: =?utf-8?q?Jonathan_Neusch=C3=A4fer?= To: linux-doc@vger.kernel.org Cc: =?utf-8?q?Jonathan_Neusch=C3=A4fer?= , Jonathan Corbet , Alexei Starovoitov , Daniel Borkmann , "David S. Miller" , Jakub Kicinski , Jesper Dangaard Brouer , John Fastabend , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, netdev@vger.kernel.org, xdp-newbies@vger.kernel.org, bpf@vger.kernel.org Subject: [PATCH v2 2/2] Documentation: sphinx: Don't parse socket() as identifier reference Date: Mon, 12 Aug 2019 18:07:05 +0200 Message-Id: <20190812160708.32172-2-j.neuschaefer@gmx.net> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190812160708.32172-1-j.neuschaefer@gmx.net> References: <20190812160708.32172-1-j.neuschaefer@gmx.net> MIME-Version: 1.0 X-Provags-ID: V03:K1:YIa4yoGa5k1pGA+d7OBh3A+7OXq84EhShBQ46Qu+a2q+YkaL/P1 kPZybaGZw6dvvKRAcQtyZRduiFmRE3Edt5WyEK6kKMX5B1WNKC2U7F6KPsKj2oZ8l2U4r98 QktXu2o627d+wTSTI52UwxF/STzMSqZrL3m919Sg6CEigkiARRBnLf/NR+v7ifMCz4jpg8Y XexE38mtQM2zm8OTrceEA== X-Spam-Flag: NO X-UI-Out-Filterresults: notjunk:1; V03:K0:0Ri/pCH+kAs=:n9wc26zEgmVw/wT6M6uL0y TBWFVv0FXVbthr4k+9RWqHS4wRlLTdo1Vu8cQfPlUnysLCuOYpQ1ES0d03mbPIZ6XN9JSuBBQ UcdT5ifhXONfOfkXtAVu6gA+jj1s3hfz6G5aSLFBykoRCLdmddckyAvegB0SGYc6U8FhL6W9j PsPvu9Pv4Q7l41UatOht4B1pqWg6tCRggyH0gGBYYzHZQpenF1Mb81r1GbL2fBFZlaflO3eOx M5N3+EPkAqgxBgzu2z0ZGtF8frK2ilKRRwtElxSNvribd66HMeTz9FqqEMwANeUhV9OA+jzO5 nqSMhN6a9BLans4+vmV/fQmLEKTwBLtuRtzunecfaXUZNIBN0M9byHmsKJHrufYz0jRmfXzpk fD6fi5KGcOBhE0fWCuqEYxF+pDKdRED1XTAvppwA0X5p84lUKIsbAUUVR8WeAF817gYstjZy6 RP0sxG01yGV0oTtosmLYtkijRJGheJtoR3napY3lKzS2VbE63tRGYX21mwILpawZdOcrY5jIy 6E14P1GJujwATdmnp9Tb5eqgLq5+5Tlf3Ujh8Mu4toV3Kmn7/oHln2a7uNAYzbtwRJIDXip58 RAFWQVndyF4JJ6U8md034hS0gYAc8hrSJEe5Ecb3pajPVyaEfnXMauJodymNjL1xk2uGhT8aA R2d+GEJClxjZOjsl3ONM7Spmqhk1uQh8CchJFZu61SxIu60OjCaQshO1A67abXaevMtYAKBy/ AobQSwXmabuEpt4ZDqeQnZzBgaX3l5evYP/eR7a17ZMLEg45cZU2bp2KUaQ+KGqK4T5/N1SPD D7HOD/fJABoc/pPvrd5N6eoBjIG5oUPxYdcEDP6sScP8pNPMOYPlJP8hR+cYMO9WcxFhYH2Z1 YqdqFNiE6fALEssBOgnd9ZkkOLDBRkzLOQNZ5aQTpIo15SKCD7qIr9xyTciokKr5S36GilBki tXh5OGf3qmFnzPApT9fBggMHJ7BZIc9a9/2MNSP6u7iFJwPfmODiBszhEDv6f5HIqrpkO9LTq yVPBv/iWDFnnQe8F14D3TiYldrSiTaArlM5hA8BSyUtJIiLhOoSGLkVwvdpZaK5l/MsdqXPKS oLscBqV/cWReQ4WmxHIUxPsJ5AK6aUGb467ATEligOpYbwR7p4LtfbUjSxKkHL3wrh5BdSEbm fVaTk= Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org With the introduction of Documentation/sphinx/automarkup.py, socket() is parsed as a reference to the in-kernel definition of socket. Sphinx then decides that struct socket is a good match, which is usually not intended, when the syscall is meant instead. This was observed in Documentation/networking/af_xdp.rst. Prevent socket() from being misinterpreted by adding it to the Skipfuncs list in automarkup.py. Signed-off-by: Jonathan Neuschäfer Reviewed-by: Mauro Carvalho Chehab --- v2: - block socket() in Documentation/sphinx/automarkup.py, as suggested by Jonathan Corbet v1: - https://lore.kernel.org/lkml/20190810121738.19587-1-j.neuschaefer@gmx.net/ --- Documentation/sphinx/automarkup.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) -- 2.20.1 diff --git a/Documentation/sphinx/automarkup.py b/Documentation/sphinx/automarkup.py index a8798369e8f7..5b6119ff69f4 100644 --- a/Documentation/sphinx/automarkup.py +++ b/Documentation/sphinx/automarkup.py @@ -26,7 +26,8 @@ RE_function = re.compile(r'([\w_][\w\d_]+\(\))') # just don't even try with these names. # Skipfuncs = [ 'open', 'close', 'read', 'write', 'fcntl', 'mmap', - 'select', 'poll', 'fork', 'execve', 'clone', 'ioctl'] + 'select', 'poll', 'fork', 'execve', 'clone', 'ioctl', + 'socket' ] # # Find all occurrences of function() and try to replace them with