[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[RFC PATCH 6/6] docs/devel: add some clarifying text for aliases
From: |
Alex Bennée |
Subject: |
[RFC PATCH 6/6] docs/devel: add some clarifying text for aliases |
Date: |
Mon, 10 Jan 2022 17:51:04 +0000 |
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>
---
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 5dc8a12682..69c5e3f914 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.30.2
- [RFC PATCH 0/6] Basic skeleton of RP2040 Raspbery Pi Pico, Alex Bennée, 2022/01/10
- [RFC PATCH 2/6] hw/arm: add boilerplate for machines based on the RP2040, Alex Bennée, 2022/01/10
- [RFC PATCH 5/6] hw/arm: add mask boot ROM logic, Alex Bennée, 2022/01/10
- [RFC PATCH 1/6] hw/arm: arm initial boilerplate for RP2040 SoC, Alex Bennée, 2022/01/10
- [RFC PATCH 3/6] hw/arm: wire-up memory from the Pico board and the SoC, Alex Bennée, 2022/01/10
- [RFC PATCH 4/6] pc-bios: add pipico mask rom (!upstream), Alex Bennée, 2022/01/10
- [RFC PATCH 6/6] docs/devel: add some clarifying text for aliases,
Alex Bennée <=