From nobody Sun Apr 28 13:30:33 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.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=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1572366403; cv=none; d=zoho.com; s=zohoarc; b=ZYOvooZ6pPBXFsL50kyv33G9LaDJ5yY+5+MYUn5ZA30RHof4bG3NkPncyfm3Agg7xsCKl3wGjCELzts4ljUvSot1/rZe5XtfPiTRJ5GwO4Awp41M29doGQZHjz8+9NIiZeNP2J7m3skdz+5IHVtZvZKv+RZXpZUXXTnICuHBBx4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1572366403; 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=oRjZu6nuVpN9B9aD5vIwXrGD79YFj1GoaGeYYhTV0tM=; b=BOCm2iz24ZXqJxXsse9POTcetsv1/rthYoZVY2vi151siL3E9FDSUvdJd8xoszzbJQN+OZj0kofJ6hcH2fGmlLyT03X/hTMvv7l4k7gHw5+nKYer0+aG/Cg9/Al5AVLx2iLC2Nmn5I3M4MjupdclrDPwXpXyMg9wzbfyUR4tiXg= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail 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 1572366403870346.7149964378125; Tue, 29 Oct 2019 09:26:43 -0700 (PDT) Received: from localhost ([::1]:59648 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iPUKN-0006hg-2g for importer@patchew.org; Tue, 29 Oct 2019 12:26:39 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50736) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iPUGr-0002BA-8J for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:23:08 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iPUGk-0004rL-Hv for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:23:01 -0400 Received: from mail-wm1-x341.google.com ([2a00:1450:4864:20::341]:38836) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iPUGk-0004qs-3J for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:22:54 -0400 Received: by mail-wm1-x341.google.com with SMTP id 22so3079375wms.3 for ; Tue, 29 Oct 2019 09:22:54 -0700 (PDT) Received: from donizetti.metropole.lan (94.222.26.109.rev.sfr.net. [109.26.222.94]) by smtp.gmail.com with ESMTPSA id q12sm9285661wrw.91.2019.10.29.09.22.49 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 29 Oct 2019 09:22:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=oRjZu6nuVpN9B9aD5vIwXrGD79YFj1GoaGeYYhTV0tM=; b=PwqUdExdV5yY4Fx5QI69x8NIZ4+RQfStIzAMoUYHKF9I68WyR9HQJ1dVcUhq5w8Tik YRti4n7mp8y1umm5F08DybPJWQziN4N1HNnRWcmd0lzOkRJ8Wt/dGW0NvY0YeC7OeHd3 0LLEKF8GaN4XpHNcoCOMisVoDi66pXA20YI0f/pqqbWcMqcfKOdWXKTus9T0nNeLev4J UQ2uBnryCsG+MN2VUD9TPcAu6UMXZRXt9mHUwhZUt9Q7QxjPTPlBCVlkQA0tCstI+Ko4 lMvOtZu+Mt74MtraqDau1eQtObrrzIUMiHn+1xjeZFW5TdqnjMEmYtFd3Is9K+RpE6U7 u1sQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=oRjZu6nuVpN9B9aD5vIwXrGD79YFj1GoaGeYYhTV0tM=; b=FlLDRbM3LqiyFoD1Lrz/qhvLN2KrbRZfaYZEIoEl4PQthh+Mk/jM2AEbl1scxYHz5j LzRa5LDxRPkl1pBhBcCSll4p0SeaILRLkHcK2K4OQncILiRFFpHadQWa9QTGvW6qqWRu kmiabWXALpfjex2EH6pq231TVrVW3oThCM8fWlk3U2mPoUz7DtcBI7ZD/JbkbJW4RYqd TDOeFNUSAI+CJrkkFykkNOqKHiVmRSleEzIwsu03+2ONNDgsKiYwxUPDmj6zxVGMkYZk 3eI1wKbI7iblVkPu6/nSZLaom8s0tzoVq5ZcOM0fsjZIvMqcFM8cz1Bh7m0JveRTJvl6 P37A== X-Gm-Message-State: APjAAAXQxAZhBHQfNl0N79QHmXmwqOE7qdrwbSE51plFNIdDjfMBE6Hr kwUmlk6LZGQwRzAr+Qe1yaxN+M3WS9c= X-Google-Smtp-Source: APXvYqzegjKPh/Y/j/Hx/LNzHUBJK+qctLDD4ErKggNrnEAh0tusLrh8gGmZRf3B/4ZqNODdVD1eOQ== X-Received: by 2002:a1c:39c1:: with SMTP id g184mr4874024wma.75.1572366170678; Tue, 29 Oct 2019 09:22:50 -0700 (PDT) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PATCH 1/6] docs: import Linux kernel-doc script and extension Date: Tue, 29 Oct 2019 17:22:43 +0100 Message-Id: <20191029162248.13383-2-pbonzini@redhat.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20191029162248.13383-1-pbonzini@redhat.com> References: <20191029162248.13383-1-pbonzini@redhat.com> 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::341 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: peter.maydell@linaro.org Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Import Linux's kernel-doc script, as well as the Linux extension to call kernel-doc according to the arguments and parameters given to a reStructuredText directive. The kernel-doc extension accepts a filename, which is relative to the QEMU source tree root. The extension also notifies Sphinx about the document dependency on the file, causing the document to be rebuilt when the file has been changed. Signed-off-by: Paolo Bonzini --- docs/conf.py | 7 +- docs/sphinx/kernellog.py | 28 + scripts/kernel-doc | 2226 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 2260 insertions(+), 1 deletion(-) create mode 100644 docs/sphinx/kernellog.py create mode 100755 scripts/kernel-doc diff --git a/docs/conf.py b/docs/conf.py index 83131ac187..7bf2d0d58b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -54,7 +54,7 @@ needs_sphinx =3D '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 =3D ['qmp_lexer'] +extensions =3D ['kerneldoc', 'qmp_lexer'] =20 # Add any paths that contain templates here, relative to this directory. templates_path =3D ['_templates'] @@ -215,4 +215,9 @@ texinfo_documents =3D [ ] =20 =20 +# kernel-doc extension configuration for running Sphinx directly (e.g. by = Read +# the Docs). In a normal build, these are supplied from the Makefile via c= ommand +# line arguments. +kerneldoc_bin =3D '../scripts/kernel-doc' +kerneldoc_srctree =3D '..' =20 diff --git a/docs/sphinx/kernellog.py b/docs/sphinx/kernellog.py new file mode 100644 index 0000000000..af924f51a7 --- /dev/null +++ b/docs/sphinx/kernellog.py @@ -0,0 +1,28 @@ +# SPDX-License-Identifier: GPL-2.0 +# +# Sphinx has deprecated its older logging interface, but the replacement +# only goes back to 1.6. So here's a wrapper layer to keep around for +# as long as we support 1.4. +# +import sphinx + +if sphinx.__version__[:3] >=3D '1.6': + UseLogging =3D True + from sphinx.util import logging + logger =3D logging.getLogger('kerneldoc') +else: + UseLogging =3D False + +def warn(app, message): + if UseLogging: + logger.warning(message) + else: + app.warn(message) + +def verbose(app, message): + if UseLogging: + logger.verbose(message) + else: + app.verbose(message) + + diff --git a/scripts/kernel-doc b/scripts/kernel-doc new file mode 100755 index 0000000000..81dc91760b --- /dev/null +++ b/scripts/kernel-doc @@ -0,0 +1,2226 @@ +#!/usr/bin/env perl +# SPDX-License-Identifier: GPL-2.0 + +use warnings; +use strict; + +## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## +## Copyright (C) 2000, 1 Tim Waugh ## +## Copyright (C) 2001 Simon Huggins ## +## Copyright (C) 2005-2012 Randy Dunlap ## +## Copyright (C) 2012 Dan Luedtke ## +## ## +## #define enhancements by Armin Kuster ## +## Copyright (c) 2000 MontaVista Software, Inc. ## +## ## +## This software falls under the GNU General Public License. ## +## Please read the COPYING file for more information ## + +# 18/01/2001 - Cleanups +# Functions prototyped as foo(void) same as foo() +# Stop eval'ing where we don't need to. +# -- huggie@earth.li + +# 27/06/2001 - Allowed whitespace after initial "/**" and +# allowed comments before function declarations. +# -- Christian Kreibich + +# Still to do: +# - add perldoc documentation +# - Look more closely at some of the scarier bits :) + +# 26/05/2001 - Support for separate source and object trees. +# Return error code. +# Keith Owens + +# 23/09/2001 - Added support for typedefs, structs, enums and unions +# Support for Context section; can be terminated using empty = line +# Small fixes (like spaces vs. \s in regex) +# -- Tim Jansen + +# 25/07/2012 - Added support for HTML5 +# -- Dan Luedtke + +sub usage { + my $message =3D <<"EOF"; +Usage: $0 [OPTION ...] FILE ... + +Read C language source or header FILEs, extract embedded documentation com= ments, +and print formatted documentation to standard output. + +The documentation comments are identified by "/**" opening comment mark. S= ee +Documentation/doc-guide/kernel-doc.rst for the documentation comment synta= x. + +Output format selection (mutually exclusive): + -man Output troff manual page format. This is the default. + -rst Output reStructuredText format. + -none Do not output documentation, only warnings. + +Output selection (mutually exclusive): + -export Only output documentation for symbols that have been + exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() + in any input FILE or -export-file FILE. + -internal Only output documentation for symbols that have NOT been + exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL() + in any input FILE or -export-file FILE. + -function NAME Only output documentation for the given function(s) + or DOC: section title(s). All other functions and DOC: + sections are ignored. May be specified multiple times. + -nofunction NAME Do NOT output documentation for the given function(s); + only output documentation for the other functions and + DOC: sections. May be specified multiple times. + +Output selection modifiers: + -no-doc-sections Do not output DOC: sections. + -enable-lineno Enable output of #define LINENO lines. Only works = with + reStructuredText format. + -export-file FILE Specify an additional FILE in which to look for + EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be use= d with + -export or -internal. May be specified multiple ti= mes. + +Other parameters: + -v Verbose output, more warnings and other information. + -h Print this help. + +EOF + print $message; + exit 1; +} + +# +# format of comments. +# In the following table, (...)? signifies optional structure. +# (...)* signifies 0 or more structure elements +# /** +# * function_name(:)? (- short description)? +# (* @parameterx: (description of parameter x)?)* +# (* a blank line)? +# * (Description:)? (Description of function)? +# * (section header: (section description)? )* +# (*)?*/ +# +# So .. the trivial example would be: +# +# /** +# * my_function +# */ +# +# If the Description: header tag is omitted, then there must be a blank li= ne +# after the last parameter specification. +# e.g. +# /** +# * my_function - does my stuff +# * @my_arg: its mine damnit +# * +# * Does my stuff explained. +# */ +# +# or, could also use: +# /** +# * my_function - does my stuff +# * @my_arg: its mine damnit +# * Description: Does my stuff explained. +# */ +# etc. +# +# Besides functions you can also write documentation for structs, unions, +# enums and typedefs. Instead of the function name you must write the name +# of the declaration; the struct/union/enum/typedef must always precede +# the name. Nesting of declarations is not supported. +# Use the argument mechanism to document members or constants. +# e.g. +# /** +# * struct my_struct - short description +# * @a: first member +# * @b: second member +# * +# * Longer description +# */ +# struct my_struct { +# int a; +# int b; +# /* private: */ +# int c; +# }; +# +# All descriptions can be multiline, except the short function description. +# +# For really longs structs, you can also describe arguments inside the +# body of the struct. +# eg. +# /** +# * struct my_struct - short description +# * @a: first member +# * @b: second member +# * +# * Longer description +# */ +# struct my_struct { +# int a; +# int b; +# /** +# * @c: This is longer description of C +# * +# * You can use paragraphs to describe arguments +# * using this method. +# */ +# int c; +# }; +# +# This should be use only for struct/enum members. +# +# You can also add additional sections. When documenting kernel functions = you +# should document the "Context:" of the function, e.g. whether the functio= ns +# can be called form interrupts. Unlike other sections you can end it with= an +# empty line. +# A non-void function should have a "Return:" section describing the return +# value(s). +# Example-sections should contain the string EXAMPLE so that they are mark= ed +# appropriately in DocBook. +# +# Example: +# /** +# * user_function - function that can only be called in user context +# * @a: some argument +# * Context: !in_interrupt() +# * +# * Some description +# * Example: +# * user_function(22); +# */ +# ... +# +# +# All descriptive text is further processed, scanning for the following sp= ecial +# patterns, which are highlighted appropriately. +# +# 'funcname()' - function +# '$ENVVAR' - environmental variable +# '&struct_name' - name of a structure (up to two words including 'struct') +# '&struct_name.member' - name of a structure member +# '@parameter' - name of a parameter +# '%CONST' - name of a constant. +# '``LITERAL``' - literal string without any spaces on it. + +## init lots of data + +my $errors =3D 0; +my $warnings =3D 0; +my $anon_struct_union =3D 0; + +# match expressions used to find embedded type information +my $type_constant =3D '\b``([^\`]+)``\b'; +my $type_constant2 =3D '\%([-_\w]+)'; +my $type_func =3D '(\w+)\(\)'; +my $type_param =3D '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; +my $type_fp_param =3D '\@(\w+)\(\)'; # Special RST handling for func ptr = params +my $type_env =3D '(\$\w+)'; +my $type_enum =3D '\&(enum\s*([_\w]+))'; +my $type_struct =3D '\&(struct\s*([_\w]+))'; +my $type_typedef =3D '\&(typedef\s*([_\w]+))'; +my $type_union =3D '\&(union\s*([_\w]+))'; +my $type_member =3D '\&([_\w]+)(\.|->)([_\w]+)'; +my $type_fallback =3D '\&([_\w]+)'; +my $type_member_func =3D $type_member . '\(\)'; + +# Output conversion substitutions. +# One for each output format + +# these are pretty rough +my @highlights_man =3D ( + [$type_constant, "\$1"], + [$type_constant2, "\$1"], + [$type_func, "\\\\fB\$1\\\\fP"], + [$type_enum, "\\\\fI\$1\\\\fP"], + [$type_struct, "\\\\fI\$1\\\\fP"], + [$type_typedef, "\\\\fI\$1\\\\fP"], + [$type_union, "\\\\fI\$1\\\\fP"], + [$type_param, "\\\\fI\$1\\\\fP"], + [$type_member, "\\\\fI\$1\$2\$3\\\\fP"], + [$type_fallback, "\\\\fI\$1\\\\fP"] + ); +my $blankline_man =3D ""; + +# rst-mode +my @highlights_rst =3D ( + [$type_constant, "``\$1``"], + [$type_constant2, "``\$1``"], + # Note: need to escape () to avoid func matching la= ter + [$type_member_func, "\\:c\\:type\\:`\$1\$2\$3\\\\(\= \\\) <\$1>`"], + [$type_member, "\\:c\\:type\\:`\$1\$2\$3 <\$1>`"], + [$type_fp_param, "**\$1\\\\(\\\\)**"], + [$type_func, "\$1()"], + [$type_enum, "\\:c\\:type\\:`\$1 <\$2>`"], + [$type_struct, "\\:c\\:type\\:`\$1 <\$2>`"], + [$type_typedef, "\\:c\\:type\\:`\$1 <\$2>`"], + [$type_union, "\\:c\\:type\\:`\$1 <\$2>`"], + # in rst this can refer to any type + [$type_fallback, "\\:c\\:type\\:`\$1`"], + [$type_param, "**\$1**"] + ); +my $blankline_rst =3D "\n"; + +# read arguments +if ($#ARGV =3D=3D -1) { + usage(); +} + +my $kernelversion; +my $dohighlight =3D ""; + +my $verbose =3D 0; +my $output_mode =3D "rst"; +my $output_preformatted =3D 0; +my $no_doc_sections =3D 0; +my $enable_lineno =3D 0; +my @highlights =3D @highlights_rst; +my $blankline =3D $blankline_rst; +my $modulename =3D "Kernel API"; + +use constant { + OUTPUT_ALL =3D> 0, # output all symbols and doc sections + OUTPUT_INCLUDE =3D> 1, # output only specified symbols + OUTPUT_EXCLUDE =3D> 2, # output everything except specified symbo= ls + OUTPUT_EXPORTED =3D> 3, # output exported symbols + OUTPUT_INTERNAL =3D> 4, # output non-exported symbols +}; +my $output_selection =3D OUTPUT_ALL; +my $show_not_found =3D 0; # No longer used + +my @export_file_list; + +my @build_time; +if (defined($ENV{'KBUILD_BUILD_TIMESTAMP'}) && + (my $seconds =3D `date -d"${ENV{'KBUILD_BUILD_TIMESTAMP'}}" +%s`) ne '= ') { + @build_time =3D gmtime($seconds); +} else { + @build_time =3D localtime; +} + +my $man_date =3D ('January', 'February', 'March', 'April', 'May', 'June', + 'July', 'August', 'September', 'October', + 'November', 'December')[$build_time[4]] . + " " . ($build_time[5]+1900); + +# Essentially these are globals. +# They probably want to be tidied up, made more localised or something. +# CAVEAT EMPTOR! Some of the others I localised may not want to be, which +# could cause "use of undefined value" or other bugs. +my ($function, %function_table, %parametertypes, $declaration_purpose); +my $declaration_start_line; +my ($type, $declaration_name, $return_type); +my ($newsection, $newcontents, $prototype, $brcount, %source_map); + +if (defined($ENV{'KBUILD_VERBOSE'})) { + $verbose =3D "$ENV{'KBUILD_VERBOSE'}"; +} + +# Generated docbook code is inserted in a template at a point where +# docbook v3.1 requires a non-zero sequence of RefEntry's; see: +# http://www.oasis-open.org/docbook/documentation/reference/html/refentry.= html +# We keep track of number of generated entries and generate a dummy +# if needs be to ensure the expanded template can be postprocessed +# into html. +my $section_counter =3D 0; + +my $lineprefix=3D""; + +# Parser states +use constant { + STATE_NORMAL =3D> 0, # normal code + STATE_NAME =3D> 1, # looking for function name + STATE_BODY_MAYBE =3D> 2, # body - or maybe more description + STATE_BODY =3D> 3, # the body of the comment + STATE_PROTO =3D> 4, # scanning prototype + STATE_DOCBLOCK =3D> 5, # documentation block + STATE_INLINE =3D> 6, # gathering documentation outside main blo= ck +}; +my $state; +my $in_doc_sect; +my $leading_space; + +# Inline documentation state +use constant { + STATE_INLINE_NA =3D> 0, # not applicable ($state !=3D STATE_INLINE) + STATE_INLINE_NAME =3D> 1, # looking for member name (@foo:) + STATE_INLINE_TEXT =3D> 2, # looking for member documentation + STATE_INLINE_END =3D> 3, # done + STATE_INLINE_ERROR =3D> 4, # error - Comment without header was found. + # Spit a warning as it's not + # proper kernel-doc and ignore the rest. +}; +my $inline_doc_state; + +#declaration types: can be +# 'function', 'struct', 'union', 'enum', 'typedef' +my $decl_type; + +my $doc_start =3D '^/\*\*\s*$'; # Allow whitespace at end of comment start. +my $doc_end =3D '\*/'; +my $doc_com =3D '\s*\*\s*'; +my $doc_com_body =3D '\s*\* ?'; +my $doc_decl =3D $doc_com . '(\w+)'; +# @params and a strictly limited set of supported section names +my $doc_sect =3D $doc_com . + '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\= s*:(.*)'; +my $doc_content =3D $doc_com_body . '(.*)'; +my $doc_block =3D $doc_com . 'DOC:\s*(.*)?'; +my $doc_inline_start =3D '^\s*/\*\*\s*$'; +my $doc_inline_sect =3D '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)'; +my $doc_inline_end =3D '^\s*\*/\s*$'; +my $doc_inline_oneline =3D '^\s*/\*\*\s*(@[\w\s]+):\s*(.*)\s*\*/\s*$'; +my $export_symbol =3D '^\s*EXPORT_SYMBOL(_GPL)?\s*\(\s*(\w+)\s*\)\s*;'; + +my %parameterdescs; +my %parameterdesc_start_lines; +my @parameterlist; +my %sections; +my @sectionlist; +my %section_start_lines; +my $sectcheck; +my $struct_actual; + +my $contents =3D ""; +my $new_start_line =3D 0; + +# the canonical section names. see also $doc_sect above. +my $section_default =3D "Description"; # default section +my $section_intro =3D "Introduction"; +my $section =3D $section_default; +my $section_context =3D "Context"; +my $section_return =3D "Return"; + +my $undescribed =3D "-- undescribed --"; + +reset_state(); + +while ($ARGV[0] =3D~ m/^--?(.*)/) { + my $cmd =3D $1; + shift @ARGV; + if ($cmd eq "man") { + $output_mode =3D "man"; + @highlights =3D @highlights_man; + $blankline =3D $blankline_man; + } elsif ($cmd eq "rst") { + $output_mode =3D "rst"; + @highlights =3D @highlights_rst; + $blankline =3D $blankline_rst; + } elsif ($cmd eq "none") { + $output_mode =3D "none"; + } elsif ($cmd eq "module") { # not needed for XML, inherits from calli= ng document + $modulename =3D shift @ARGV; + } elsif ($cmd eq "function") { # to only output specific functions + $output_selection =3D OUTPUT_INCLUDE; + $function =3D shift @ARGV; + $function_table{$function} =3D 1; + } elsif ($cmd eq "nofunction") { # output all except specific functions + $output_selection =3D OUTPUT_EXCLUDE; + $function =3D shift @ARGV; + $function_table{$function} =3D 1; + } elsif ($cmd eq "export") { # only exported symbols + $output_selection =3D OUTPUT_EXPORTED; + %function_table =3D (); + } elsif ($cmd eq "internal") { # only non-exported symbols + $output_selection =3D OUTPUT_INTERNAL; + %function_table =3D (); + } elsif ($cmd eq "export-file") { + my $file =3D shift @ARGV; + push(@export_file_list, $file); + } elsif ($cmd eq "v") { + $verbose =3D 1; + } elsif (($cmd eq "h") || ($cmd eq "help")) { + usage(); + } elsif ($cmd eq 'no-doc-sections') { + $no_doc_sections =3D 1; + } elsif ($cmd eq 'enable-lineno') { + $enable_lineno =3D 1; + } elsif ($cmd eq 'show-not-found') { + $show_not_found =3D 1; # A no-op but don't fail + } else { + # Unknown argument + usage(); + } +} + +# continue execution near EOF; + +# get kernel version from env +sub get_kernel_version() { + my $version =3D 'unknown kernel version'; + + if (defined($ENV{'KERNELVERSION'})) { + $version =3D $ENV{'KERNELVERSION'}; + } + return $version; +} + +# +sub print_lineno { + my $lineno =3D shift; + if ($enable_lineno && defined($lineno)) { + print "#define LINENO " . $lineno . "\n"; + } +} +## +# dumps section contents to arrays/hashes intended for that purpose. +# +sub dump_section { + my $file =3D shift; + my $name =3D shift; + my $contents =3D join "\n", @_; + + if ($name =3D~ m/$type_param/) { + $name =3D $1; + $parameterdescs{$name} =3D $contents; + $sectcheck =3D $sectcheck . $name . " "; + $parameterdesc_start_lines{$name} =3D $new_start_line; + $new_start_line =3D 0; + } elsif ($name eq "@\.\.\.") { + $name =3D "..."; + $parameterdescs{$name} =3D $contents; + $sectcheck =3D $sectcheck . $name . " "; + $parameterdesc_start_lines{$name} =3D $new_start_line; + $new_start_line =3D 0; + } else { + if (defined($sections{$name}) && ($sections{$name} ne "")) { + # Only warn on user specified duplicate section names. + if ($name ne $section_default) { + print STDERR "${file}:$.: warning: duplicate section name '$name'\n"; + ++$warnings; + } + $sections{$name} .=3D $contents; + } else { + $sections{$name} =3D $contents; + push @sectionlist, $name; + $section_start_lines{$name} =3D $new_start_line; + $new_start_line =3D 0; + } + } +} + +## +# dump DOC: section after checking that it should go out +# +sub dump_doc_section { + my $file =3D shift; + my $name =3D shift; + my $contents =3D join "\n", @_; + + if ($no_doc_sections) { + return; + } + + if (($output_selection =3D=3D OUTPUT_ALL) || + ($output_selection =3D=3D OUTPUT_INCLUDE && + defined($function_table{$name})) || + ($output_selection =3D=3D OUTPUT_EXCLUDE && + !defined($function_table{$name}))) + { + dump_section($file, $name, $contents); + output_blockhead({'sectionlist' =3D> \@sectionlist, + 'sections' =3D> \%sections, + 'module' =3D> $modulename, + 'content-only' =3D> ($output_selection !=3D OUTPUT_ALL), }); + } +} + +## +# output function +# +# parameterdescs, a hash. +# function =3D> "function name" +# parameterlist =3D> @list of parameters +# parameterdescs =3D> %parameter descriptions +# sectionlist =3D> @list of sections +# sections =3D> %section descriptions +# + +sub output_highlight { + my $contents =3D join "\n",@_; + my $line; + +# DEBUG +# if (!defined $contents) { +# use Carp; +# confess "output_highlight got called with no args?\n"; +# } + +# print STDERR "contents b4:$contents\n"; + eval $dohighlight; + die $@ if $@; +# print STDERR "contents af:$contents\n"; + + foreach $line (split "\n", $contents) { + if (! $output_preformatted) { + $line =3D~ s/^\s*//; + } + if ($line eq ""){ + if (! $output_preformatted) { + print $lineprefix, $blankline; + } + } else { + if ($output_mode eq "man" && substr($line, 0, 1) eq ".") { + print "\\&$line"; + } else { + print $lineprefix, $line; + } + } + print "\n"; + } +} + +## +# output function in man +sub output_function_man(%) { + my %args =3D %{$_[0]}; + my ($parameter, $section); + my $count; + + print ".TH \"$args{'function'}\" 9 \"$args{'function'}\" \"$man_date\"= \"Kernel Hacker's Manual\" LINUX\n"; + + print ".SH NAME\n"; + print $args{'function'} . " \\- " . $args{'purpose'} . "\n"; + + print ".SH SYNOPSIS\n"; + if ($args{'functiontype'} ne "") { + print ".B \"" . $args{'functiontype'} . "\" " . $args{'function'} . "\n"; + } else { + print ".B \"" . $args{'function'} . "\n"; + } + $count =3D 0; + my $parenth =3D "("; + my $post =3D ","; + foreach my $parameter (@{$args{'parameterlist'}}) { + if ($count =3D=3D $#{$args{'parameterlist'}}) { + $post =3D ");"; + } + $type =3D $args{'parametertypes'}{$parameter}; + if ($type =3D~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { + # pointer-to-function + print ".BI \"" . $parenth . $1 . "\" " . $parameter . " \") (" . $2 .= ")" . $post . "\"\n"; + } else { + $type =3D~ s/([^\*])$/$1 /; + print ".BI \"" . $parenth . $type . "\" " . $parameter . " \"" . $pos= t . "\"\n"; + } + $count++; + $parenth =3D ""; + } + + print ".SH ARGUMENTS\n"; + foreach $parameter (@{$args{'parameterlist'}}) { + my $parameter_name =3D $parameter; + $parameter_name =3D~ s/\[.*//; + + print ".IP \"" . $parameter . "\" 12\n"; + output_highlight($args{'parameterdescs'}{$parameter_name}); + } + foreach $section (@{$args{'sectionlist'}}) { + print ".SH \"", uc $section, "\"\n"; + output_highlight($args{'sections'}{$section}); + } +} + +## +# output enum in man +sub output_enum_man(%) { + my %args =3D %{$_[0]}; + my ($parameter, $section); + my $count; + + print ".TH \"$args{'module'}\" 9 \"enum $args{'enum'}\" \"$man_date\" = \"API Manual\" LINUX\n"; + + print ".SH NAME\n"; + print "enum " . $args{'enum'} . " \\- " . $args{'purpose'} . "\n"; + + print ".SH SYNOPSIS\n"; + print "enum " . $args{'enum'} . " {\n"; + $count =3D 0; + foreach my $parameter (@{$args{'parameterlist'}}) { + print ".br\n.BI \" $parameter\"\n"; + if ($count =3D=3D $#{$args{'parameterlist'}}) { + print "\n};\n"; + last; + } + else { + print ", \n.br\n"; + } + $count++; + } + + print ".SH Constants\n"; + foreach $parameter (@{$args{'parameterlist'}}) { + my $parameter_name =3D $parameter; + $parameter_name =3D~ s/\[.*//; + + print ".IP \"" . $parameter . "\" 12\n"; + output_highlight($args{'parameterdescs'}{$parameter_name}); + } + foreach $section (@{$args{'sectionlist'}}) { + print ".SH \"$section\"\n"; + output_highlight($args{'sections'}{$section}); + } +} + +## +# output struct in man +sub output_struct_man(%) { + my %args =3D %{$_[0]}; + my ($parameter, $section); + + print ".TH \"$args{'module'}\" 9 \"" . $args{'type'} . " " . $args{'st= ruct'} . "\" \"$man_date\" \"API Manual\" LINUX\n"; + + print ".SH NAME\n"; + print $args{'type'} . " " . $args{'struct'} . " \\- " . $args{'purpose= '} . "\n"; + + my $declaration =3D $args{'definition'}; + $declaration =3D~ s/\t/ /g; + $declaration =3D~ s/\n/"\n.br\n.BI \"/g; + print ".SH SYNOPSIS\n"; + print $args{'type'} . " " . $args{'struct'} . " {\n.br\n"; + print ".BI \"$declaration\n};\n.br\n\n"; + + print ".SH Members\n"; + foreach $parameter (@{$args{'parameterlist'}}) { + ($parameter =3D~ /^#/) && next; + + my $parameter_name =3D $parameter; + $parameter_name =3D~ s/\[.*//; + + ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; + print ".IP \"" . $parameter . "\" 12\n"; + output_highlight($args{'parameterdescs'}{$parameter_name}); + } + foreach $section (@{$args{'sectionlist'}}) { + print ".SH \"$section\"\n"; + output_highlight($args{'sections'}{$section}); + } +} + +## +# output typedef in man +sub output_typedef_man(%) { + my %args =3D %{$_[0]}; + my ($parameter, $section); + + print ".TH \"$args{'module'}\" 9 \"$args{'typedef'}\" \"$man_date\" \"= API Manual\" LINUX\n"; + + print ".SH NAME\n"; + print "typedef " . $args{'typedef'} . " \\- " . $args{'purpose'} . "\n= "; + + foreach $section (@{$args{'sectionlist'}}) { + print ".SH \"$section\"\n"; + output_highlight($args{'sections'}{$section}); + } +} + +sub output_blockhead_man(%) { + my %args =3D %{$_[0]}; + my ($parameter, $section); + my $count; + + print ".TH \"$args{'module'}\" 9 \"$args{'module'}\" \"$man_date\" \"A= PI Manual\" LINUX\n"; + + foreach $section (@{$args{'sectionlist'}}) { + print ".SH \"$section\"\n"; + output_highlight($args{'sections'}{$section}); + } +} + +## +# output in restructured text +# + +# +# This could use some work; it's used to output the DOC: sections, and +# starts by putting out the name of the doc section itself, but that tends +# to duplicate a header already in the template file. +# +sub output_blockhead_rst(%) { + my %args =3D %{$_[0]}; + my ($parameter, $section); + + foreach $section (@{$args{'sectionlist'}}) { + if ($output_selection !=3D OUTPUT_INCLUDE) { + print "**$section**\n\n"; + } + print_lineno($section_start_lines{$section}); + output_highlight_rst($args{'sections'}{$section}); + print "\n"; + } +} + +# +# Apply the RST highlights to a sub-block of text. +# +sub highlight_block($) { + # The dohighlight kludge requires the text be called $contents + my $contents =3D shift; + eval $dohighlight; + die $@ if $@; + return $contents; +} + +# +# Regexes used only here. +# +my $sphinx_literal =3D '^[^.].*::$'; +my $sphinx_cblock =3D '^\.\.\ +code-block::'; + +sub output_highlight_rst { + my $input =3D join "\n",@_; + my $output =3D ""; + my $line; + my $in_literal =3D 0; + my $litprefix; + my $block =3D ""; + + foreach $line (split "\n",$input) { + # + # If we're in a literal block, see if we should drop out + # of it. Otherwise pass the line straight through unmunged. + # + if ($in_literal) { + if (! ($line =3D~ /^\s*$/)) { + # + # If this is the first non-blank line in a literal + # block we need to figure out what the proper indent is. + # + if ($litprefix eq "") { + $line =3D~ /^(\s*)/; + $litprefix =3D '^' . $1; + $output .=3D $line . "\n"; + } elsif (! ($line =3D~ /$litprefix/)) { + $in_literal =3D 0; + } else { + $output .=3D $line . "\n"; + } + } else { + $output .=3D $line . "\n"; + } + } + # + # Not in a literal block (or just dropped out) + # + if (! $in_literal) { + $block .=3D $line . "\n"; + if (($line =3D~ /$sphinx_literal/) || ($line =3D~ /$sphinx_cblock/)) { + $in_literal =3D 1; + $litprefix =3D ""; + $output .=3D highlight_block($block); + $block =3D "" + } + } + } + + if ($block) { + $output .=3D highlight_block($block); + } + foreach $line (split "\n", $output) { + print $lineprefix . $line . "\n"; + } +} + +sub output_function_rst(%) { + my %args =3D %{$_[0]}; + my ($parameter, $section); + my $oldprefix =3D $lineprefix; + my $start =3D ""; + + if ($args{'typedef'}) { + print ".. c:type:: ". $args{'function'} . "\n\n"; + print_lineno($declaration_start_line); + print " **Typedef**: "; + $lineprefix =3D ""; + output_highlight_rst($args{'purpose'}); + $start =3D "\n\n**Syntax**\n\n ``"; + } else { + print ".. c:function:: "; + } + if ($args{'functiontype'} ne "") { + $start .=3D $args{'functiontype'} . " " . $args{'function'} . " ("; + } else { + $start .=3D $args{'function'} . " ("; + } + print $start; + + my $count =3D 0; + foreach my $parameter (@{$args{'parameterlist'}}) { + if ($count ne 0) { + print ", "; + } + $count++; + $type =3D $args{'parametertypes'}{$parameter}; + + if ($type =3D~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) { + # pointer-to-function + print $1 . $parameter . ") (" . $2; + } else { + print $type . " " . $parameter; + } + } + if ($args{'typedef'}) { + print ");``\n\n"; + } else { + print ")\n\n"; + print_lineno($declaration_start_line); + $lineprefix =3D " "; + output_highlight_rst($args{'purpose'}); + print "\n"; + } + + print "**Parameters**\n\n"; + $lineprefix =3D " "; + foreach $parameter (@{$args{'parameterlist'}}) { + my $parameter_name =3D $parameter; + $parameter_name =3D~ s/\[.*//; + $type =3D $args{'parametertypes'}{$parameter}; + + if ($type ne "") { + print "``$type $parameter``\n"; + } else { + print "``$parameter``\n"; + } + + print_lineno($parameterdesc_start_lines{$parameter_name}); + + if (defined($args{'parameterdescs'}{$parameter_name}) && + $args{'parameterdescs'}{$parameter_name} ne $undescribed) { + output_highlight_rst($args{'parameterdescs'}{$parameter_name}); + } else { + print " *undescribed*\n"; + } + print "\n"; + } + + $lineprefix =3D $oldprefix; + output_section_rst(@_); +} + +sub output_section_rst(%) { + my %args =3D %{$_[0]}; + my $section; + my $oldprefix =3D $lineprefix; + $lineprefix =3D ""; + + foreach $section (@{$args{'sectionlist'}}) { + print "**$section**\n\n"; + print_lineno($section_start_lines{$section}); + output_highlight_rst($args{'sections'}{$section}); + print "\n"; + } + print "\n"; + $lineprefix =3D $oldprefix; +} + +sub output_enum_rst(%) { + my %args =3D %{$_[0]}; + my ($parameter); + my $oldprefix =3D $lineprefix; + my $count; + my $name =3D "enum " . $args{'enum'}; + + print "\n\n.. c:type:: " . $name . "\n\n"; + print_lineno($declaration_start_line); + $lineprefix =3D " "; + output_highlight_rst($args{'purpose'}); + print "\n"; + + print "**Constants**\n\n"; + $lineprefix =3D " "; + foreach $parameter (@{$args{'parameterlist'}}) { + print "``$parameter``\n"; + if ($args{'parameterdescs'}{$parameter} ne $undescribed) { + output_highlight_rst($args{'parameterdescs'}{$parameter}); + } else { + print " *undescribed*\n"; + } + print "\n"; + } + + $lineprefix =3D $oldprefix; + output_section_rst(@_); +} + +sub output_typedef_rst(%) { + my %args =3D %{$_[0]}; + my ($parameter); + my $oldprefix =3D $lineprefix; + my $name =3D "typedef " . $args{'typedef'}; + + print "\n\n.. c:type:: " . $name . "\n\n"; + print_lineno($declaration_start_line); + $lineprefix =3D " "; + output_highlight_rst($args{'purpose'}); + print "\n"; + + $lineprefix =3D $oldprefix; + output_section_rst(@_); +} + +sub output_struct_rst(%) { + my %args =3D %{$_[0]}; + my ($parameter); + my $oldprefix =3D $lineprefix; + my $name =3D $args{'type'} . " " . $args{'struct'}; + + print "\n\n.. c:type:: " . $name . "\n\n"; + print_lineno($declaration_start_line); + $lineprefix =3D " "; + output_highlight_rst($args{'purpose'}); + print "\n"; + + print "**Definition**\n\n"; + print "::\n\n"; + my $declaration =3D $args{'definition'}; + $declaration =3D~ s/\t/ /g; + print " " . $args{'type'} . " " . $args{'struct'} . " {\n$declaration= };\n\n"; + + print "**Members**\n\n"; + $lineprefix =3D " "; + foreach $parameter (@{$args{'parameterlist'}}) { + ($parameter =3D~ /^#/) && next; + + my $parameter_name =3D $parameter; + $parameter_name =3D~ s/\[.*//; + + ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next; + $type =3D $args{'parametertypes'}{$parameter}; + print_lineno($parameterdesc_start_lines{$parameter_name}); + print "``" . $parameter . "``\n"; + output_highlight_rst($args{'parameterdescs'}{$parameter_name}); + print "\n"; + } + print "\n"; + + $lineprefix =3D $oldprefix; + output_section_rst(@_); +} + +## none mode output functions + +sub output_function_none(%) { +} + +sub output_enum_none(%) { +} + +sub output_typedef_none(%) { +} + +sub output_struct_none(%) { +} + +sub output_blockhead_none(%) { +} + +## +# generic output function for all types (function, struct/union, typedef, = enum); +# calls the generated, variable output_ function name based on +# functype and output_mode +sub output_declaration { + no strict 'refs'; + my $name =3D shift; + my $functype =3D shift; + my $func =3D "output_${functype}_$output_mode"; + if (($output_selection =3D=3D OUTPUT_ALL) || + (($output_selection =3D=3D OUTPUT_INCLUDE || + $output_selection =3D=3D OUTPUT_EXPORTED) && + defined($function_table{$name})) || + (($output_selection =3D=3D OUTPUT_EXCLUDE || + $output_selection =3D=3D OUTPUT_INTERNAL) && + !($functype eq "function" && defined($function_table{$name})))) + { + &$func(@_); + $section_counter++; + } +} + +## +# generic output function - calls the right one based on current output mo= de. +sub output_blockhead { + no strict 'refs'; + my $func =3D "output_blockhead_" . $output_mode; + &$func(@_); + $section_counter++; +} + +## +# takes a declaration (struct, union, enum, typedef) and +# invokes the right handler. NOT called for functions. +sub dump_declaration($$) { + no strict 'refs'; + my ($prototype, $file) =3D @_; + my $func =3D "dump_" . $decl_type; + &$func(@_); +} + +sub dump_union($$) { + dump_struct(@_); +} + +sub dump_struct($$) { + my $x =3D shift; + my $file =3D shift; + + if ($x =3D~ /(struct|union)\s+(\w+)\s*\{(.*)\}(\s*(__packed|__aligned|= __attribute__\s*\(\([a-z0-9,_\s\(\)]*\)\)))*/) { + my $decl_type =3D $1; + $declaration_name =3D $2; + my $members =3D $3; + + # ignore members marked private: + $members =3D~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi; + $members =3D~ s/\/\*\s*private:.*//gosi; + # strip comments: + $members =3D~ s/\/\*.*?\*\///gos; + # strip attributes + $members =3D~ s/\s*__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)//gi; + $members =3D~ s/\s*__aligned\s*\([^;]*\)//gos; + $members =3D~ s/\s*__packed\s*//gos; + $members =3D~ s/\s*CRYPTO_MINALIGN_ATTR//gos; + # replace DECLARE_BITMAP + $members =3D~ s/DECLARE_BITMAP\s*\(([^,)]+),\s*([^,)]+)\)/unsigned long $= 1\[BITS_TO_LONGS($2)\]/gos; + # replace DECLARE_HASHTABLE + $members =3D~ s/DECLARE_HASHTABLE\s*\(([^,)]+),\s*([^,)]+)\)/unsigned lon= g $1\[1 << (($2) - 1)\]/gos; + # replace DECLARE_KFIFO + $members =3D~ s/DECLARE_KFIFO\s*\(([^,)]+),\s*([^,)]+),\s*([^,)]+)\)/$2 \= *$1/gos; + # replace DECLARE_KFIFO_PTR + $members =3D~ s/DECLARE_KFIFO_PTR\s*\(([^,)]+),\s*([^,)]+)\)/$2 \*$1/gos; + + my $declaration =3D $members; + + # Split nested struct/union elements as newer ones + while ($members =3D~ m/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*= )\;/) { + my $newmember; + my $maintype =3D $1; + my $ids =3D $4; + my $content =3D $3; + foreach my $id(split /,/, $ids) { + $newmember .=3D "$maintype $id; "; + + $id =3D~ s/[:\[].*//; + $id =3D~ s/^\s*\**(\S+)\s*/$1/; + foreach my $arg (split /;/, $content) { + next if ($arg =3D~ m/^\s*$/); + if ($arg =3D~ m/^([^\(]+\(\*?\s*)([\w\.]*)(\s*\).*)/) { + # pointer-to-function + my $type =3D $1; + my $name =3D $2; + my $extra =3D $3; + next if (!$name); + if ($id =3D~ m/^\s*$/) { + # anonymous struct/union + $newmember .=3D "$type$name$extra; "; + } else { + $newmember .=3D "$type$id.$name$extra; "; + } + } else { + my $type; + my $names; + $arg =3D~ s/^\s+//; + $arg =3D~ s/\s+$//; + # Handle bitmaps + $arg =3D~ s/:\s*\d+\s*//g; + # Handle arrays + $arg =3D~ s/\[.*\]//g; + # The type may have multiple words, + # and multiple IDs can be defined, like: + # const struct foo, *bar, foobar + # So, we remove spaces when parsing the + # names, in order to match just names + # and commas for the names + $arg =3D~ s/\s*,\s*/,/g; + if ($arg =3D~ m/(.*)\s+([\S+,]+)/) { + $type =3D $1; + $names =3D $2; + } else { + $newmember .=3D "$arg; "; + next; + } + foreach my $name (split /,/, $names) { + $name =3D~ s/^\s*\**(\S+)\s*/$1/; + next if (($name =3D~ m/^\s*$/)); + if ($id =3D~ m/^\s*$/) { + # anonymous struct/union + $newmember .=3D "$type $name; "; + } else { + $newmember .=3D "$type $id.$name; "; + } + } + } + } + } + $members =3D~ s/(struct|union)([^\{\};]+)\{([^\{\}]*)\}([^\{\}\;]*)\;/$n= ewmember/; + } + + # Ignore other nested elements, like enums + $members =3D~ s/(\{[^\{\}]*\})//g; + + create_parameterlist($members, ';', $file, $declaration_name); + check_sections($file, $declaration_name, $decl_type, $sectcheck, $struct_= actual); + + # Adjust declaration for better display + $declaration =3D~ s/([\{;])/$1\n/g; + $declaration =3D~ s/\}\s+;/};/g; + # Better handle inlined enums + do {} while ($declaration =3D~ s/(enum\s+\{[^\}]+),([^\n])/$1,\n$2/); + + my @def_args =3D split /\n/, $declaration; + my $level =3D 1; + $declaration =3D ""; + foreach my $clause (@def_args) { + $clause =3D~ s/^\s+//; + $clause =3D~ s/\s+$//; + $clause =3D~ s/\s+/ /; + next if (!$clause); + $level-- if ($clause =3D~ m/(\})/ && $level > 1); + if (!($clause =3D~ m/^\s*#/)) { + $declaration .=3D "\t" x $level; + } + $declaration .=3D "\t" . $clause . "\n"; + $level++ if ($clause =3D~ m/(\{)/ && !($clause =3D~m/\}/)); + } + output_declaration($declaration_name, + 'struct', + {'struct' =3D> $declaration_name, + 'module' =3D> $modulename, + 'definition' =3D> $declaration, + 'parameterlist' =3D> \@parameterlist, + 'parameterdescs' =3D> \%parameterdescs, + 'parametertypes' =3D> \%parametertypes, + 'sectionlist' =3D> \@sectionlist, + 'sections' =3D> \%sections, + 'purpose' =3D> $declaration_purpose, + 'type' =3D> $decl_type + }); + } + else { + print STDERR "${file}:$.: error: Cannot parse struct or union!\n"; + ++$errors; + } +} + + +sub show_warnings($$) { + my $functype =3D shift; + my $name =3D shift; + + return 1 if ($output_selection =3D=3D OUTPUT_ALL); + + if ($output_selection =3D=3D OUTPUT_EXPORTED) { + if (defined($function_table{$name})) { + return 1; + } else { + return 0; + } + } + if ($output_selection =3D=3D OUTPUT_INTERNAL) { + if (!($functype eq "function" && defined($function_table{$name}))) { + return 1; + } else { + return 0; + } + } + if ($output_selection =3D=3D OUTPUT_INCLUDE) { + if (defined($function_table{$name})) { + return 1; + } else { + return 0; + } + } + if ($output_selection =3D=3D OUTPUT_EXCLUDE) { + if (!defined($function_table{$name})) { + return 1; + } else { + return 0; + } + } + die("Please add the new output type at show_warnings()"); +} + +sub dump_enum($$) { + my $x =3D shift; + my $file =3D shift; + + $x =3D~ s@/\*.*?\*/@@gos; # strip comments. + # strip #define macros inside enums + $x =3D~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos; + + if ($x =3D~ /enum\s+(\w*)\s*\{(.*)\}/) { + $declaration_name =3D $1; + my $members =3D $2; + my %_members; + + $members =3D~ s/\s+$//; + + foreach my $arg (split ',', $members) { + $arg =3D~ s/^\s*(\w+).*/$1/; + push @parameterlist, $arg; + if (!$parameterdescs{$arg}) { + $parameterdescs{$arg} =3D $undescribed; + if (show_warnings("enum", $declaration_name)) { + print STDERR "${file}:$.: warning: Enum value '$arg' not described in e= num '$declaration_name'\n"; + } + } + $_members{$arg} =3D 1; + } + + while (my ($k, $v) =3D each %parameterdescs) { + if (!exists($_members{$k})) { + if (show_warnings("enum", $declaration_name)) { + print STDERR "${file}:$.: warning: Excess enum value '$k' descripti= on in '$declaration_name'\n"; + } + } + } + + output_declaration($declaration_name, + 'enum', + {'enum' =3D> $declaration_name, + 'module' =3D> $modulename, + 'parameterlist' =3D> \@parameterlist, + 'parameterdescs' =3D> \%parameterdescs, + 'sectionlist' =3D> \@sectionlist, + 'sections' =3D> \%sections, + 'purpose' =3D> $declaration_purpose + }); + } + else { + print STDERR "${file}:$.: error: Cannot parse enum!\n"; + ++$errors; + } +} + +sub dump_typedef($$) { + my $x =3D shift; + my $file =3D shift; + + $x =3D~ s@/\*.*?\*/@@gos; # strip comments. + + # Parse function prototypes + if ($x =3D~ /typedef\s+(\w+)\s*\(\*\s*(\w\S+)\s*\)\s*\((.*)\);/ || + $x =3D~ /typedef\s+(\w+)\s*(\w\S+)\s*\s*\((.*)\);/) { + + # Function typedefs + $return_type =3D $1; + $declaration_name =3D $2; + my $args =3D $3; + + create_parameterlist($args, ',', $file, $declaration_name); + + output_declaration($declaration_name, + 'function', + {'function' =3D> $declaration_name, + 'typedef' =3D> 1, + 'module' =3D> $modulename, + 'functiontype' =3D> $return_type, + 'parameterlist' =3D> \@parameterlist, + 'parameterdescs' =3D> \%parameterdescs, + 'parametertypes' =3D> \%parametertypes, + 'sectionlist' =3D> \@sectionlist, + 'sections' =3D> \%sections, + 'purpose' =3D> $declaration_purpose + }); + return; + } + + while (($x =3D~ /\(*.\)\s*;$/) || ($x =3D~ /\[*.\]\s*;$/)) { + $x =3D~ s/\(*.\)\s*;$/;/; + $x =3D~ s/\[*.\]\s*;$/;/; + } + + if ($x =3D~ /typedef.*\s+(\w+)\s*;/) { + $declaration_name =3D $1; + + output_declaration($declaration_name, + 'typedef', + {'typedef' =3D> $declaration_name, + 'module' =3D> $modulename, + 'sectionlist' =3D> \@sectionlist, + 'sections' =3D> \%sections, + 'purpose' =3D> $declaration_purpose + }); + } + else { + print STDERR "${file}:$.: error: Cannot parse typedef!\n"; + ++$errors; + } +} + +sub save_struct_actual($) { + my $actual =3D shift; + + # strip all spaces from the actual param so that it looks like one str= ing item + $actual =3D~ s/\s*//g; + $struct_actual =3D $struct_actual . $actual . " "; +} + +sub create_parameterlist($$$$) { + my $args =3D shift; + my $splitter =3D shift; + my $file =3D shift; + my $declaration_name =3D shift; + my $type; + my $param; + + # temporarily replace commas inside function pointer definition + while ($args =3D~ /(\([^\),]+),/) { + $args =3D~ s/(\([^\),]+),/$1#/g; + } + + foreach my $arg (split($splitter, $args)) { + # strip comments + $arg =3D~ s/\/\*.*\*\///; + # strip leading/trailing spaces + $arg =3D~ s/^\s*//; + $arg =3D~ s/\s*$//; + $arg =3D~ s/\s+/ /; + + if ($arg =3D~ /^#/) { + # Treat preprocessor directive as a typeless variable just to fill + # corresponding data structures "correctly". Catch it later in + # output_* subs. + push_parameter($arg, "", $file); + } elsif ($arg =3D~ m/\(.+\)\s*\(/) { + # pointer-to-function + $arg =3D~ tr/#/,/; + $arg =3D~ m/[^\(]+\(\*?\s*([\w\.]*)\s*\)/; + $param =3D $1; + $type =3D $arg; + $type =3D~ s/([^\(]+\(\*?)\s*$param/$1/; + save_struct_actual($param); + push_parameter($param, $type, $file, $declaration_name); + } elsif ($arg) { + $arg =3D~ s/\s*:\s*/:/g; + $arg =3D~ s/\s*\[/\[/g; + + my @args =3D split('\s*,\s*', $arg); + if ($args[0] =3D~ m/\*/) { + $args[0] =3D~ s/(\*+)\s*/ $1/; + } + + my @first_arg; + if ($args[0] =3D~ /^(.*\s+)(.*?\[.*\].*)$/) { + shift @args; + push(@first_arg, split('\s+', $1)); + push(@first_arg, $2); + } else { + @first_arg =3D split('\s+', shift @args); + } + + unshift(@args, pop @first_arg); + $type =3D join " ", @first_arg; + + foreach $param (@args) { + if ($param =3D~ m/^(\*+)\s*(.*)/) { + save_struct_actual($2); + push_parameter($2, "$type $1", $file, $declaration_name); + } + elsif ($param =3D~ m/(.*?):(\d+)/) { + if ($type ne "") { # skip unnamed bit-fields + save_struct_actual($1); + push_parameter($1, "$type:$2", $file, $declaration_name) + } + } + else { + save_struct_actual($param); + push_parameter($param, $type, $file, $declaration_name); + } + } + } + } +} + +sub push_parameter($$$$) { + my $param =3D shift; + my $type =3D shift; + my $file =3D shift; + my $declaration_name =3D shift; + + if (($anon_struct_union =3D=3D 1) && ($type eq "") && + ($param eq "}")) { + return; # ignore the ending }; from anon. struct/union + } + + $anon_struct_union =3D 0; + $param =3D~ s/[\[\)].*//; + + if ($type eq "" && $param =3D~ /\.\.\.$/) + { + if (!$param =3D~ /\w\.\.\.$/) { + # handles unnamed variable parameters + $param =3D "..."; + } + if (!defined $parameterdescs{$param} || $parameterdescs{$param} eq ""= ) { + $parameterdescs{$param} =3D "variable arguments"; + } + } + elsif ($type eq "" && ($param eq "" or $param eq "void")) + { + $param=3D"void"; + $parameterdescs{void} =3D "no arguments"; + } + elsif ($type eq "" && ($param eq "struct" or $param eq "union")) + # handle unnamed (anonymous) union or struct: + { + $type =3D $param; + $param =3D "{unnamed_" . $param . "}"; + $parameterdescs{$param} =3D "anonymous\n"; + $anon_struct_union =3D 1; + } + + # warn if parameter has no description + # (but ignore ones starting with # as these are not parameters + # but inline preprocessor statements); + # Note: It will also ignore void params and unnamed structs/unions + if (!defined $parameterdescs{$param} && $param !~ /^#/) { + $parameterdescs{$param} =3D $undescribed; + + if (show_warnings($type, $declaration_name) && $param !~ /\./) { + print STDERR + "${file}:$.: warning: Function parameter or member '$param' not d= escribed in '$declaration_name'\n"; + ++$warnings; + } + } + + # strip spaces from $param so that it is one continuous string + # on @parameterlist; + # this fixes a problem where check_sections() cannot find + # a parameter like "addr[6 + 2]" because it actually appears + # as "addr[6", "+", "2]" on the parameter list; + # but it's better to maintain the param string unchanged for output, + # so just weaken the string compare in check_sections() to ignore + # "[blah" in a parameter string; + ###$param =3D~ s/\s*//g; + push @parameterlist, $param; + $type =3D~ s/\s\s+/ /g; + $parametertypes{$param} =3D $type; +} + +sub check_sections($$$$$) { + my ($file, $decl_name, $decl_type, $sectcheck, $prmscheck) =3D @_; + my @sects =3D split ' ', $sectcheck; + my @prms =3D split ' ', $prmscheck; + my $err; + my ($px, $sx); + my $prm_clean; # strip trailing "[array size]" and/or beginning "*" + + foreach $sx (0 .. $#sects) { + $err =3D 1; + foreach $px (0 .. $#prms) { + $prm_clean =3D $prms[$px]; + $prm_clean =3D~ s/\[.*\]//; + $prm_clean =3D~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i; + # ignore array size in a parameter string; + # however, the original param string may contain + # spaces, e.g.: addr[6 + 2] + # and this appears in @prms as "addr[6" since the + # parameter list is split at spaces; + # hence just ignore "[..." for the sections check; + $prm_clean =3D~ s/\[.*//; + + ##$prm_clean =3D~ s/^\**//; + if ($prm_clean eq $sects[$sx]) { + $err =3D 0; + last; + } + } + if ($err) { + if ($decl_type eq "function") { + print STDERR "${file}:$.: warning: " . + "Excess function parameter " . + "'$sects[$sx]' " . + "description in '$decl_name'\n"; + ++$warnings; + } + } + } +} + +## +# Checks the section describing the return value of a function. +sub check_return_section { + my $file =3D shift; + my $declaration_name =3D shift; + my $return_type =3D shift; + + # Ignore an empty return type (It's a macro) + # Ignore functions with a "void" return type. (But don't ignore "v= oid *") + if (($return_type eq "") || ($return_type =3D~ /void\s*\w*\s*$/)) { + return; + } + + if (!defined($sections{$section_return}) || + $sections{$section_return} eq "") { + print STDERR "${file}:$.: warning: " . + "No description found for return value of " . + "'$declaration_name'\n"; + ++$warnings; + } +} + +## +# takes a function prototype and the name of the current file being +# processed and spits out all the details stored in the global +# arrays/hashes. +sub dump_function($$) { + my $prototype =3D shift; + my $file =3D shift; + my $noret =3D 0; + + $prototype =3D~ s/^static +//; + $prototype =3D~ s/^extern +//; + $prototype =3D~ s/^asmlinkage +//; + $prototype =3D~ s/^inline +//; + $prototype =3D~ s/^__inline__ +//; + $prototype =3D~ s/^__inline +//; + $prototype =3D~ s/^__always_inline +//; + $prototype =3D~ s/^noinline +//; + $prototype =3D~ s/__init +//; + $prototype =3D~ s/__init_or_module +//; + $prototype =3D~ s/__meminit +//; + $prototype =3D~ s/__must_check +//; + $prototype =3D~ s/__weak +//; + $prototype =3D~ s/__sched +//; + $prototype =3D~ s/__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +//; + my $define =3D $prototype =3D~ s/^#\s*define\s+//; #ak added + $prototype =3D~ s/__attribute__\s*\(\( + (?: + [\w\s]++ # attribute name + (?:\([^)]*+\))? # attribute arguments + \s*+,? # optional comma at the end + )+ + \)\)\s+//x; + + # Yes, this truly is vile. We are looking for: + # 1. Return type (may be nothing if we're looking at a macro) + # 2. Function name + # 3. Function parameters. + # + # All the while we have to watch out for function pointer parameters + # (which IIRC is what the two sections are for), C types (these + # regexps don't even start to express all the possibilities), and + # so on. + # + # If you mess with these regexps, it's a good idea to check that + # the following functions' documentation still comes out right: + # - parport_register_device (function pointer parameters) + # - atomic_set (macro) + # - pci_match_device, __copy_to_user (long return type) + + if ($define && $prototype =3D~ m/^()([a-zA-Z0-9_~:]+)\s+/) { + # This is an object-like macro, it has no return type and no param= eter + # list. + # Function-like macros are not allowed to have spaces between + # declaration_name and opening parenthesis (notice the \s+). + $return_type =3D $1; + $declaration_name =3D $2; + $noret =3D 1; + } elsif ($prototype =3D~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || + $prototype =3D~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || + $prototype =3D~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || + $prototype =3D~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ || + $prototype =3D~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ = || + $prototype =3D~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\(]*)\)/ = || + $prototype =3D~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\(]= *)\)/ || + $prototype =3D~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || + $prototype =3D~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || + $prototype =3D~ m/^(\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || + $prototype =3D~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ || + $prototype =3D~ m/^(\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ = || + $prototype =3D~ m/^(\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]*)\)/ = || + $prototype =3D~ m/^(\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(([^\{]= *)\)/ || + $prototype =3D~ m/^(\w+\s+\w+\s+\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\{]= *)\)/ || + $prototype =3D~ m/^(\w+\s+\w+\s+\w+\s+\w+\s*\*+)\s*([a-zA-Z0-9_~:]+)\s*\(= ([^\{]*)\)/ || + $prototype =3D~ m/^(\w+\s+\w+\s*\*+\s*\w+\s*\*+\s*)\s*([a-zA-Z0-9_~:]+)\s= *\(([^\{]*)\)/) { + $return_type =3D $1; + $declaration_name =3D $2; + my $args =3D $3; + + create_parameterlist($args, ',', $file, $declaration_name); + } else { + print STDERR "${file}:$.: warning: cannot understand function prototype: = '$prototype'\n"; + return; + } + + my $prms =3D join " ", @parameterlist; + check_sections($file, $declaration_name, "function", $sectcheck, $prms); + + # This check emits a lot of warnings at the moment, because many + # functions don't have a 'Return' doc section. So until the number + # of warnings goes sufficiently down, the check is only performed = in + # verbose mode. + # TODO: always perform the check. + if ($verbose && !$noret) { + check_return_section($file, $declaration_name, $return_typ= e); + } + + output_declaration($declaration_name, + 'function', + {'function' =3D> $declaration_name, + 'module' =3D> $modulename, + 'functiontype' =3D> $return_type, + 'parameterlist' =3D> \@parameterlist, + 'parameterdescs' =3D> \%parameterdescs, + 'parametertypes' =3D> \%parametertypes, + 'sectionlist' =3D> \@sectionlist, + 'sections' =3D> \%sections, + 'purpose' =3D> $declaration_purpose + }); +} + +sub reset_state { + $function =3D ""; + %parameterdescs =3D (); + %parametertypes =3D (); + @parameterlist =3D (); + %sections =3D (); + @sectionlist =3D (); + $sectcheck =3D ""; + $struct_actual =3D ""; + $prototype =3D ""; + + $state =3D STATE_NORMAL; + $inline_doc_state =3D STATE_INLINE_NA; +} + +sub tracepoint_munge($) { + my $file =3D shift; + my $tracepointname =3D 0; + my $tracepointargs =3D 0; + + if ($prototype =3D~ m/TRACE_EVENT\((.*?),/) { + $tracepointname =3D $1; + } + if ($prototype =3D~ m/DEFINE_SINGLE_EVENT\((.*?),/) { + $tracepointname =3D $1; + } + if ($prototype =3D~ m/DEFINE_EVENT\((.*?),(.*?),/) { + $tracepointname =3D $2; + } + $tracepointname =3D~ s/^\s+//; #strip leading whitespace + if ($prototype =3D~ m/TP_PROTO\((.*?)\)/) { + $tracepointargs =3D $1; + } + if (($tracepointname eq 0) || ($tracepointargs eq 0)) { + print STDERR "${file}:$.: warning: Unrecognized tracepoint format: \n". + "$prototype\n"; + } else { + $prototype =3D "static inline void trace_$tracepointname($tracepointargs= )"; + } +} + +sub syscall_munge() { + my $void =3D 0; + + $prototype =3D~ s@[\r\n]+@ @gos; # strip newlines/CR's +## if ($prototype =3D~ m/SYSCALL_DEFINE0\s*\(\s*(a-zA-Z0-9_)*\s*\)/) { + if ($prototype =3D~ m/SYSCALL_DEFINE0/) { + $void =3D 1; +## $prototype =3D "long sys_$1(void)"; + } + + $prototype =3D~ s/SYSCALL_DEFINE.*\(/long sys_/; # fix return type & func= name + if ($prototype =3D~ m/long (sys_.*?),/) { + $prototype =3D~ s/,/\(/; + } elsif ($void) { + $prototype =3D~ s/\)/\(void\)/; + } + + # now delete all of the odd-number commas in $prototype + # so that arg types & arg names don't have a comma between them + my $count =3D 0; + my $len =3D length($prototype); + if ($void) { + $len =3D 0; # skip the for-loop + } + for (my $ix =3D 0; $ix < $len; $ix++) { + if (substr($prototype, $ix, 1) eq ',') { + $count++; + if ($count % 2 =3D=3D 1) { + substr($prototype, $ix, 1) =3D ' '; + } + } + } +} + +sub process_proto_function($$) { + my $x =3D shift; + my $file =3D shift; + + $x =3D~ s@\/\/.*$@@gos; # strip C99-style comments to end of line + + if ($x =3D~ m#\s*/\*\s+MACDOC\s*#io || ($x =3D~ /^#/ && $x !~ /^#\s*de= fine/)) { + # do nothing + } + elsif ($x =3D~ /([^\{]*)/) { + $prototype .=3D $1; + } + + if (($x =3D~ /\{/) || ($x =3D~ /\#\s*define/) || ($x =3D~ /;/)) { + $prototype =3D~ s@/\*.*?\*/@@gos; # strip comments. + $prototype =3D~ s@[\r\n]+@ @gos; # strip newlines/cr's. + $prototype =3D~ s@^\s+@@gos; # strip leading spaces + if ($prototype =3D~ /SYSCALL_DEFINE/) { + syscall_munge(); + } + if ($prototype =3D~ /TRACE_EVENT/ || $prototype =3D~ /DEFINE_EVENT/ || + $prototype =3D~ /DEFINE_SINGLE_EVENT/) + { + tracepoint_munge($file); + } + dump_function($prototype, $file); + reset_state(); + } +} + +sub process_proto_type($$) { + my $x =3D shift; + my $file =3D shift; + + $x =3D~ s@[\r\n]+@ @gos; # strip newlines/cr's. + $x =3D~ s@^\s+@@gos; # strip leading spaces + $x =3D~ s@\s+$@@gos; # strip trailing spaces + $x =3D~ s@\/\/.*$@@gos; # strip C99-style comments to end of line + + if ($x =3D~ /^#/) { + # To distinguish preprocessor directive from regular declaration later. + $x .=3D ";"; + } + + while (1) { + if ( $x =3D~ /([^\{\};]*)([\{\};])(.*)/ ) { + if( length $prototype ) { + $prototype .=3D " " + } + $prototype .=3D $1 . $2; + ($2 eq '{') && $brcount++; + ($2 eq '}') && $brcount--; + if (($2 eq ';') && ($brcount =3D=3D 0)) { + dump_declaration($prototype, $file); + reset_state(); + last; + } + $x =3D $3; + } else { + $prototype .=3D $x; + last; + } + } +} + + +sub map_filename($) { + my $file; + my ($orig_file) =3D @_; + + if (defined($ENV{'SRCTREE'})) { + $file =3D "$ENV{'SRCTREE'}" . "/" . $orig_file; + } else { + $file =3D $orig_file; + } + + if (defined($source_map{$file})) { + $file =3D $source_map{$file}; + } + + return $file; +} + +sub process_export_file($) { + my ($orig_file) =3D @_; + my $file =3D map_filename($orig_file); + + if (!open(IN,"<$file")) { + print STDERR "Error: Cannot open file $file\n"; + ++$errors; + return; + } + + while () { + if (/$export_symbol/) { + $function_table{$2} =3D 1; + } + } + + close(IN); +} + +# +# Parsers for the various processing states. +# +# STATE_NORMAL: looking for the /** to begin everything. +# +sub process_normal() { + if (/$doc_start/o) { + $state =3D STATE_NAME; # next line is always the function name + $in_doc_sect =3D 0; + $declaration_start_line =3D $. + 1; + } +} + +# +# STATE_NAME: Looking for the "name - description" line +# +sub process_name($$) { + my $file =3D shift; + my $identifier; + my $descr; + + if (/$doc_block/o) { + $state =3D STATE_DOCBLOCK; + $contents =3D ""; + $new_start_line =3D $. + 1; + + if ( $1 eq "" ) { + $section =3D $section_intro; + } else { + $section =3D $1; + } + } + elsif (/$doc_decl/o) { + $identifier =3D $1; + if (/\s*([\w\s]+?)(\(\))?\s*-/) { + $identifier =3D $1; + } + + $state =3D STATE_BODY; + # if there's no @param blocks need to set up default section + # here + $contents =3D ""; + $section =3D $section_default; + $new_start_line =3D $. + 1; + if (/-(.*)/) { + # strip leading/trailing/multiple spaces + $descr=3D $1; + $descr =3D~ s/^\s*//; + $descr =3D~ s/\s*$//; + $descr =3D~ s/\s+/ /g; + $declaration_purpose =3D $descr; + $state =3D STATE_BODY_MAYBE; + } else { + $declaration_purpose =3D ""; + } + + if (($declaration_purpose eq "") && $verbose) { + print STDERR "${file}:$.: warning: missing initial short description = on line:\n"; + print STDERR $_; + ++$warnings; + } + + if ($identifier =3D~ m/^struct\b/) { + $decl_type =3D 'struct'; + } elsif ($identifier =3D~ m/^union\b/) { + $decl_type =3D 'union'; + } elsif ($identifier =3D~ m/^enum\b/) { + $decl_type =3D 'enum'; + } elsif ($identifier =3D~ m/^typedef\b/) { + $decl_type =3D 'typedef'; + } else { + $decl_type =3D 'function'; + } + + if ($verbose) { + print STDERR "${file}:$.: info: Scanning doc for $identifier\n"; + } + } else { + print STDERR "${file}:$.: warning: Cannot understand $_ on line $.", + " - I thought it was a doc line\n"; + ++$warnings; + $state =3D STATE_NORMAL; + } +} + + +# +# STATE_BODY and STATE_BODY_MAYBE: the bulk of a kerneldoc comment. +# +sub process_body($$) { + my $file =3D shift; + + if (/$doc_sect/i) { # case insensitive for supported section names + $newsection =3D $1; + $newcontents =3D $2; + + # map the supported section names to the canonical names + if ($newsection =3D~ m/^description$/i) { + $newsection =3D $section_default; + } elsif ($newsection =3D~ m/^context$/i) { + $newsection =3D $section_context; + } elsif ($newsection =3D~ m/^returns?$/i) { + $newsection =3D $section_return; + } elsif ($newsection =3D~ m/^\@return$/) { + # special: @return is a section, not a param description + $newsection =3D $section_return; + } + + if (($contents ne "") && ($contents ne "\n")) { + if (!$in_doc_sect && $verbose) { + print STDERR "${file}:$.: warning: contents before sections\n"; + ++$warnings; + } + dump_section($file, $section, $contents); + $section =3D $section_default; + } + + $in_doc_sect =3D 1; + $state =3D STATE_BODY; + $contents =3D $newcontents; + $new_start_line =3D $.; + while (substr($contents, 0, 1) eq " ") { + $contents =3D substr($contents, 1); + } + if ($contents ne "") { + $contents .=3D "\n"; + } + $section =3D $newsection; + $leading_space =3D undef; + } elsif (/$doc_end/) { + if (($contents ne "") && ($contents ne "\n")) { + dump_section($file, $section, $contents); + $section =3D $section_default; + $contents =3D ""; + } + # look for doc_com + + doc_end: + if ($_ =3D~ m'\s*\*\s*[a-zA-Z_0-9:\.]+\*/') { + print STDERR "${file}:$.: warning: suspicious ending line: $_"; + ++$warnings; + } + + $prototype =3D ""; + $state =3D STATE_PROTO; + $brcount =3D 0; + } elsif (/$doc_content/) { + # miguel-style comment kludge, look for blank lines after + # @parameter line to signify start of description + if ($1 eq "") { + if ($section =3D~ m/^@/ || $section eq $section_context) { + dump_section($file, $section, $contents); + $section =3D $section_default; + $contents =3D ""; + $new_start_line =3D $.; + } else { + $contents .=3D "\n"; + } + $state =3D STATE_BODY; + } elsif ($state =3D=3D STATE_BODY_MAYBE) { + # Continued declaration purpose + chomp($declaration_purpose); + $declaration_purpose .=3D " " . $1; + $declaration_purpose =3D~ s/\s+/ /g; + } else { + my $cont =3D $1; + if ($section =3D~ m/^@/ || $section eq $section_context) { + if (!defined $leading_space) { + if ($cont =3D~ m/^(\s+)/) { + $leading_space =3D $1; + } else { + $leading_space =3D ""; + } + } + $cont =3D~ s/^$leading_space//; + } + $contents .=3D $cont . "\n"; + } + } else { + # i dont know - bad line? ignore. + print STDERR "${file}:$.: warning: bad line: $_"; + ++$warnings; + } +} + + +# +# STATE_PROTO: reading a function/whatever prototype. +# +sub process_proto($$) { + my $file =3D shift; + + if (/$doc_inline_oneline/) { + $section =3D $1; + $contents =3D $2; + if ($contents ne "") { + $contents .=3D "\n"; + dump_section($file, $section, $contents); + $section =3D $section_default; + $contents =3D ""; + } + } elsif (/$doc_inline_start/) { + $state =3D STATE_INLINE; + $inline_doc_state =3D STATE_INLINE_NAME; + } elsif ($decl_type eq 'function') { + process_proto_function($_, $file); + } else { + process_proto_type($_, $file); + } +} + +# +# STATE_DOCBLOCK: within a DOC: block. +# +sub process_docblock($$) { + my $file =3D shift; + + if (/$doc_end/) { + dump_doc_section($file, $section, $contents); + $section =3D $section_default; + $contents =3D ""; + $function =3D ""; + %parameterdescs =3D (); + %parametertypes =3D (); + @parameterlist =3D (); + %sections =3D (); + @sectionlist =3D (); + $prototype =3D ""; + $state =3D STATE_NORMAL; + } elsif (/$doc_content/) { + if ( $1 eq "" ) { + $contents .=3D $blankline; + } else { + $contents .=3D $1 . "\n"; + } + } +} + +# +# STATE_INLINE: docbook comments within a prototype. +# +sub process_inline($$) { + my $file =3D shift; + + # First line (state 1) needs to be a @parameter + if ($inline_doc_state =3D=3D STATE_INLINE_NAME && /$doc_inline_sect/o)= { + $section =3D $1; + $contents =3D $2; + $new_start_line =3D $.; + if ($contents ne "") { + while (substr($contents, 0, 1) eq " ") { + $contents =3D substr($contents, 1); + } + $contents .=3D "\n"; + } + $inline_doc_state =3D STATE_INLINE_TEXT; + # Documentation block end */ + } elsif (/$doc_inline_end/) { + if (($contents ne "") && ($contents ne "\n")) { + dump_section($file, $section, $contents); + $section =3D $section_default; + $contents =3D ""; + } + $state =3D STATE_PROTO; + $inline_doc_state =3D STATE_INLINE_NA; + # Regular text + } elsif (/$doc_content/) { + if ($inline_doc_state =3D=3D STATE_INLINE_TEXT) { + $contents .=3D $1 . "\n"; + # nuke leading blank lines + if ($contents =3D~ /^\s*$/) { + $contents =3D ""; + } + } elsif ($inline_doc_state =3D=3D STATE_INLINE_NAME) { + $inline_doc_state =3D STATE_INLINE_ERROR; + print STDERR "${file}:$.: warning: "; + print STDERR "Incorrect use of kernel-doc format: $_"; + ++$warnings; + } + } +} + + +sub process_file($) { + my $file; + my $initial_section_counter =3D $section_counter; + my ($orig_file) =3D @_; + + $file =3D map_filename($orig_file); + + if (!open(IN,"<$file")) { + print STDERR "Error: Cannot open file $file\n"; + ++$errors; + return; + } + + $. =3D 1; + + $section_counter =3D 0; + while () { + while (s/\\\s*$//) { + $_ .=3D ; + } + # Replace tabs by spaces + while ($_ =3D~ s/\t+/' ' x (length($&) * 8 - length($`) % 8)/e) {}; + # Hand this line to the appropriate state handler + if ($state =3D=3D STATE_NORMAL) { + process_normal(); + } elsif ($state =3D=3D STATE_NAME) { + process_name($file, $_); + } elsif ($state =3D=3D STATE_BODY || $state =3D=3D STATE_BODY_MAYBE) { + process_body($file, $_); + } elsif ($state =3D=3D STATE_INLINE) { # scanning for inline parameters + process_inline($file, $_); + } elsif ($state =3D=3D STATE_PROTO) { + process_proto($file, $_); + } elsif ($state =3D=3D STATE_DOCBLOCK) { + process_docblock($file, $_); + } + } + + # Make sure we got something interesting. + if ($initial_section_counter =3D=3D $section_counter && $ + output_mode ne "none") { + if ($output_selection =3D=3D OUTPUT_INCLUDE) { + print STDERR "${file}:1: warning: '$_' not found\n" + for keys %function_table; + } + else { + print STDERR "${file}:1: warning: no structured comments found\n"; + } + } +} + + +$kernelversion =3D get_kernel_version(); + +# generate a sequence of code that will splice in highlighting information +# using the s// operator. +for (my $k =3D 0; $k < @highlights; $k++) { + my $pattern =3D $highlights[$k][0]; + my $result =3D $highlights[$k][1]; +# print STDERR "scanning pattern:$pattern, highlight:($result)\n"; + $dohighlight .=3D "\$contents =3D~ s:$pattern:$result:gs;\n"; +} + +# Read the file that maps relative names to absolute names for +# separate source and object directories and for shadow trees. +if (open(SOURCE_MAP, "<.tmp_filelist.txt")) { + my ($relname, $absname); + while() { + chop(); + ($relname, $absname) =3D (split())[0..1]; + $relname =3D~ s:^/+::; + $source_map{$relname} =3D $absname; + } + close(SOURCE_MAP); +} + +if ($output_selection =3D=3D OUTPUT_EXPORTED || + $output_selection =3D=3D OUTPUT_INTERNAL) { + + push(@export_file_list, @ARGV); + + foreach (@export_file_list) { + chomp; + process_export_file($_); + } +} + +foreach (@ARGV) { + chomp; + process_file($_); +} +if ($verbose && $errors) { + print STDERR "$errors errors\n"; +} +if ($verbose && $warnings) { + print STDERR "$warnings warnings\n"; +} + +exit($output_mode eq "none" ? 0 : $errors); --=20 2.21.0 From nobody Sun Apr 28 13:30:33 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.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=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1572366298; cv=none; d=zoho.com; s=zohoarc; b=OLHKBt1M6juRYy0XRvUFMdwvADyiDktJIVXJUkllShQ8HNpNshAC8SDF+Ji5vgJvUzbtThZIp2oETpB4WOqnVb7iGuC0GYPoKItivdsjfX+s+Cso/hOT/tdHoiAKlvDh/5W8pVB86cEo4XGrK2K58Z9t7IaQtr8fUJ/bT398bhM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1572366298; 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=GITb2fVxR4h7bhXASG9JI0LI0GYSIzOlpGLPA3IIb7s=; b=Iu9JCgBb/00UEHgFkAuNzOQYv8euEOzK4ZyQN0KxZuFTyqzyRyJjJsB970K7am7fYzVjpLy4ZOaLD0Akyhu5sVEo+1o5eKRVUgSL2yj8JUaN7avwqwz7ZC9DXoUvrzLNQguSzADHGFhsgduIs28UFCMNCtg34jUsNOjdjU7e6ts= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail 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 157236629801342.30035559880548; Tue, 29 Oct 2019 09:24:58 -0700 (PDT) Received: from localhost ([::1]:59630 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iPUIi-0004Pr-NC for importer@patchew.org; Tue, 29 Oct 2019 12:24:56 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50659) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iPUGl-00021M-95 for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:22:56 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iPUGi-0004qb-W4 for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:22:55 -0400 Received: from mail-wm1-x344.google.com ([2a00:1450:4864:20::344]:38838) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iPUGi-0004ps-PF for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:22:52 -0400 Received: by mail-wm1-x344.google.com with SMTP id 22so3079289wms.3 for ; Tue, 29 Oct 2019 09:22:52 -0700 (PDT) Received: from donizetti.metropole.lan (94.222.26.109.rev.sfr.net. [109.26.222.94]) by smtp.gmail.com with ESMTPSA id q12sm9285661wrw.91.2019.10.29.09.22.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 29 Oct 2019 09:22:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=GITb2fVxR4h7bhXASG9JI0LI0GYSIzOlpGLPA3IIb7s=; b=jXsY0HhufsYULXbU62RmeyPN/p7asApD9MExBHme1qh6fpYeqW6e6SNf+pJqMt3EgW NL1s0Zhf6Gzi1cD/SfyFtAwSb14IrrZnbHpSA437Hdj3lnbCfzun0lgFSy2jWo7bAsYP e0QJqbD5h1US5hf32Tf0/we7eRoZyKwMD0Yfyns1oQqIV2A7NsodgTMRCUKoQZsUDH0U 7Gn6ZvZayHU/xcrPgXJUsjcWeSqGfcy8pWLOAOh1jMH6nDGZumQc6xgw9lkfMgZzJWlw Yt2kh5ESOP7ZXoX1tIpB5BWEpGL69Mi5mOZlZejFc+iDiAQCxP6x5u84//m/Cws5+da0 xZsw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=GITb2fVxR4h7bhXASG9JI0LI0GYSIzOlpGLPA3IIb7s=; b=XCkfUcTATtqC0pqiog4NyFKCDua8ppyhkic1NzIiOkVIbQDL/4cyzmBQ+pUNAMiYSz tWYzJCtG/yBq0mKNb172Q8PdFaYKdW8RcVmLZJT4WJWus57ijg0ZBsXJNFbWIrqtrGnc Ft2KTJ5Vg4FAz2HoTzCxH3aHt4XDzy1cUZHkZOZzSi93SNMCRj5r69JgZQXKIqMK1yCP YyZvc9K0KXP4xcbZ/8LMupUyUzjGIAVA2tYRNIJVDByDncJhpeV+UZajDA72stAuYVZV 9FxngTWc6vegyOB6Nbl1xKbEPLquuh36nMeqXI3LkBQwLrj3PvJfmvXha2/lTqWbpOnO Pf+g== X-Gm-Message-State: APjAAAVHAeG3pPWnQZlLjg6lc1tXUktk7cSFVhAvoDoGEpfGo9FUOgem sY74K2GIs+/V9I3RDvbARNFL/Z4cp7c= X-Google-Smtp-Source: APXvYqyhpATNDrQxDDPQfyYAURZeM/pYbJmJo8xOR1VRrWDY5RyQf1dUFkP4yfILCgWosHnGULcIIA== X-Received: by 2002:a1c:7f54:: with SMTP id a81mr4984392wmd.48.1572366171324; Tue, 29 Oct 2019 09:22:51 -0700 (PDT) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PATCH 2/6] docs: tweak kernel-doc for QEMU coding standards Date: Tue, 29 Oct 2019 17:22:44 +0100 Message-Id: <20191029162248.13383-3-pbonzini@redhat.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20191029162248.13383-1-pbonzini@redhat.com> References: <20191029162248.13383-1-pbonzini@redhat.com> 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::344 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: peter.maydell@linaro.org Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Surprisingly, QEMU does have a pretty consistent doc comment style and it is not very different from the Linux kernel's. Of the documentation "sigils", only "#" separates the QEMU doc comment style from Linux's, and it has 200+ instances vs. 6 for the kernel's '&struct foo' (all in accel/tcg/translate-all.c), so it's clear that the two standards are different in this respect. In addition, our structs are typedefed and recognized by CamelCase names. Adjust kernel-doc's parser for these two aspects of the QEMU coding standards. The patch has been valid, with hardly any change, for over two years, so it should not be an issue to keep kernel-doc in sync with the Linux copy. Signed-off-by: Paolo Bonzini --- scripts/kernel-doc | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 81dc91760b..af470eb321 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -215,12 +215,12 @@ my $type_func =3D '(\w+)\(\)'; my $type_param =3D '\@(\w*((\.\w+)|(->\w+))*(\.\.\.)?)'; my $type_fp_param =3D '\@(\w+)\(\)'; # Special RST handling for func ptr = params my $type_env =3D '(\$\w+)'; -my $type_enum =3D '\&(enum\s*([_\w]+))'; -my $type_struct =3D '\&(struct\s*([_\w]+))'; -my $type_typedef =3D '\&(typedef\s*([_\w]+))'; -my $type_union =3D '\&(union\s*([_\w]+))'; -my $type_member =3D '\&([_\w]+)(\.|->)([_\w]+)'; -my $type_fallback =3D '\&([_\w]+)'; +my $type_enum =3D '#(enum\s*([_\w]+))'; +my $type_struct =3D '#(struct\s*([_\w]+))'; +my $type_typedef =3D '#(([A-Z][_\w]*))'; +my $type_union =3D '#(union\s*([_\w]+))'; +my $type_member =3D '#([_\w]+)(\.|->)([_\w]+)'; +my $type_fallback =3D '(?!)'; # this never matches my $type_member_func =3D $type_member . '\(\)'; =20 # Output conversion substitutions. @@ -1050,6 +1050,14 @@ sub output_blockhead { sub dump_declaration($$) { no strict 'refs'; my ($prototype, $file) =3D @_; + if ($decl_type eq 'type name') { + if ($prototype =3D~ /^(enum|struct|union)\s+/) { + $decl_type =3D $1; + } else { + return; + } + } + my $func =3D "dump_" . $decl_type; &$func(@_); } @@ -1878,7 +1886,7 @@ sub process_name($$) { } elsif (/$doc_decl/o) { $identifier =3D $1; - if (/\s*([\w\s]+?)(\(\))?\s*-/) { + if (/\s*([\w\s]+?)(\s*-|:)/) { $identifier =3D $1; } =20 @@ -1888,7 +1896,7 @@ sub process_name($$) { $contents =3D ""; $section =3D $section_default; $new_start_line =3D $. + 1; - if (/-(.*)/) { + if (/[-:](.*)/) { # strip leading/trailing/multiple spaces $descr=3D $1; $descr =3D~ s/^\s*//; @@ -1906,7 +1914,9 @@ sub process_name($$) { ++$warnings; } =20 - if ($identifier =3D~ m/^struct\b/) { + if ($identifier =3D~ m/^[A-Z]/) { + $decl_type =3D 'type name'; + } elsif ($identifier =3D~ m/^struct\b/) { $decl_type =3D 'struct'; } elsif ($identifier =3D~ m/^union\b/) { $decl_type =3D 'union'; --=20 2.21.0 From nobody Sun Apr 28 13:30:33 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.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=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1572366336; cv=none; d=zoho.com; s=zohoarc; b=WW1soGHcbsX9M22B+moDH4dSK7uI6PCa9tZLlsYzfVLjmPPCBCUsDyip5XY3byHEGHCrMwg3v9jFhB4SSizsrvL9KX/j1k9rwRtrUblUkh3/gME/2b2QwaEraEDzsFRtVRmBP6sYVo/kXkHb0Fewmjzrp/L/vu+NRBRNi8e05Rg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1572366336; 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=sLnJuV1CfPJkVM9GKln4msacMdvBWBdZJ+5D0UICXmE=; b=AlOEK4NIPld4OdTUIQh/XWWGFOKEJjarvG2cpVHueGQe5E4nDYKFW9k5Wsn3+mlXXRXBo7xan4lyDg8OoPsHIEdsTdHRDEMEX5T3xsW30Jp1ZIkffSVaBe1VUh0wy7BP1sKAYHXzjRurA0tBrmyN5uORDSNuhdoOnwMWZBpU/0c= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail 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 1572366336798988.3049431255184; Tue, 29 Oct 2019 09:25:36 -0700 (PDT) Received: from localhost ([::1]:59638 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iPUJL-0005N7-8W for importer@patchew.org; Tue, 29 Oct 2019 12:25:35 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50674) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iPUGm-00022s-4H for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:22:57 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iPUGk-0004s7-VY for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:22:56 -0400 Received: from mail-wr1-x432.google.com ([2a00:1450:4864:20::432]:40179) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iPUGj-0004qh-PQ for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:22:54 -0400 Received: by mail-wr1-x432.google.com with SMTP id o28so14335085wro.7 for ; Tue, 29 Oct 2019 09:22:53 -0700 (PDT) Received: from donizetti.metropole.lan (94.222.26.109.rev.sfr.net. [109.26.222.94]) by smtp.gmail.com with ESMTPSA id q12sm9285661wrw.91.2019.10.29.09.22.51 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 29 Oct 2019 09:22:51 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=sLnJuV1CfPJkVM9GKln4msacMdvBWBdZJ+5D0UICXmE=; b=XrC2TNJmex2/AA6vwp4mdzWB6sJ3gEPkJEmmdwxZfGlDt/hZzjaaVScz94MeAoRzZ7 PZiqeTSk14Lb0uYQkVgu4holHBVPD1aqhzhlkz40wwLNMBREE/Nmqz01JZCCFBqiD73d hfsmtFHdWQ8h87Ywtx1ul6F211EFWTYzrQ7oAX4KJDQE8JuCnn+2rGf4PKuwTKtYu/wt /74lJPWlQ8XuXrawbVqRRnZ2VXmxRCtKt7hQLPbMMKJyhEo2TMQ3v4T/5oL0ZJnpdYjH 3T8yWayJ9ydZaSPLObW+dgekcWzst1EuT5enOPqs/nKDUai3xlTu7WJXZBM/x1Eb5DDw 9CYQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=sLnJuV1CfPJkVM9GKln4msacMdvBWBdZJ+5D0UICXmE=; b=bNHdQf0aMdyqqP/QXUGC9bowYWvoRdIX1a3lRvVU0yuJupfphQHrOM5yvaYOnrmzSX zj1vXBGmmNO99zacuS0o9PaPlLn2OtR7BUKvrn3ucNjmlbKwGGGQqyP0gMerN8+mZbVP aqGqFLPAfz+igvQzb5DNYfrisGkFFsG0trKEaBrqSBc09wIxEgQaEfir1U1lLOxUcIqx bigciNIBKICF7SmP/dWBDj7EJ/3XxF2hOAIZjPTHtPTqOdxa7g2xp+WynjwL+oe+Or33 XYjIA8Rvzvo1DZsYv98LOfn0xEipJ/1KYYPcKPo666wa5G4M80p06gxqh56fRQgeyWcJ zUHA== X-Gm-Message-State: APjAAAVGdPS2k6Sck7Ns1RpdxRHupG/rI+E3Vdi94a5wmR6XYfMn7mYx N5hUKllJxNUiUhaYQpP36rmJmwRYL10= X-Google-Smtp-Source: APXvYqxpfAT+5trWYX/sB6rzO/wo9mCBtpCp1wFXSyvI8Fq9ioc560eSsWxRpL4hiT4Cs3IoC/FHRQ== X-Received: by 2002:adf:fd08:: with SMTP id e8mr19761878wrr.42.1572366172513; Tue, 29 Oct 2019 09:22:52 -0700 (PDT) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PATCH 3/6] docs: disable sphinx warning about missing cross references Date: Tue, 29 Oct 2019 17:22:45 +0100 Message-Id: <20191029162248.13383-4-pbonzini@redhat.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20191029162248.13383-1-pbonzini@redhat.com> References: <20191029162248.13383-1-pbonzini@redhat.com> 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::432 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: peter.maydell@linaro.org Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Sphinx is a bit *too* strict about missing cross references to C types, where it complains about missing references to uint8_t. Even if that were fixed in kernel-doc, we would still have lots of missing references to types that are not yet documented. So unfortunately let's disable for now the nitpicking mode. Signed-off-by: Paolo Bonzini # still not a good idea,= probably --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index d20e7ffce3..8aa915ff26 100644 --- a/Makefile +++ b/Makefile @@ -986,7 +986,7 @@ sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html $(MANUA= L_BUILDDIR)/interop/index # Note the use of different doctree for each (manual, builder) tuple; # this works around Sphinx not handling parallel invocation on # a single doctree: https://github.com/sphinx-doc/sphinx/issues/2946 -build-manual =3D $(call quiet-command,CONFDIR=3D"$(qemu_confdir)" sphinx-b= uild $(if $(V),,-q) -W -n -b $2 -D version=3D$(VERSION) -D release=3D"$(FUL= L_VERSION)" -d .doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"= SPHINX","$(MANUAL_BUILDDIR)/$1") +build-manual =3D $(call quiet-command,CONFDIR=3D"$(qemu_confdir)" sphinx-b= uild $(if $(V),,-q) -W -b $2 -D version=3D$(VERSION) -D release=3D"$(FULL_V= ERSION)" -d .doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPH= INX","$(MANUAL_BUILDDIR)/$1") # We assume all RST files in the manual's directory are used in it manual-deps =3D $(wildcard $(SRC_PATH)/docs/$1/*.rst) $(SRC_PATH)/docs/$1/= conf.py $(SRC_PATH)/docs/conf.py =20 --=20 2.21.0 From nobody Sun Apr 28 13:30:33 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.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=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1572366460; cv=none; d=zoho.com; s=zohoarc; b=NknTExXCRdEBRVWPOEjiEGYMbjqJ9YmhyYFIqL5ixboqUVxzWoObBxwdUhnxOHZAOYyODFT5O2jeJcGqDWvEEC3KT1JvjHb5ds09kOP3G5m7QbmVerXNqe3u/hGEWXtVDdoFkNbxAixgjKIN9Hu20sTlgrwGTSMy+IneTyXUgOU= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1572366460; 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=CKVENrRxKr+yy55UKAYjTBDTqL1/JJ86swpmf0+y21k=; b=L/SDrGvgVPl8jwxdlJ2OPXEFICnFpCYhjnPsL4jREK24iMadzcMSQGbCTb/34iTpHtghSgDVARyF9+FqSqOoTeGICV53fWkt0rBHyMHERJKVqT3KRSC3/b1YKqAiRw3lhmx29ONAAguKjvRW08TXPAZM8yzeQQ7c9ZtIUv/oMdw= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail 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 1572366460284273.4846988084714; Tue, 29 Oct 2019 09:27:40 -0700 (PDT) Received: from localhost ([::1]:59664 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iPULK-00084I-KR for importer@patchew.org; Tue, 29 Oct 2019 12:27:38 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50681) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iPUGm-00023G-Bk for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:22:57 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iPUGl-0004tP-8i for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:22:56 -0400 Received: from mail-wm1-x343.google.com ([2a00:1450:4864:20::343]:35818) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iPUGl-0004qz-2L for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:22:55 -0400 Received: by mail-wm1-x343.google.com with SMTP id x5so3086377wmi.0 for ; Tue, 29 Oct 2019 09:22:55 -0700 (PDT) Received: from donizetti.metropole.lan (94.222.26.109.rev.sfr.net. [109.26.222.94]) by smtp.gmail.com with ESMTPSA id q12sm9285661wrw.91.2019.10.29.09.22.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 29 Oct 2019 09:22:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=CKVENrRxKr+yy55UKAYjTBDTqL1/JJ86swpmf0+y21k=; b=kiUdGpbH6NIroU7ZuajNuTodiCcmbzoX5gUPPTF47CgCtM6wqFmcI6SgBBC+kmlqfc efD32n+GdDo5zI/TGaKn3ih9o/4SGSgrAYkNqC4txbnxIp4rYEOFQxWYBD8Lvtk3gZWc tXZIwLQ/x2gTFKcLt+ki7MXHTvJlLX4ww8Y35T1T1B+YO5qvgaPcDbJXz03woidYQhR+ SikxhFFIUAqyGt+GAJP7mG4kd8ekco5nes6vnZIZ5d9/RNKeTYgeUvT765RyDrZvXXiM BX8V6PhJl/CqzVuPeZyKVj+NhQ44+umKUHh1VoLa3hBuwdpCNWUrQ7NTe/MxWEDsrHl5 tTVA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=CKVENrRxKr+yy55UKAYjTBDTqL1/JJ86swpmf0+y21k=; b=bWZ90PkoIxkIP+bjTMngCPKuYAFxsqRV5cCLAXYVm+w6lYGh116iOsKoHq2Bl7vUZk 5Mt1GygjDyuI8hmtQKmE2BcdoOLyr4AylgTHqaslTMT2mY+tuByo5Xs6g5H4jh9ARCb1 UlTfVl2kHYsCdb/MrOdY8OPr5PRDslNYlB74Fixil1oEVoOhBo5BApvq4c/aHRVfUu6R oK2rfwZkUW1T4v7Mf89q7dEzCl1dwjfp0UCk+bqFY6JwTLoB9+aFrNs/ARWx350nXnGv tzcBnjZW7+sjyyA+tneGggJoPDC32gXZ6e5Z00x39VFQnkV9sXdzPA08Q67nP8SfKXtV yoEQ== X-Gm-Message-State: APjAAAU+gg5l5wre4InEHuJWeoI2VB1JRAIFaZni77TuPLiBiDGPDDTn UkbW7Y6bR+IckU3UOamecAifFHkkrJw= X-Google-Smtp-Source: APXvYqzQFpN5cGz5sytcAt3c1aTii/pnU0NgsWJ2Rfo7Cznb8YtKkDU8tvC877rZuoMq0HAfiOCTHA== X-Received: by 2002:a1c:a791:: with SMTP id q139mr4750556wme.155.1572366173776; Tue, 29 Oct 2019 09:22:53 -0700 (PDT) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PATCH 4/6] memory: adjust API documentation to (modified) kerneldoc format Date: Tue, 29 Oct 2019 17:22:46 +0100 Message-Id: <20191029162248.13383-5-pbonzini@redhat.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20191029162248.13383-1-pbonzini@redhat.com> References: <20191029162248.13383-1-pbonzini@redhat.com> 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::343 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: peter.maydell@linaro.org Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Fix a few instances where kernel-doc complains about doc comments in memory.h. Signed-off-by: Paolo Bonzini --- include/exec/memory.h | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/include/exec/memory.h b/include/exec/memory.h index e499dc215b..1e875996ec 100644 --- a/include/exec/memory.h +++ b/include/exec/memory.h @@ -360,10 +360,14 @@ typedef struct IOMMUMemoryRegionClass { typedef struct CoalescedMemoryRange CoalescedMemoryRange; typedef struct MemoryRegionIoeventfd MemoryRegionIoeventfd; =20 +/** MemoryRegion: + * + * A struct representing a memory region. + */ struct MemoryRegion { Object parent_obj; =20 - /* All fields are private - violators will be prosecuted */ + /* private: */ =20 /* The following fields should fit in a cache line */ bool romd_mode; @@ -452,7 +456,7 @@ struct MemoryListener { * AddressSpace: describes a mapping of addresses to #MemoryRegion objects */ struct AddressSpace { - /* All fields are private. */ + /* private: */ struct rcu_head rcu; char *name; MemoryRegion *root; @@ -1673,8 +1677,8 @@ bool memory_region_is_mapped(MemoryRegion *mr); * * Returns a #MemoryRegionSection that describes a contiguous overlap. * It will have the following characteristics: - * .@size =3D 0 iff no overlap was found - * .@mr is non-%NULL iff an overlap was found + * - @size =3D 0 iff no overlap was found + * - @mr is non-%NULL iff an overlap was found * * Remember that in the return value the @offset_within_region is * relative to the returned region (in the .@mr field), not to the @@ -1685,8 +1689,8 @@ bool memory_region_is_mapped(MemoryRegion *mr); * returned one. However, in the special case where the @mr argument * has no container (and thus is the root of the address space), the * following will hold: - * .@offset_within_address_space >=3D @addr - * .@offset_within_address_space + .@size <=3D @addr + @size + * - @offset_within_address_space >=3D @addr + * - @offset_within_address_space + .@size <=3D @addr + @size * * @mr: a MemoryRegion within which @addr is a relative address * @addr: start of the area within @as to be searched --=20 2.21.0 From nobody Sun Apr 28 13:30:33 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.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=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1572366542; cv=none; d=zoho.com; s=zohoarc; b=Hg57C1try7ML2rJVr0lLPMSg3UvDpmXi/1cbZgPojrIjlOECetdKFa3tkz0UgXAcyVZx8gu5On4VFxOBzFVZZxLqpRK4VKWfWe+bja+EesNUXx+/leT7ZsRBleV72rU3QT/nZGd+Fr3ycY82raLa3pYUodFIpkh/DwMUVXtYU+g= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1572366542; 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=h1QbsiBqD4r5lnwOURLn9f9iSFyppDHdfk3gzxS4r6U=; b=kmZNFwbQ0X4XnPJXpBtXcjtekbHFnFpKzt1GTDuXbcv6/XAyKPoyo41HT12vSU8IM3jP95JnaIzluapE0wvGWhsbo/VrwptbRUJZqW4GvJsg7nclU9BiJGbZjPEBi9JMtF1aEm0n00bIqnp8lvatw/o8yEtIz1M9/TtvAeMjukc= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail 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 1572366542601432.45286530127055; Tue, 29 Oct 2019 09:29:02 -0700 (PDT) Received: from localhost ([::1]:59676 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iPUMf-00013Z-3v for importer@patchew.org; Tue, 29 Oct 2019 12:29:01 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50698) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iPUGn-00024l-BH for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:22:58 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iPUGm-0004w5-9x for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:22:57 -0400 Received: from mail-wr1-x443.google.com ([2a00:1450:4864:20::443]:36117) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iPUGm-0004uP-3c for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:22:56 -0400 Received: by mail-wr1-x443.google.com with SMTP id w18so14364083wrt.3 for ; Tue, 29 Oct 2019 09:22:56 -0700 (PDT) Received: from donizetti.metropole.lan (94.222.26.109.rev.sfr.net. [109.26.222.94]) by smtp.gmail.com with ESMTPSA id q12sm9285661wrw.91.2019.10.29.09.22.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 29 Oct 2019 09:22:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=h1QbsiBqD4r5lnwOURLn9f9iSFyppDHdfk3gzxS4r6U=; b=L3aGq4Hl598VyZ1Flp2BUR6RW92uCJKTIK9G5LlNdQnG04M7NIrVh/cfvWQsOK1y2+ RnkftyYzZg8zSvFrfhUHacozowRrXKrQJfvGo4DiJ3t1CtQsnd3jAU0wGq5zuQa8bagC L7YLyzf6irZIirWXoQL+VjA0DN7qj9YGS3L/99pwUPijms2yKA7RRH0N2e4MRYPptwj8 +5zz4d1zYLlDNvnRCqyhj8XlUd5XCB4HU2EsEO/nJpA6o6SfpzSY20BeSTCyIhNxMerI CGu8/cO2VTxHj8aZPmJF+KPpDiejY/4/inHx53DbeVHdIV3pltvD1lombOQJFECRAJTJ /Hwg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=h1QbsiBqD4r5lnwOURLn9f9iSFyppDHdfk3gzxS4r6U=; b=UuptgmNG5ANPsobkJUOzfJBDwAIF2dP4IGlFwtBSBdzAf0uVejUd7yzySdHXEa/80+ bO5HaO6eCPYzVQQkI9cX+P++89xPIMKX8EWPrZ15GqJrvjF0hLsmUneHqPdV5njPaoKQ b/Wgz3HB+tTFb4JxLiHES1LxzQxp2gdJzCSFvZR+SHRouv4M5NtnROkLQZDZSuXDLNvc A4mfyEixF/XWrOovDVhabQs7VMCMdO6uMo9+y8Ho7kSjXhUaSfjGpiMvPqZc88RtAwnN bHxyeagmxuK3mMNAVMOCBRGQwFXCk3FCIwArYJEI1sKnbsDZR6qSgrArFUzCtfAYMOIB xzQw== X-Gm-Message-State: APjAAAX2+YJ0B5UIImmJDG/UsYCe8Zd9pzjy03zWn/Kmh/WIH3ZffLW9 JSRmMgkh+heYpZybLaKU8stmc+Qdj6Q= X-Google-Smtp-Source: APXvYqwBuwWeGY2vqsXFXN08nj198hdvdjBF4z0lk8WH7L0gP/bK5wfbwgp4j9sV6fnoV9dOy0k9Yg== X-Received: by 2002:a5d:544b:: with SMTP id w11mr4422790wrv.205.1572366174870; Tue, 29 Oct 2019 09:22:54 -0700 (PDT) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PATCH 5/6] docs: add memory API reference Date: Tue, 29 Oct 2019 17:22:47 +0100 Message-Id: <20191029162248.13383-6-pbonzini@redhat.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20191029162248.13383-1-pbonzini@redhat.com> References: <20191029162248.13383-1-pbonzini@redhat.com> 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::443 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: peter.maydell@linaro.org Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Add kernel-doc directive to parse and include doc comments from include/exec/memory.h. Signed-off-by: Paolo Bonzini --- docs/devel/memory.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/devel/memory.rst b/docs/devel/memory.rst index b6a4c37ea5..5dc8a12682 100644 --- a/docs/devel/memory.rst +++ b/docs/devel/memory.rst @@ -361,3 +361,8 @@ callbacks are called: - .impl.unaligned specifies that the *implementation* supports unaligned accesses; if false, unaligned accesses will be emulated by two aligned accesses. + +API Reference +------------- + +.. kernel-doc:: include/exec/memory.h --=20 2.21.0 From nobody Sun Apr 28 13:30:33 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.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=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1572366481; cv=none; d=zoho.com; s=zohoarc; b=gvKZRSjCo6BfQHBtApfmfnr3zgTjr9sPQMdJGzVRhZ/Xnais3YjDH7zlnmZy7klA2qISK88QH/PHzjW0jE7BhssQV1KmpX7KPMoOVmbS7sWWGNJmnLDNE5EC+QDJN7drFctbrdtEpN5rPGgHICSrgqwAeKInl/7Js9ZkGUlbhSc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1572366481; 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=JLypjmRTb08Qb0V0OoJj2WZu63pj51rP4Zc4f/igiag=; b=LX7loGz9kY4RpFtqa4bj7UyLEY/taAhFbjPeXYyHxxUgPgWd9Z4QPf0vwfaz+thhoclVNNnGCGic0uhStJ8+DASZctk19+x1xEu7biDtvsLex6+G4iC/VBEWsvvtXu/Ayxt/GB2YFgIR4/aH3UQ3hGWWmJgIxEueAEYOxLmRNCA= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=fail; spf=pass (zoho.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail 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 157236648143440.08080132240798; Tue, 29 Oct 2019 09:28:01 -0700 (PDT) Received: from localhost ([::1]:59666 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iPULf-0008IE-T8 for importer@patchew.org; Tue, 29 Oct 2019 12:27:59 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50719) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iPUGp-00027m-Dn for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:23:01 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iPUGn-0004xa-CJ for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:22:59 -0400 Received: from mail-wr1-x442.google.com ([2a00:1450:4864:20::442]:45054) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iPUGn-0004wH-5C for qemu-devel@nongnu.org; Tue, 29 Oct 2019 12:22:57 -0400 Received: by mail-wr1-x442.google.com with SMTP id z11so14298232wro.11 for ; Tue, 29 Oct 2019 09:22:57 -0700 (PDT) Received: from donizetti.metropole.lan (94.222.26.109.rev.sfr.net. [109.26.222.94]) by smtp.gmail.com with ESMTPSA id q12sm9285661wrw.91.2019.10.29.09.22.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 29 Oct 2019 09:22:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=JLypjmRTb08Qb0V0OoJj2WZu63pj51rP4Zc4f/igiag=; b=gtn4D5MDqbMuLY8udXoxMGtWyR8wRlsZ+vJjWwKNcHX8ZV4ksnRsIDTa81jVYeDw1M g3UA2lWZf2JApEpH7P61s0gJFP36o8NNUBVYEDc93JLPyRMFza0rfonWPJFMqXsgfjYG y3Su6WYfHcgJ8sOXA3fyMvzRL076AVA+lWvVYBLgInbbULUN+mGlwphBu88JuQpseKr7 flaMnkjkG/kO5N6Mz37KIEJCtsGVnTc/3rW6b2+q3oeXKNALL0DFyO/q42gjSe4kXmJE FMHStU11EaO8NT2/qGzwo34CgOgrJ32e88/Iq7DXObdx48FGfyNKaDWFz5qVlwLFJEc5 SIAw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; bh=JLypjmRTb08Qb0V0OoJj2WZu63pj51rP4Zc4f/igiag=; b=OBM/ZvQUTyrUM+wXh0osaVmuiJt/GSNvYBXBKC/ZbDaUDquD2NPWopAXo5BFaeWunK msy+WKNU9X856y+AGDEsZqDct36DJT4eierkSu5FJ/vur4S+wne7tqtt9Nwatky0svPn UJGxAHTx3RsaaUUZ+GW41Zdu0V5nEEVpSsgIFGqYY1LD0AQtTnTTfCk57JK/+UBZgIkC ZPW3cZWzEDSR/5A0rQ5NHk7uqz8cPyNeToIk+n8J3Rcp9Pg36qGIeF+FtzrEcXocK52x sf3hayolzlVf2AaZIbSTpd8VdV8rzkqYTGY32rEOgslRGU/rosDS2SRWyTRq7xBgiuR7 XRdQ== X-Gm-Message-State: APjAAAVmq1M7bt+gY0KVMB3erLI1aolWyegCUK1iPIqO8/t99VjH9uJF mL8OP2eZPpBCHA5Eiuqvj6cwvzpI/eo= X-Google-Smtp-Source: APXvYqz3CotIYvIP4v/XmrS+zlqmN9lPwUZ9J5AzfpfcDfEJspSMKkM/MoJzw03QP43dEW7SzmZCYg== X-Received: by 2002:adf:cd84:: with SMTP id q4mr20440845wrj.153.1572366175669; Tue, 29 Oct 2019 09:22:55 -0700 (PDT) From: Paolo Bonzini To: qemu-devel@nongnu.org Subject: [PATCH 6/6] memory: include MemoryListener documentation and some missing function parameters Date: Tue, 29 Oct 2019 17:22:48 +0100 Message-Id: <20191029162248.13383-7-pbonzini@redhat.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20191029162248.13383-1-pbonzini@redhat.com> References: <20191029162248.13383-1-pbonzini@redhat.com> 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::442 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: peter.maydell@linaro.org Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" These cover the remaining warnings from kernel-doc. Signed-off-by: Paolo Bonzini --- include/exec/memory.h | 211 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 209 insertions(+), 2 deletions(-) diff --git a/include/exec/memory.h b/include/exec/memory.h index 1e875996ec..c84fde75fa 100644 --- a/include/exec/memory.h +++ b/include/exec/memory.h @@ -423,30 +423,232 @@ struct IOMMUMemoryRegion { * Use with memory_listener_register() and memory_listener_unregister(). */ struct MemoryListener { + /** + * @begin: + * + * Called at the beginning of an address space update transaction. + * Followed by calls to #MemoryListener.region_add(), + * #MemoryListener.region_del(), #MemoryListener.region_nop(), + * #MemoryListener.log_start() and #MemoryListener.log_stop() in + * increasing address order. + * + * @listener: The #MemoryListener. + */ void (*begin)(MemoryListener *listener); + + /** + * @commit: + * + * Called at the end of an address space update transaction, + * after the last call to #MemoryListener.region_add(), + * #MemoryListener.region_del() or #MemoryListener.region_nop(), + * #MemoryListener.log_start() and #MemoryListener.log_stop(). + * + * @listener: The #MemoryListener. + */ void (*commit)(MemoryListener *listener); + + /** + * @region_add: + * + * Called during an address space update transaction, + * for a section of the address space that is new in this address space + * space since the last transaction. + * + * @listener: The #MemoryListener. + * @section: The new #MemoryRegionSection. + */ void (*region_add)(MemoryListener *listener, MemoryRegionSection *sect= ion); + + /** + * @region_del: + * + * Called during an address space update transaction, + * for a section of the address space that has disappeared in the addr= ess + * space since the last transaction. + * + * @listener: The #MemoryListener. + * @section: The old #MemoryRegionSection. + */ void (*region_del)(MemoryListener *listener, MemoryRegionSection *sect= ion); + + /** + * @region_nop: + * + * Called during an address space update transaction, + * for a section of the address space that is in the same place in the= address + * space as in the last transaction. + * + * @listener: The #MemoryListener. + * @section: The #MemoryRegionSection. + */ void (*region_nop)(MemoryListener *listener, MemoryRegionSection *sect= ion); + + /** + * @log_start: + * + * Called during an address space update transaction, after + * one of #MemoryListener.region_add(),#MemoryListener.region_del() or + * #MemoryListener.region_nop(), if dirty memory logging clients have + * become active since the last transaction. + * + * @listener: The #MemoryListener. + * @section: The #MemoryRegionSection. + * @old: A bitmap of dirty memory logging clients that were active in + * the previous transaction. + * @new: A bitmap of dirty memory logging clients that are active in + * the current transaction. + */ void (*log_start)(MemoryListener *listener, MemoryRegionSection *secti= on, int old, int new); + + /** + * @log_stop: + * + * Called during an address space update transaction, after + * one of #MemoryListener.region_add(), #MemoryListener.region_del() or + * #MemoryListener.region_nop() and possibly after + * #MemoryListener.log_start(), if dirty memory logging clients have + * become inactive since the last transaction. + * + * @listener: The #MemoryListener. + * @section: The #MemoryRegionSection. + * @old: A bitmap of dirty memory logging clients that were active in + * the previous transaction. + * @new: A bitmap of dirty memory logging clients that are active in + * the current transaction. + */ void (*log_stop)(MemoryListener *listener, MemoryRegionSection *sectio= n, int old, int new); + + /** + * @log_sync: + * + * Called by memory_region_snapshot_and_clear_dirty() and + * memory_global_dirty_log_sync(), before accessing QEMU's "official" + * copy of the dirty memory bitmap for a #MemoryRegionSection. + * + * @listener: The #MemoryListener. + * @section: The #MemoryRegionSection. + */ void (*log_sync)(MemoryListener *listener, MemoryRegionSection *sectio= n); + + /** + * @log_clear: + * + * Called before reading the dirty memory bitmap for a + * #MemoryRegionSection. + * + * @listener: The #MemoryListener. + * @section: The #MemoryRegionSection. + */ void (*log_clear)(MemoryListener *listener, MemoryRegionSection *secti= on); + + /** + * @log_global_start: + * + * Called by memory_global_dirty_log_start(), which + * enables the %DIRTY_LOG_MIGRATION client on all memory regions in + * the address space. #MemoryListener.log_global_start() is also + * called when a #MemoryListener is added, if global dirty logging is + * active at that time. + * + * @listener: The #MemoryListener. + */ void (*log_global_start)(MemoryListener *listener); + + /** + * @log_global_stop: + * + * Called by memory_global_dirty_log_stop(), which + * disables the %DIRTY_LOG_MIGRATION client on all memory regions in + * the address space. + * + * @listener: The #MemoryListener. + */ void (*log_global_stop)(MemoryListener *listener); + + /** + * @log_global_after_sync: + * + * Called after reading the dirty memory bitmap + * for any #MemoryRegionSection. + * + * @listener: The #MemoryListener. + */ void (*log_global_after_sync)(MemoryListener *listener); + + /** + * @eventfd_add: + * + * Called during an address space update transaction, + * for a section of the address space that has had a new ioeventfd + * registration since the last transaction. + * + * @listener: The #MemoryListener. + * @section: The new #MemoryRegionSection. + * @match_data: The @match_data parameter for the new ioeventfd. + * @data: The @data parameter for the new ioeventfd. + * @e: The #EventNotifier parameter for the new ioeventfd. + */ void (*eventfd_add)(MemoryListener *listener, MemoryRegionSection *sec= tion, bool match_data, uint64_t data, EventNotifier *e); + + /** + * @eventfd_del: + * + * Called during an address space update transaction, + * for a section of the address space that has dropped an ioeventfd + * registration since the last transaction. + * + * @listener: The #MemoryListener. + * @section: The new #MemoryRegionSection. + * @match_data: The @match_data parameter for the dropped ioeventfd. + * @data: The @data parameter for the dropped ioeventfd. + * @e: The #EventNotifier parameter for the dropped ioeventfd. + */ void (*eventfd_del)(MemoryListener *listener, MemoryRegionSection *sec= tion, bool match_data, uint64_t data, EventNotifier *e); + + /** + * @coalesced_io_add: + * + * Called during an address space update transaction, + * for a section of the address space that has had a new coalesced + * MMIO range registration since the last transaction. + * + * @listener: The #MemoryListener. + * @section: The new #MemoryRegionSection. + * @addr: The starting address for the coalesced MMIO range. + * @len: The length of the coalesced MMIO range. + */ void (*coalesced_io_add)(MemoryListener *listener, MemoryRegionSection= *section, hwaddr addr, hwaddr len); + + /** + * @coalesced_io_del: + * + * Called during an address space update transaction, + * for a section of the address space that has dropped a coalesced + * MMIO range since the last transaction. + * + * @listener: The #MemoryListener. + * @section: The new #MemoryRegionSection. + * @addr: The starting address for the coalesced MMIO range. + * @len: The length of the coalesced MMIO range. + */ void (*coalesced_io_del)(MemoryListener *listener, MemoryRegionSection= *section, hwaddr addr, hwaddr len); - /* Lower =3D earlier (during add), later (during del) */ + /** + * @priority: + * + * Govern the order in which memory listeners are invoked. Lower prior= ities + * are invoked earlier for "add" or "start" callbacks, and later for "= delete" + * or "stop" callbacks. + */ unsigned priority; + + /* private: */ AddressSpace *address_space; QTAILQ_ENTRY(MemoryListener) link; QTAILQ_ENTRY(MemoryListener) link_as; @@ -940,6 +1142,7 @@ void memory_region_init_rom(MemoryRegion *mr, * @mr: the #MemoryRegion to be initialized. * @owner: the object that tracks the region's reference count * @ops: callbacks for write access handling (must not be NULL). + * @opaque: passed to the read and write callbacks of the @ops structure. * @name: Region name, becomes part of RAMBlock name used in migration str= eam * must be unique within any device * @size: size of the region. @@ -1028,7 +1231,7 @@ static inline IOMMUMemoryRegion *memory_region_get_io= mmu(MemoryRegion *mr) * Returns pointer to IOMMUMemoryRegionClass if a memory region is an iomm= u, * otherwise NULL. This is fast path avoiding QOM checking, use with cauti= on. * - * @mr: the memory region being queried + * @iommu_mr: the memory region being queried */ static inline IOMMUMemoryRegionClass *memory_region_get_iommu_class_nochec= k( IOMMUMemoryRegion *iommu_mr) @@ -1098,6 +1301,7 @@ void memory_region_notify_one(IOMMUNotifier *notifier, * @n: the IOMMUNotifier to be added; the notify callback receives a * pointer to an #IOMMUTLBEntry as the opaque value; the pointer * ceases to be valid on exit from the notifier. + * @errp: pointer to Error*, to store an error if it happens. */ int memory_region_register_iommu_notifier(MemoryRegion *mr, IOMMUNotifier *n, Error **errp); @@ -1585,6 +1789,8 @@ void memory_region_add_subregion_overlap(MemoryRegion= *mr, /** * memory_region_get_ram_addr: Get the ram address associated with a memory * region + * + * @mr: the region to be queried */ ram_addr_t memory_region_get_ram_addr(MemoryRegion *mr); =20 @@ -2155,6 +2361,7 @@ static inline bool memory_access_is_direct(MemoryRegi= on *mr, bool is_write) * @addr: address within that address space * @attrs: memory transaction attributes * @buf: buffer with the data transferred + * @len: length of the data transferred */ static inline __attribute__((__always_inline__)) MemTxResult address_space_read(AddressSpace *as, hwaddr addr, --=20 2.21.0