[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 19/19] docs/devel: add some clarifying text for aliases
From: |
Philippe Mathieu-Daudé |
Subject: |
[PULL 19/19] docs/devel: add some clarifying text for aliases |
Date: |
Tue, 18 Jan 2022 13:02:29 +0100 |
From: Alex Bennée <alex.bennee@linaro.org>
We do mention the limitation of single parenthood for
memory_region_add_subregion but lets also make it clear how aliases
help solve that conundrum.
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Message-Id: <20220110175104.2908956-7-alex.bennee@linaro.org>
Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
---
docs/devel/memory.rst | 14 +++++++++-----
1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/docs/devel/memory.rst b/docs/devel/memory.rst
index 5dc8a126829..69c5e3f914a 100644
--- a/docs/devel/memory.rst
+++ b/docs/devel/memory.rst
@@ -67,11 +67,15 @@ MemoryRegion):
You initialize a pure container with memory_region_init().
-- alias: a subsection of another region. Aliases allow a region to be
- split apart into discontiguous regions. Examples of uses are memory banks
- used when the guest address space is smaller than the amount of RAM
- addressed, or a memory controller that splits main memory to expose a "PCI
- hole". Aliases may point to any type of region, including other aliases,
+- alias: a subsection of another region. Aliases allow a region to be
+ split apart into discontiguous regions. Examples of uses are memory
+ banks used when the guest address space is smaller than the amount
+ of RAM addressed, or a memory controller that splits main memory to
+ expose a "PCI hole". You can also create aliases to avoid trying to
+ add the original region to multiple parents via
+ `memory_region_add_subregion`.
+
+ Aliases may point to any type of region, including other aliases,
but an alias may not point back to itself, directly or indirectly.
You initialize these with memory_region_init_alias().
--
2.34.1
- [PULL 00/19] Memory API patches for 2022-01-18, Philippe Mathieu-Daudé, 2022/01/18
- [PULL 01/19] memory: Directly dispatch alias accesses on origin memory region, Philippe Mathieu-Daudé, 2022/01/18
- [PULL 04/19] machine: Use host_memory_backend_is_mapped() in machine_consume_memdev(), Philippe Mathieu-Daudé, 2022/01/18
- [PULL 02/19] memory: Split mtree_info() as mtree_info_flatview() + mtree_info_as(), Philippe Mathieu-Daudé, 2022/01/18
- [PULL 03/19] memory: Have 'info mtree' remove duplicated Address Space information, Philippe Mathieu-Daudé, 2022/01/18
- [PULL 06/19] memory: Update description of memory_region_is_mapped(), Philippe Mathieu-Daudé, 2022/01/18
- [PULL 08/19] stubs: Restrict fw_cfg to system emulation, Philippe Mathieu-Daudé, 2022/01/18
- [PULL 10/19] hw/pci: Restrict pci-bus stub to sysemu, Philippe Mathieu-Daudé, 2022/01/18
- [PULL 19/19] docs/devel: add some clarifying text for aliases,
Philippe Mathieu-Daudé <=
- [PULL 17/19] hw/dma: Use dma_addr_t type definition when relevant, Philippe Mathieu-Daudé, 2022/01/18
- [PULL 12/19] hw/dma: Remove CONFIG_USER_ONLY check, Philippe Mathieu-Daudé, 2022/01/18
- [PULL 07/19] memory: Fix incorrect calls of log_global_start/stop, Philippe Mathieu-Daudé, 2022/01/18
- [PULL 09/19] hw/nvram: Restrict fw_cfg QOM interface to sysemu and tools, Philippe Mathieu-Daudé, 2022/01/18
- [PULL 05/19] memory: Make memory_region_is_mapped() succeed when mapped via an alias, Philippe Mathieu-Daudé, 2022/01/18
- [PULL 16/19] hw/dma: Move ScatterGatherEntry / QEMUSGList declarations around, Philippe Mathieu-Daudé, 2022/01/18
- [PULL 14/19] hw/scsi: Rename SCSIRequest::resid as 'residual', Philippe Mathieu-Daudé, 2022/01/18
- [PULL 11/19] hw/pci: Document pci_dma_map(), Philippe Mathieu-Daudé, 2022/01/18
- [PULL 13/19] hw/rdma/rdma_utils: Rename rdma_pci_dma_map 'len' argument, Philippe Mathieu-Daudé, 2022/01/18
- [PULL 18/19] hw/dma: Let dma_buf_read() / dma_buf_write() propagate MemTxResult, Philippe Mathieu-Daudé, 2022/01/18