On Mon, Sep 10, 2001 at 12:31:01PM -0400, Chris Vance wrote: > > 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 Wo ho! This is great! The "where it is called from" section might be tough to guarentee that it will remain correct in the future as things change (you aren't going to think to change a header file if you just move the placement of a hook.) And isn't that what grep/ctags/cscope/cgvg good for? :) Other than that, the format looks great. > 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. I did run it through Lindent (see the scripts directory in the kernel) but it didn't really change anything. Since you are adding documentation to every hook, having the paramaters line up neatly doesn't matter anymore, so I don't mind that changing. > This will make the security.h file much bigger, but I think the clarity is > worth it. Very well worth it. Thanks again, much appreciated. > 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. Please do. I'll commit this patch right now. greg k-h _______________________________________________ linux-security-module mailing list linux-security-moduleat_private http://mail.wirex.com/mailman/listinfo/linux-security-module
This archive was generated by hypermail 2b30 : Mon Sep 10 2001 - 09:43:35 PDT