include/hw/boards.h: Document memory_region_allocate_system_memory()
commit09ad643823dcda0a86eddce1291c28d0ccb09a3b
authorPeter Maydell <peter.maydell@linaro.org>
Fri, 7 Jul 2017 14:42:47 +0000 (7 15:42 +0100)
committerPeter Maydell <peter.maydell@linaro.org>
Fri, 14 Jul 2017 16:47:52 +0000 (14 17:47 +0100)
tree300059e57fe77ca990188e5d7da0b42897c789be
parent4871b51b9241b10f4fd8e04bbb21577886795e25
include/hw/boards.h: Document memory_region_allocate_system_memory()

Add a documentation comment for memory_region_allocate_system_memory().

In particular, the reason for this function's existence and the
requirement on board code to call it exactly once are non-obvious.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Message-id: 1499438577-7674-2-git-send-email-peter.maydell@linaro.org
include/hw/boards.h