Patchwork exec.c: Remove out of date comment

login
register
mail settings
Submitter Peter Maydell
Date Aug. 1, 2012, 1:35 p.m.
Message ID <1343828147-9446-1-git-send-email-peter.maydell@linaro.org>
Download mbox | patch
Permalink /patch/174455/
State New
Headers show

Comments

Peter Maydell - Aug. 1, 2012, 1:35 p.m.
Remove an out of date comment: this comment used to be attached to
cpu_register_physical_memory_log(), before commit 0f0cb164 accidentally
inserted a couple of other functions between the comment and its function.
It is in any case obsolete since (a) the function arguments it refers
to have been replaced with a single MemoryRegionSection* argument and
(b) the inability to handle regions whose offset_within_address_space
and offset_within_region aren't equally aligned was fixed as part of
the rewrite of this code.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
Pretty sure my analysis is right and this comment is out of date --
Avi, could you confirm that please?

 exec.c |    8 --------
 1 file changed, 8 deletions(-)
Avi Kivity - Aug. 1, 2012, 2:05 p.m.
On 08/01/2012 04:35 PM, Peter Maydell wrote:
> Remove an out of date comment: this comment used to be attached to
> cpu_register_physical_memory_log(), before commit 0f0cb164 accidentally
> inserted a couple of other functions between the comment and its function.
> It is in any case obsolete since (a) the function arguments it refers
> to have been replaced with a single MemoryRegionSection* argument and
> (b) the inability to handle regions whose offset_within_address_space
> and offset_within_region aren't equally aligned was fixed as part of
> the rewrite of this code.

(c) it doesn't use the conventional block comment style.

> 
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> Pretty sure my analysis is right and this comment is out of date --
> Avi, could you confirm that please?

Yes, you are correct.
Peter Maydell - Aug. 1, 2012, 2:17 p.m.
On 1 August 2012 15:05, Avi Kivity <avi@redhat.com> wrote:
> On 08/01/2012 04:35 PM, Peter Maydell wrote:
>> Remove an out of date comment: this comment used to be attached to
>> cpu_register_physical_memory_log(), before commit 0f0cb164 accidentally
>> inserted a couple of other functions between the comment and its function.
>> It is in any case obsolete since (a) the function arguments it refers
>> to have been replaced with a single MemoryRegionSection* argument and
>> (b) the inability to handle regions whose offset_within_address_space
>> and offset_within_region aren't equally aligned was fixed as part of
>> the rewrite of this code.
>
> (c) it doesn't use the conventional block comment style.

I agree that I don't like the aesthetics of this style of comment
but we don't actually mandate a One True Comment Format in HACKING
so I usually try to suppress my preferences in code review :-)

-- PMM
Avi Kivity - Aug. 1, 2012, 2:20 p.m.
On 08/01/2012 05:17 PM, Peter Maydell wrote:
> On 1 August 2012 15:05, Avi Kivity <avi@redhat.com> wrote:
>> On 08/01/2012 04:35 PM, Peter Maydell wrote:
>>> Remove an out of date comment: this comment used to be attached to
>>> cpu_register_physical_memory_log(), before commit 0f0cb164 accidentally
>>> inserted a couple of other functions between the comment and its function.
>>> It is in any case obsolete since (a) the function arguments it refers
>>> to have been replaced with a single MemoryRegionSection* argument and
>>> (b) the inability to handle regions whose offset_within_address_space
>>> and offset_within_region aren't equally aligned was fixed as part of
>>> the rewrite of this code.
>>
>> (c) it doesn't use the conventional block comment style.
> 
> I agree that I don't like the aesthetics of this style of comment
> but we don't actually mandate a One True Comment Format in HACKING
> so I usually try to suppress my preferences in code review :-)

Indeed comment style is quite low on the patch rejection scale, which is
why I didn't ask for a preliminary patch that fixes the comment style
before deleting it in the second one (giving us the option to backport
the first patch to qemu 1.1.stable if we get user complaints).
Stefan Hajnoczi - Aug. 3, 2012, 9:56 a.m.
On Wed, Aug 01, 2012 at 02:35:47PM +0100, Peter Maydell wrote:
> Remove an out of date comment: this comment used to be attached to
> cpu_register_physical_memory_log(), before commit 0f0cb164 accidentally
> inserted a couple of other functions between the comment and its function.
> It is in any case obsolete since (a) the function arguments it refers
> to have been replaced with a single MemoryRegionSection* argument and
> (b) the inability to handle regions whose offset_within_address_space
> and offset_within_region aren't equally aligned was fixed as part of
> the rewrite of this code.
> 
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> Pretty sure my analysis is right and this comment is out of date --
> Avi, could you confirm that please?
> 
>  exec.c |    8 --------
>  1 file changed, 8 deletions(-)

Thanks, applied to the trivial patches tree:
https://github.com/stefanha/qemu/commits/trivial-patches

Stefan

Patch

diff --git a/exec.c b/exec.c
index feb4795..22dff17 100644
--- a/exec.c
+++ b/exec.c
@@ -2240,14 +2240,6 @@  static void phys_sections_clear(void)
     phys_sections_nb = 0;
 }
 
-/* register physical memory.
-   For RAM, 'size' must be a multiple of the target page size.
-   If (phys_offset & ~TARGET_PAGE_MASK) != 0, then it is an
-   io memory page.  The address used when calling the IO function is
-   the offset from the start of the region, plus region_offset.  Both
-   start_addr and region_offset are rounded down to a page boundary
-   before calculating this offset.  This should not be a problem unless
-   the low bits of start_addr and region_offset differ.  */
 static void register_subpage(MemoryRegionSection *section)
 {
     subpage_t *subpage;