exec/memory: Fix memory_region_init_alias() documentation

[PATCH-for-5.1?] exec/memory: Fix memory_region_init_alias() documentation

Philippe Mathieu-Daudé posted 1 patch 3 years, 9 months ago

Download mbox

Test docker-quick@centos7 failed

Test docker-mingw@fedora failed

Test checkpatch failed

Test FreeBSD failed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20200723111838.32398-1-f4bug@amsat.org

include/exec/memory.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

Expand all Fold all

[PATCH-for-5.1?] exec/memory: Fix memory_region_init_alias() documentation

Posted by Philippe Mathieu-Daudé 3 years, 9 months ago

The @size argument refers to the size of the aliased
section, not the original region.

Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
---
 include/exec/memory.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/exec/memory.h b/include/exec/memory.h
index 307e527835..10a809ee10 100644
--- a/include/exec/memory.h
+++ b/include/exec/memory.h
@@ -980,8 +980,8 @@ void memory_region_init_ram_device_ptr(MemoryRegion *mr,
  * @name: used for debugging; not visible to the user or ABI
  * @orig: the region to be referenced; @mr will be equivalent to
  *        @orig between @offset and @offset + @size - 1.
- * @offset: start of the section in @orig to be referenced.
- * @size: size of the region.
+ * @offset: start of the section in @orig.
+ * @size: size of the section in @orig.
  */
 void memory_region_init_alias(MemoryRegion *mr,
                               struct Object *owner,
-- 
2.21.3