Good grief. Detailed function descriptions should accompany their definition.

diff --git a/sim/common/sim-core.c b/sim/common/sim-core.c
index e3e34360807274a65dcfb43553947485c8af2f9d..d1f9de143589f9e3f3d1c48ae41f7702c21aaaef 100644 (file)
--- a/sim/common/sim-core.c
+++ b/sim/common/sim-core.c
@@ -255,17 +255,7 @@ sim_core_map_attach (SIM_DESC sd,
 }
 
 /* Attach memory or a memory mapped device to the simulator.
-   LEVEL is ... ?
-   ACCESS is the kind of access to grant (some collection of r/w/x).
-   SPACE is ... ?
-   ADDR is the starting address of the section.
-   NR_BYTES is the size of the section.
-   MODULO is non-zero if this the section is to be split into several MODULO
-   sized identical chunks.
-   CLIENT is non-zero for devices, otherwise NULL.
-   OPTIONAL_BUFFER is the address of a pre-allocated buffer to use.
-   OPTIONAL_BUFFER is a sub-optimal hook that allows clients to do nasty
-   things that the interface doesn't accomodate.  */
+   See sim-core.h for a full description.  */
 
 EXTERN_SIM_CORE\
 (void)

diff --git a/sim/common/sim-core.h b/sim/common/sim-core.h
index 5bd098469eb71502d9bb5dc950cbb5842c02b490..3dee6859b87af4462004f9e0e2db260fe25ece7b 100644 (file)
--- a/sim/common/sim-core.h
+++ b/sim/common/sim-core.h
@@ -122,7 +122,9 @@ EXTERN_SIM_CORE\
    data read & written to the region.  Normally a more efficient
    internal structure is used.  It is assumed that buffer is allocated
    such that the byte alignmed of OPTIONAL_BUFFER matches ADDR vis
-   (OPTIONAL_BUFFER % 8) == (ADDR % 8)) */
+   (OPTIONAL_BUFFER % 8) == (ADDR % 8)).  It is defined to be a sub-optimal
+   hook that allows clients to do nasty things that the interface doesn't
+   accomodate.  ??? That seems unnecessarily restrictive.  */
 
 EXTERN_SIM_CORE\
 (void) sim_core_attach