Re: documentation (was Re: 2001_09_04 patch against 2.4.9)

From: Greg KH (gregat_private)
Date: Wed Sep 05 2001 - 08:56:25 PDT

  • Next message: Casey Schaufler: "Re: quotactl hook"

    On Wed, Sep 05, 2001 at 11:44:42AM -0400, Stephen Smalley wrote:
    > 
    > On Tue, 4 Sep 2001, Greg KH wrote:
    > 
    > > The hooks in security.h _really_ need some documentation.  Patches for
    > > this would be greatly appreciated.
    > 
    > Another question on this topic:  if we do want to put documentation
    > into security.h for each hook, what is the desired format?  The
    > DocBook format?
    
    Big problem is that the current kernel documentation tools can't handle
    header files and structures.  If anyone wants to work on changing that,
    lots of people would be very grateful.
    
    So because there isn't any set standard right now, something that looks
    like the current kernel doc format would be nice to put into the
    security.h file.
    
    And putting the info directly into the .h file makes it easier to
    maintain over time.  I know from personal experience remembering to
    update a separate file is easily forgotten.
    
    thanks,
    
    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 : Wed Sep 05 2001 - 08:57:35 PDT