| Message ID | 20180702130605.13611-1-peter.maydell@linaro.org |
|---|---|
| State | New |
| Headers | show |
| Series | [for-3.0] boards.h: Remove doc comment reference to nonexistent function | expand |
Ping for review? I can put this in via target-arm.next... thanks -- PMM On 2 July 2018 at 14:06, Peter Maydell <peter.maydell@linaro.org> wrote: > commit b08199c6fbea1 accidentally added a reference to a doc > comment to a nonexistent memory_region_allocate_aux_memory(). > This was a leftover from a previous version of the patchset > which defined memory_region_allocate_aux_memory() for > "allocate RAM MemoryRegion and register it for migration" > and left "memory_region_init_ram()" with its original semantics > of "allocate RAM MR but do not register for migration". In > the end we decided on the approach of "memory_region_init_ram() > registers the MR for migration, and memory_region_init_ram_nomigrate() > is a new function which does not", but this comment change > got left in by mistake. Revert that part of the commit. > > Reported-by: Thomas Huth <huth@tuxfamily.org> > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> > --- > Doesn't strictly need to go into 3.0, but it's a trivial > doc comment fix... > > include/hw/boards.h | 3 +-- > 1 file changed, 1 insertion(+), 2 deletions(-) > > diff --git a/include/hw/boards.h b/include/hw/boards.h > index 79069ddcbec..d139a431a67 100644 > --- a/include/hw/boards.h > +++ b/include/hw/boards.h > @@ -35,8 +35,7 @@ > * > * Smaller pieces of memory (display RAM, static RAMs, etc) don't need > * to be backed via the -mem-path memory backend and can simply > - * be created via memory_region_allocate_aux_memory() or > - * memory_region_init_ram(). > + * be created via memory_region_init_ram(). > */ > void memory_region_allocate_system_memory(MemoryRegion *mr, Object *owner, > const char *name, > -- > 2.17.1 > >
On 02/07/2018 15:06, Peter Maydell wrote: > commit b08199c6fbea1 accidentally added a reference to a doc > comment to a nonexistent memory_region_allocate_aux_memory(). > This was a leftover from a previous version of the patchset > which defined memory_region_allocate_aux_memory() for > "allocate RAM MemoryRegion and register it for migration" > and left "memory_region_init_ram()" with its original semantics > of "allocate RAM MR but do not register for migration". In > the end we decided on the approach of "memory_region_init_ram() > registers the MR for migration, and memory_region_init_ram_nomigrate() > is a new function which does not", but this comment change > got left in by mistake. Revert that part of the commit. > > Reported-by: Thomas Huth <huth@tuxfamily.org> > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> > --- > Doesn't strictly need to go into 3.0, but it's a trivial > doc comment fix... > > include/hw/boards.h | 3 +-- > 1 file changed, 1 insertion(+), 2 deletions(-) > > diff --git a/include/hw/boards.h b/include/hw/boards.h > index 79069ddcbec..d139a431a67 100644 > --- a/include/hw/boards.h > +++ b/include/hw/boards.h > @@ -35,8 +35,7 @@ > * > * Smaller pieces of memory (display RAM, static RAMs, etc) don't need > * to be backed via the -mem-path memory backend and can simply > - * be created via memory_region_allocate_aux_memory() or > - * memory_region_init_ram(). > + * be created via memory_region_init_ram(). > */ > void memory_region_allocate_system_memory(MemoryRegion *mr, Object *owner, > const char *name, > Sure, it's just a doc fix. Paolo
Am Mon, 9 Jul 2018 14:15:28 +0100 schrieb Peter Maydell <peter.maydell@linaro.org>: > Ping for review? I can put this in via target-arm.next... > > thanks > -- PMM > > On 2 July 2018 at 14:06, Peter Maydell <peter.maydell@linaro.org> > wrote: > > commit b08199c6fbea1 accidentally added a reference to a doc > > comment to a nonexistent memory_region_allocate_aux_memory(). > > This was a leftover from a previous version of the patchset > > which defined memory_region_allocate_aux_memory() for > > "allocate RAM MemoryRegion and register it for migration" > > and left "memory_region_init_ram()" with its original semantics > > of "allocate RAM MR but do not register for migration". In > > the end we decided on the approach of "memory_region_init_ram() > > registers the MR for migration, and > > memory_region_init_ram_nomigrate() is a new function which does > > not", but this comment change got left in by mistake. Revert that > > part of the commit. > > > > Reported-by: Thomas Huth <huth@tuxfamily.org> > > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> > > --- > > Doesn't strictly need to go into 3.0, but it's a trivial > > doc comment fix... > > > > include/hw/boards.h | 3 +-- > > 1 file changed, 1 insertion(+), 2 deletions(-) > > > > diff --git a/include/hw/boards.h b/include/hw/boards.h > > index 79069ddcbec..d139a431a67 100644 > > --- a/include/hw/boards.h > > +++ b/include/hw/boards.h > > @@ -35,8 +35,7 @@ > > * > > * Smaller pieces of memory (display RAM, static RAMs, etc) don't > > need > > * to be backed via the -mem-path memory backend and can simply > > - * be created via memory_region_allocate_aux_memory() or > > - * memory_region_init_ram(). > > + * be created via memory_region_init_ram(). > > */ > > void memory_region_allocate_system_memory(MemoryRegion *mr, Object > > *owner, const char *name, > > -- > > 2.17.1 FWIW: Reviewed-by: Thomas Huth <huth@tuxfamily.org>
diff --git a/include/hw/boards.h b/include/hw/boards.h index 79069ddcbec..d139a431a67 100644 --- a/include/hw/boards.h +++ b/include/hw/boards.h @@ -35,8 +35,7 @@ * * Smaller pieces of memory (display RAM, static RAMs, etc) don't need * to be backed via the -mem-path memory backend and can simply - * be created via memory_region_allocate_aux_memory() or - * memory_region_init_ram(). + * be created via memory_region_init_ram(). */ void memory_region_allocate_system_memory(MemoryRegion *mr, Object *owner, const char *name,
commit b08199c6fbea1 accidentally added a reference to a doc comment to a nonexistent memory_region_allocate_aux_memory(). This was a leftover from a previous version of the patchset which defined memory_region_allocate_aux_memory() for "allocate RAM MemoryRegion and register it for migration" and left "memory_region_init_ram()" with its original semantics of "allocate RAM MR but do not register for migration". In the end we decided on the approach of "memory_region_init_ram() registers the MR for migration, and memory_region_init_ram_nomigrate() is a new function which does not", but this comment change got left in by mistake. Revert that part of the commit. Reported-by: Thomas Huth <huth@tuxfamily.org> Signed-off-by: Peter Maydell <peter.maydell@linaro.org> --- Doesn't strictly need to go into 3.0, but it's a trivial doc comment fix... include/hw/boards.h | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-)