modpost: document the use of struct section_check.

struct section_check is used as a generic way of describing what
relocations are authorized/forbidden when running modpost.  This commit
tries to describe how each field is used.

Signed-off-by: Quentin Casasnovas <quentin.casasnovas@oracle.com>
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> (Fixed "mist"ake)
This commit is contained in:
Quentin Casasnovas 2015-04-13 20:55:15 +09:30 committed by Rusty Russell
parent 52dc0595d5
commit e5d8f59a5c

View File

@ -930,6 +930,26 @@ enum mismatch {
EXTABLE_TO_NON_TEXT,
};
/**
* Describe how to match sections on different criterias:
*
* @fromsec: Array of sections to be matched.
*
* @bad_tosec: Relocations applied to a section in @fromsec to a section in
* this array is forbidden (black-list). Can be empty.
*
* @good_tosec: Relocations applied to a section in @fromsec must be
* targetting sections in this array (white-list). Can be empty.
*
* @mismatch: Type of mismatch.
*
* @symbol_white_list: Do not match a relocation to a symbol in this list
* even if it is targetting a section in @bad_to_sec.
*
* @handler: Specific handler to call when a match is found. If NULL,
* default_mismatch_handler() will be called.
*
*/
struct sectioncheck {
const char *fromsec[20];
const char *bad_tosec[20];