From nobody Tue Feb 10 00:23:06 2026 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=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1558442227; cv=none; d=zoho.com; s=zohoarc; b=Hlp52G4QNKS0i/2JRyRAFGapBRSNigZEIgPb8yH+3okLOeiFbuho51SeU0jQygG1AssYD7b/QD7+uAG3n+p7i2e7DaSw4ZkxLsj0CJ3erCknlqVovn6iomRLaCzUQHnDGvNed9OsgWVG4lznQowYnH1rFgqZAH/uISMAeKJxxVI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1558442227; 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:ARC-Authentication-Results; bh=/6fZvTwbiNEGi+N3ZL26FN4PNtHy8EurrYMXN2rAFp0=; b=gQ4IP2aAgUZrP/usIwMtfVRXSk2p0JqZTP+lvFol3Xards3d8bGDqJCra1Z/4X20oY+b+ITYNX7UyZiaM5UIoRP4YDxGmGyivfy2xF0yl1vnhGJuc1difX1pzY9IXWA9QdgOxLGT9ijy8KtRmqLJbiVpxqimy709rlMCw4AyXL4= 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 1558442227537741.8194239080584; Tue, 21 May 2019 05:37:07 -0700 (PDT) Received: from localhost ([127.0.0.1]:52841 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hT40A-0001BD-SB for importer@patchew.org; Tue, 21 May 2019 08:36:18 -0400 Received: from eggs.gnu.org ([209.51.188.92]:45343) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hT3q2-0001SM-Sk for qemu-devel@nongnu.org; Tue, 21 May 2019 08:25:53 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hT3pw-0005G1-W8 for qemu-devel@nongnu.org; Tue, 21 May 2019 08:25:48 -0400 Received: from mail-wr1-x442.google.com ([2a00:1450:4864:20::442]:45951) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hT3pw-0005A4-NC for qemu-devel@nongnu.org; Tue, 21 May 2019 08:25:44 -0400 Received: by mail-wr1-x442.google.com with SMTP id b18so18328012wrq.12 for ; Tue, 21 May 2019 05:25:36 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id u11sm12233393wrn.1.2019.05.21.05.25.34 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 21 May 2019 05:25:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=/6fZvTwbiNEGi+N3ZL26FN4PNtHy8EurrYMXN2rAFp0=; b=UDj+XYvN3CAPWQnMdjGuz4CBG2eXrGv5r1RTbJ5659Pur1V7x/o2dqcIhR9uJmbk/s AcNGLJg0M6HRtF8iD9VgWFR4VBc2t8smBsx2Cen+BHEy4Bef3cy9FaJy3WlO7ARQXNjz QqTuMTW4f115rdGfd9Ln3ddpA1L4mqDoQ0wTJQoUsX18PISmGT643c/9yS5bOK/glGx8 JzB/3kdwz0a1VSPLrdR9THRrwjoQA72s/WhlhVvYCC00giQLn2kqWOa2W4OMpjaNAdg5 w1CyXIqjn1JVNCKWXVCA1cAHwnlp0Nt7SFjCjZZP5N8raTSx17ERl/bur5EH+pDL4V5V uYJA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=/6fZvTwbiNEGi+N3ZL26FN4PNtHy8EurrYMXN2rAFp0=; b=sJOcm66bDn29Z4/dtKL6MLGrdpKLpjt60kJ2xiUhZrc3wBCAqZl8kOGQb1H95S2PRR G06qhOpsDj2U0B2gWpCjiH3jpH34YPzc8fJCDDsLoYe/dcjG+WJArLqgFgZWWU0fI8pr GVSwuPOc8hj2gUpjSeR9wtcE8rVA1/VNjUASNJEK+3YxPEbHS2lREdgsUI412clmVkW3 wBLAMJNbpOPWbBDHk4eHvilT/jfmcVJba6lGsyi70ahsfvdgM7AmTPcPz/O+En8xqUfq BM7ZyJ5whOKLaUOeSUIv05Za26S5lHioult/rr+9NGY+wDNpjXTY7EeD7yd6rRp0XXGI DTpA== X-Gm-Message-State: APjAAAW8dlLOV/AlthysvC2lrspekKKI1Iz2hAJDq6wqUML7YuoRrpyr NMXNW5nVPzcynI5f7uq9GyBBtRsIg+8= X-Google-Smtp-Source: APXvYqxSErixkeNMSitVLX6eEjsluk4iknCHa8akyiEY8p1EsaSEmfLFRI2zEPo9MrWYXOMvz8DaZw== X-Received: by 2002:a05:6000:1284:: with SMTP id f4mr38158764wrx.325.1558441535220; Tue, 21 May 2019 05:25:35 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 21 May 2019 13:25:18 +0100 Message-Id: <20190521122519.12573-10-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190521122519.12573-1-peter.maydell@linaro.org> References: <20190521122519.12573-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::442 Subject: [Qemu-devel] [RFC 09/10] memory.h: attempted kernel-doc fixes X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: "Daniel P. Berrange" , Eduardo Habkost , Gabriel Barreto , "Emilio G. Cota" , Stefan Hajnoczi , Cleber Rosa , Paolo Bonzini , John Snow 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" kernel-doc needs the "struct" or it complains that it can't parse a function prototype which is actually a struct definition. Note that this then creates a lot of warnings about undocumented struct fields... --- include/exec/memory.h | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/include/exec/memory.h b/include/exec/memory.h index 8447a16ded1..d0f35be1c3b 100644 --- a/include/exec/memory.h +++ b/include/exec/memory.h @@ -208,7 +208,7 @@ enum IOMMUMemoryRegionAttr { }; =20 /** - * IOMMUMemoryRegionClass: + * struct IOMMUMemoryRegionClass: * * All IOMMU implementations need to subclass TYPE_IOMMU_MEMORY_REGION * and provide an implementation of at least the @translate method here @@ -224,8 +224,10 @@ enum IOMMUMemoryRegionAttr { * attributes and the output TLB entry depends on the transaction * attributes, we represent this using IOMMU indexes. Each index * selects a particular translation table that the IOMMU has: - * @attrs_to_index returns the IOMMU index for a set of transaction attr= ibutes - * @translate takes an input address and an IOMMU index + * + * - @attrs_to_index returns the IOMMU index for a set of transaction att= ributes + * - @translate takes an input address and an IOMMU index + * * and the mapping returned can only depend on the input address and the * IOMMU index. * @@ -398,7 +400,7 @@ struct IOMMUMemoryRegion { QLIST_FOREACH((n), &(mr)->iommu_notify, node) =20 /** - * MemoryListener: callbacks structure for updates to the physical memory = map + * struct MemoryListener: callbacks structure for updates to the physical = memory map * * Allows a component to adjust to changes in the guest-visible memory map. * Use with memory_listener_register() and memory_listener_unregister(). @@ -432,7 +434,7 @@ struct MemoryListener { }; =20 /** - * AddressSpace: describes a mapping of addresses to #MemoryRegion objects + * struct AddressSpace: describes a mapping of addresses to #MemoryRegion = objects */ struct AddressSpace { /* All fields are private. */ @@ -472,7 +474,7 @@ static inline FlatView *address_space_to_flatview(Addre= ssSpace *as) =20 =20 /** - * MemoryRegionSection: describes a fragment of a #MemoryRegion + * struct MemoryRegionSection: describes a fragment of a #MemoryRegion * * @mr: the region, or %NULL if empty * @fv: the flat view of the address space the region is mapped in @@ -1653,8 +1655,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 @@ -1666,8 +1668,8 @@ bool memory_region_is_mapped(MemoryRegion *mr); * 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.20.1