export.h: clarify comment in relation to avoiding includes
PATCH 1/1 export.h: clarify comment in relation to avoiding includes
The existing comment indicated what was desired, but it didn't necessarily convey the reasoning behind it in an effective way.
Cc Rusty Russell <[email protected]>
Signed-off-by Paul Gortmaker <[email protected]>
--- include/linux/export.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
include/linux/export.h +3 -2
@@ -5,8 +5,9 @@* to reduce the amount of pointless cruft we feed to gcc when only * exporting a simple symbol or two. * -* If you feel the need to add #include <linux/foo.h> to this file -* then you are doing something wrong and should go away silently. +* More specifically, it was all the #include <linux/foo.h> lines in +* module.h that we wanted to avoid, so please avoid adding any such +* similar include lines here, if at all possible. */ /* Some toolchains use a `_' prefix for all user symbols. */
Signature · 1 line
1.8.1.2
Quoted 27 lines · Paul Gortmaker
The existing comment indicated what was desired, but it didn't necessarily convey the reasoning behind it in an effective way.
Cc Rusty Russell <[email protected]>Signed-off-by Paul Gortmaker <[email protected]>--- include/linux/export.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)include/linux/export.h +3
-2@@ -5,8 +5,9 @@* to reduce the amount of pointless cruft we feed to gcc when only * exporting a simple symbol or two. * -* If you feel the need to add #include <linux/foo.h> to this file -* then you are doing something wrong and should go away silently. +* More specifically, it was all the #include <linux/foo.h> lines in +* module.h that we wanted to avoid, so please avoid adding any such +* similar include lines here, if at all possible. */ /* Some toolchains use a `_' prefix for all user symbols. */ Signature · 1 line
1.8.1.2
I prefer that :)
Thanks,
Rusty.