From patchwork Wed Jun 26 17:28:59 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Corbet X-Patchwork-Id: 167851 Delivered-To: patch@linaro.org Received: by 2002:a92:4782:0:0:0:0:0 with SMTP id e2csp1228673ilk; Wed, 26 Jun 2019 10:36:13 -0700 (PDT) X-Google-Smtp-Source: APXvYqy2MlPE2mbOU976Tu2tNlQ/M5O42nE0tE0/JmHQgeGZzHcCafbiGKe5Cn3Y9a9FTftFis+u X-Received: by 2002:a17:90a:634a:: with SMTP id v10mr309444pjs.16.1561570573461; Wed, 26 Jun 2019 10:36:13 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1561570573; cv=none; d=google.com; s=arc-20160816; b=H83bAGi8144zsqBhU7QKiqJDU+v+vvs6Rta0b2UNpGusY+gz9V88fBecYuYe5pQeKN J750BsjkW/dntP51ifGnP3Cf8r+11gq6AgZDm2Tq6YoGTx/iv4kx32zXr1ogBVYPrAFC 2RaBN+COxq2bu+PE1aGHyPrwmGAv7RyiUtoQOo1WBifgKAkv877P0L7jzuCAXecFYoDZ QGd6WVTEQiEt48rkiBA7ntM+xA4gsRn0CSLQKcROcoKeEkbcxphQXT8Ct4wB6uXoyJiJ Pq+V7Oy8EgtObDFd+jSir5XmQkK61BX3dy7Z48iJGMhzmRd+xoSOExBeXjt2Qy6iCi0a U/pA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from; bh=963I5RK8XqUXttwCyRrpTGznPkuHdoEoNRfPF18yckM=; b=F/7a+36/VZaO8zV81w3LxiUcQdjVMQKizisyzWUadLM48NqSmpRrp+OcUsITVt3mBB bjT27lnTmY8pV4AHkDSZGBTofIkRRD64gvNnUVfnWDBxvxMMZLa7kytNmMhDd0qJEVxv u+iXd+kvJFFZH6s2ZmhqJBZvVO0IkFrtMfKvEBMJRRCyS9QFgcMcU78s6FOW6BlSG73i zX3VZuyuHMJTsck0nr+Orf4O8kaUaF9bY5YN+3sZfwJPxtVQA5VkY3WBpMlddUZvORq7 oP0+EX5dDjoWLbtnN2BO70Bnj5aOdHM7bULNI9VcUvLu2+UcxRbr4vHFZ/sGb/DV4DqK rjOA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id bj12si3674019plb.378.2019.06.26.10.36.13; Wed, 26 Jun 2019 10:36:13 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726650AbfFZRgM (ORCPT + 30 others); Wed, 26 Jun 2019 13:36:12 -0400 Received: from ms.lwn.net ([45.79.88.28]:40900 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726042AbfFZRf4 (ORCPT ); Wed, 26 Jun 2019 13:35:56 -0400 Received: from meer.lwn.net (localhost [127.0.0.1]) by ms.lwn.net (Postfix) with ESMTPA id CEB978E7; Wed, 26 Jun 2019 17:29:11 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: Mauro Carvalho Chehab , Jani Nikula , linux-kernel@vger.kernel.org, Jonathan Corbet Subject: [PATCH v3 4/4] docs: Note that :c:func: should no longer be used Date: Wed, 26 Jun 2019 11:28:59 -0600 Message-Id: <20190626172859.16113-5-corbet@lwn.net> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20190626172859.16113-1-corbet@lwn.net> References: <20190626172859.16113-1-corbet@lwn.net> MIME-Version: 1.0 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Now that we can mark up function() automatically, there is no reason to use :c:func: and every reason to avoid it. Adjust the documentation to reflect that fact. Signed-off-by: Jonathan Corbet --- Documentation/doc-guide/sphinx.rst | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) -- 2.21.0 diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst index e60a56640c63..f71ddd592aaa 100644 --- a/Documentation/doc-guide/sphinx.rst +++ b/Documentation/doc-guide/sphinx.rst @@ -241,11 +241,14 @@ The C domain of the kernel-doc has some additional features. E.g. you can The func-name (e.g. ioctl) remains in the output but the ref-name changed from ``ioctl`` to ``VIDIOC_LOG_STATUS``. The index entry for this function is also -changed to ``VIDIOC_LOG_STATUS`` and the function can now referenced by: - -.. code-block:: rst - - :c:func:`VIDIOC_LOG_STATUS` +changed to ``VIDIOC_LOG_STATUS``. + +Please note that there is no need to use ``c:func:`` to generate cross +references to function documentation. Due to some Sphinx extension magic, +the documentation build system will automatically turn a reference to +``function()`` into a cross reference if an index entry for the given +function name exists. If you see ``c:func:`` use in a kernel document, +please feel free to remove it. list tables