|
From: <sv...@va...> - 2005-04-24 14:34:47
|
Author: sewardj Date: 2005-04-24 15:34:42 +0100 (Sun, 24 Apr 2005) New Revision: 3558 Modified: trunk/coregrind/README_MODULES.txt Log: Relax the requirement that a pub_tool_<modulename>.h file must exist even if it defines nothing. That's a bit silly. Modified: trunk/coregrind/README_MODULES.txt =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/coregrind/README_MODULES.txt 2005-04-24 14:31:29 UTC (rev 3557) +++ trunk/coregrind/README_MODULES.txt 2005-04-24 14:34:42 UTC (rev 3558) @@ -34,16 +34,15 @@ coregrind/pub_core_foo.h =20 pub_tool_foo.h describes that part of the module's functionality that -is visible to tools. Hopefully this can be minimal or zero. The file -must still exist even if it defines nothing. +is visible to tools. Hopefully this can be minimal or zero. If there +is nothing to visible to tool, pub_tool_foo.h can be omitted. =20 pub_core_foo.h describes functionality that is visible to other modules in the core. This is a strict superset of the visible-to-tool -functionality. +functionality. Consequently, pub_core_foo.h *must* #include +pub_tool_foo.h, if it exists. pub_tool_foo.h *must not* #include +pub_core_foo.h, nor any other pub_core_ header for that matter. =20 -Consequently, pub_core_foo.h may #include pub_tool_foo.h, but not the -other way round. - No module may include the private headers of any other module. If a type/enum/function/struct/whatever is stated in neither include/pub_tool_foo.h nor coregrind/pub_core_foo.h then module 'foo' |