From nobody Tue Nov 5 14:49:18 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1586629856; cv=none; d=zohomail.com; s=zohoarc; b=Q+akW47oJW/SXJfRpbhhGQSh33kUcVo754GZyw+PGhQExRGga7KPSbJxWsWlJ293ptbN9OFYb4OqMjQJbz8HW1sZXyg3B/pJOjtXIEmMOrnPQs+3F47itY2JtNU+ULtXGvK3wziiObFnuXsIXBObI5WF0rtCVycGn6HXHkeXD98= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1586629856; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=cpLtHaTY+G/TD4kqalXzNVJElnY3acdoI1jKCfsmqWw=; b=iQOTtl/Pq1TW9AtWd5y/0qnGGS6ncAlny8u3sAL5QGQp8rzCE9h/tutu1HGmqyjo5cLcrWx4PGtGwLQmFfipjbt6q1mwTj0xZoQHxCZE3zz9SKX09ZfNP043JWs67hZ0zjcAyv+iMDlizVpWa0T/+3G5ZwZZ10cJ9h3IUvUykyY= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1586629856290214.6733158356866; Sat, 11 Apr 2020 11:30:56 -0700 (PDT) Received: from localhost ([::1]:54588 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jNKu6-0006vv-St for importer@patchew.org; Sat, 11 Apr 2020 14:30:54 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:34759) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jNKsu-00064v-Lt for qemu-devel@nongnu.org; Sat, 11 Apr 2020 14:29:41 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1jNKst-0003Of-Lv for qemu-devel@nongnu.org; Sat, 11 Apr 2020 14:29:40 -0400 Received: from mail-wm1-x342.google.com ([2a00:1450:4864:20::342]:33713) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1jNKst-0003OE-Ft for qemu-devel@nongnu.org; Sat, 11 Apr 2020 14:29:39 -0400 Received: by mail-wm1-x342.google.com with SMTP id v8so7063717wma.0 for ; Sat, 11 Apr 2020 11:29:39 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id 68sm8910939wrm.65.2020.04.11.11.29.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 11 Apr 2020 11:29:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=cpLtHaTY+G/TD4kqalXzNVJElnY3acdoI1jKCfsmqWw=; b=gISqeKjpJggBy2pSD4148Z7KxiSHHhXr06aemZPoK0c+IQ8N+uWAVFox3PBfOeAObf YH3IWXq28Vd8uQUuaW67Hjtf1K9ZDc8qgzYQ9rZ7K/JXhotmoP9xx/u8MuNaX62SdeXM 7I/9X52YHq8B3vBZmWWaTec91KwvC5Y+K9D8uq6Q+M980h/ONnHCha6va4fB9erj3n13 7vw7uhBvBTcG2fTIyDmYZ0g51E6gwRvGGQrzSG7fYSNRp9le2lWJ7Kwv+Hb0qUlfMZsF 6Z33JvpQyP51GjclL49LNAaknW38WvNIr1CJLDkLEhDeBoZp0w91ujx5He0+JDQmmN6u V/ng== 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:mime-version:content-transfer-encoding; bh=cpLtHaTY+G/TD4kqalXzNVJElnY3acdoI1jKCfsmqWw=; b=I4umPSCelNWD9aqhoE6qJOgwQOQFZt3csLLj24j5pKNA2kvFfRvwBdyfZkNbM3O23l KB6tlQ6gnWOpb3lRsLnQWc+ozZyXo6KuCMahNrC+Wvyd7g0FgdStipsa75KkiBXGUpL+ D+kthRXT4trrpxXO0zBc+qBEZ00UC9slIcr9i4BCoYZtSGz99ayKjs4wkq0RSCAe8Ai2 m+GKJrKkD0H2SsggkNzpunlUrDqr99wFSPZ9A+HUFQpQJzQPZ6xr0tw5cFdNdlNqjv1b OHRY4myI/HTJ6uX5T6zL4KLlaMssszHCPByX5NihbjlzRuuuwHavcxK6Yq7rW2j4X3be TduQ== X-Gm-Message-State: AGi0PuaFyZMsZibsYZNDZrTGH8eyq0+Pg7AsonA8vgdXSHgB5zymDox+ DQeJryIFW2sxcxMc6B10D88No1uDrhvyYw== X-Google-Smtp-Source: APiQypIiDRNqiGiMXXdgsMDqhRzJN4SqLGl21C7+eZnR1LusBqTFKdaqxrsKXLG214Fu6khcABDsiQ== X-Received: by 2002:a1c:35c3:: with SMTP id c186mr2014125wma.66.1586629778214; Sat, 11 Apr 2020 11:29:38 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH for-5.0? 2/3] scripts/kernel-doc: Add missing close-paren in c:function directives Date: Sat, 11 Apr 2020 19:29:33 +0100 Message-Id: <20200411182934.28678-3-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200411182934.28678-1-peter.maydell@linaro.org> References: <20200411182934.28678-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::342 X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Paolo Bonzini Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @linaro.org) Content-Type: text/plain; charset="utf-8" When kernel-doc generates a 'c:function' directive for a function one of whose arguments is a function pointer, it fails to print the close-paren after the argument list of the function pointer argument, for instance: .. c:function:: void memory_region_init_resizeable_ram (MemoryRegion * mr= , struct Object * owner, const char * name, uint64_t size, uint64_t max_siz= e, void (*resized) (const char*, uint64_t length, void *host, Error ** errp) which should have a ')' after the 'void *host' which is the last argument to 'resized'. Older versions of Sphinx don't try to parse the argumnet to c:function, but Sphinx 3.0 does do this and will complain: /home/petmay01/linaro/qemu-from-laptop/qemu/docs/../include/exec/memory.h= :834: WARNING: Error in declarator or parameters Invalid C declaration: Expecting "," or ")" in parameters, got "EOF". [er= ror at 208] void memory_region_init_resizeable_ram (MemoryRegion * mr, struct Objec= t * owner, const char * name, uint64_t size, uint64_t max_size, void (*resi= zed) (const char*, uint64_t length, void *host, Error ** errp) -----------------------------------------------------------------------= ---------------------------------------------------------------------------= --------------------------------------------------------------^ Add the missing close-paren. Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Reviewed-by: Richard Henderson Tested-by: Alex Benn=C3=A9e --- scripts/kernel-doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index af470eb3211..8dc30e01e58 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -853,7 +853,7 @@ sub output_function_rst(%) { =20 if ($type =3D~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { # pointer-to-function - print $1 . $parameter . ") (" . $2; + print $1 . $parameter . ") (" . $2 . ")"; } else { print $type . " " . $parameter; } --=20 2.20.1