[PATCH] security.h documentation

Previous message: Chris Vance: "Re: [RFC] [PATCH] placement of unix_may_send hook"
Next in thread: Greg KH: "Re: [PATCH] security.h documentation"
Reply: Greg KH: "Re: [PATCH] security.h documentation"
Reply: Seth Arnold: "Re: [PATCH] security.h documentation"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

cvanceat_private

I began to add documentation to some of the hooks in the security.h file.
Before getting too far, I wanted to solicit opinions from the list.  I
only added comments for the general IPC hooks and for Message Queues.

In general, I documented:
	short description
	arguments
	where it is called from (multiple identical lines indicate
				multiple calls from same function)
	what locks are held
	more complete description
	return values

I intentionally didn't reformat the hook prototypes themselves (to make
the patch smaller and simpler to understand), but we should likely run the
file through indent or something similar.

This will make the security.h file much bigger, but I think the clarity is
worth it.

If things look good, I'll continue by first documenting the hooks I've
added, followed by anything else that hasn't been done yet.

chris.