From patchwork Wed Jun 26 17:28:56 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Corbet X-Patchwork-Id: 167850 Delivered-To: patch@linaro.org Received: by 2002:a92:4782:0:0:0:0:0 with SMTP id e2csp1228596ilk; Wed, 26 Jun 2019 10:36:09 -0700 (PDT) X-Google-Smtp-Source: APXvYqxoLJbN40axZ2POZmXsq4e/27Wt5X7StMAuhjBIxGFlplBnQXFY6Io0hHjTdf+1Vryc4f9b X-Received: by 2002:a17:90a:37e9:: with SMTP id v96mr297203pjb.10.1561570568943; Wed, 26 Jun 2019 10:36:08 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1561570568; cv=none; d=google.com; s=arc-20160816; b=gvL4WN0/HZ+VybX9ORh0kVzeWx20jfzUGg6C7wT67ithdYMiFuYnIrgMbryMzzoXGz DofLizx1L1rKCgKj0bmDnb7bFG4fv1P5GJgwk+NSyL3vfEOQNQpySA8vL7NRYzXDepXk dkEfxhgfGu+lbQ9zg//fZx1DYUvsGo1AWpIlvEJ7iHpRo2FN5M1Bogu9yU81acPx2lVD fGHHkZDq037W0Ag0uYL/NpOKSbBI3DN11rUdbYdOZyzlJCKJHXaf0I7VUvVB43sMYqqI 7Gv7RDJXFbJzYvBiA8V3vibV/c7dHQi4oQFT+45V990N3rK4tUzNWCU7VcIVLDl8FIk2 zMkg== 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=Th4DRwa+donrWO6Np1YJLL9hHkxHmZaXZ2Yqy/zXsS0=; b=VmK5zD7zLKvQ9+94nfyVMr2PfQHmo5k2fG+olWs0BKQ3xbr7BMXo3dcrVORObntK0H 7aNE8FlV7BHlO4NEPH5Z2UMfBRIqNZiGGYDwqCPTUIGLDMyvjmuq+4Gd82WGe1hlBJm0 STeUOP/7ohbKVwzHTNggko1TVMtCFEjISrGKFTsMPhFgYtmYDV9Z8ixfsAqI9BsTOaXN lTkGhfGXfCoHC9jFrKAcVF3NwXJwzarxVOXSBVYm1XsAT1l0q1zvIrzQDG2a9DjExN9r lb05RQz4+uO1UfTEEKI87kPJPM+JWl3nli8htZ5BAOjpr3XJ0wHmUj2p3rwKBuLO0bCj FywQ== 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.08; Wed, 26 Jun 2019 10:36:08 -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 S1726559AbfFZRf6 (ORCPT + 30 others); Wed, 26 Jun 2019 13:35:58 -0400 Received: from ms.lwn.net ([45.79.88.28]:40908 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726500AbfFZRf4 (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 B20FE2AE; Wed, 26 Jun 2019 17:29:10 +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 1/4] Docs: An initial automarkup extension for sphinx Date: Wed, 26 Jun 2019 11:28:56 -0600 Message-Id: <20190626172859.16113-2-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 Rather than fill our text files with :c:func:`function()` syntax, just do the markup via a hook into the sphinx build process. Signed-off-by: Jonathan Corbet --- Documentation/conf.py | 3 +- Documentation/sphinx/automarkup.py | 93 ++++++++++++++++++++++++++++++ 2 files changed, 95 insertions(+), 1 deletion(-) create mode 100644 Documentation/sphinx/automarkup.py -- 2.21.0 diff --git a/Documentation/conf.py b/Documentation/conf.py index 7ace3f8852bd..a502baecbb85 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -34,7 +34,8 @@ needs_sphinx = '1.3' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain', 'kfigure', 'sphinx.ext.ifconfig'] +extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain', + 'kfigure', 'sphinx.ext.ifconfig', 'automarkup'] # The name of the math extension changed on Sphinx 1.4 if (major == 1 and minor > 3) or (major > 1): diff --git a/Documentation/sphinx/automarkup.py b/Documentation/sphinx/automarkup.py new file mode 100644 index 000000000000..b300cf129869 --- /dev/null +++ b/Documentation/sphinx/automarkup.py @@ -0,0 +1,93 @@ +# SPDX-License-Identifier: GPL-2.0 +# Copyright 2019 Jonathan Corbet +# +# Apply kernel-specific tweaks after the initial document processing +# has been done. +# +from docutils import nodes +from sphinx import addnodes +import re + +# +# Regex nastiness. Of course. +# Try to identify "function()" that's not already marked up some +# other way. Sphinx doesn't like a lot of stuff right after a +# :c:func: block (i.e. ":c:func:`mmap()`s" flakes out), so the last +# bit tries to restrict matches to things that won't create trouble. +# +RE_function = re.compile(r'([\w_][\w\d_]+\(\))') + +# +# Many places in the docs refer to common system calls. It is +# pointless to try to cross-reference them and, as has been known +# to happen, somebody defining a function by these names can lead +# to the creation of incorrect and confusing cross references. So +# just don't even try with these names. +# +Skipfuncs = [ 'open', 'close', 'read', 'write', 'fcntl', 'mmap' + 'select', 'poll', 'fork', 'execve', 'clone', 'ioctl'] + +# +# Find all occurrences of function() and try to replace them with +# appropriate cross references. +# +def markup_funcs(docname, app, node): + cdom = app.env.domains['c'] + t = node.astext() + done = 0 + repl = [ ] + for m in RE_function.finditer(t): + # + # Include any text prior to function() as a normal text node. + # + if m.start() > done: + repl.append(nodes.Text(t[done:m.start()])) + # + # Go through the dance of getting an xref out of the C domain + # + target = m.group(1)[:-2] + target_text = nodes.Text(target + '()') + xref = None + if target not in Skipfuncs: + lit_text = nodes.literal(classes=['xref', 'c', 'c-func']) + lit_text += target_text + pxref = addnodes.pending_xref('', refdomain = 'c', + reftype = 'function', + reftarget = target, modname = None, + classname = None) + xref = cdom.resolve_xref(app.env, docname, app.builder, + 'function', target, pxref, lit_text) + # + # Toss the xref into the list if we got it; otherwise just put + # the function text. + # + if xref: + repl.append(xref) + else: + repl.append(target_text) + done = m.end() + if done < len(t): + repl.append(nodes.Text(t[done:])) + return repl + +def auto_markup(app, doctree, name): + # + # This loop could eventually be improved on. Someday maybe we + # want a proper tree traversal with a lot of awareness of which + # kinds of nodes to prune. But this works well for now. + # + # The nodes.literal test catches ``literal text``, its purpose is to + # avoid adding cross-references to functions that have been explicitly + # marked with cc:func:. + # + for para in doctree.traverse(nodes.paragraph): + for node in para.traverse(nodes.Text): + if not isinstance(node.parent, nodes.literal): + node.parent.replace(node, markup_funcs(name, app, node)) + +def setup(app): + app.connect('doctree-resolved', auto_markup) + return { + 'parallel_read_safe': True, + 'parallel_write_safe': True, + }