[augeas-devel] [Augeas] #99: Add support for module metadata

Augeas trac at fedorahosted.org
Tue Jan 5 23:41:12 UTC 2010


#99: Add support for module metadata
--------------------------+-------------------------------------------------
  Reporter:  lkrejci      |       Owner:  lutter  
      Type:  enhancement  |      Status:  assigned
  Priority:  minor        |   Milestone:  wishlist
 Component:  Augeas       |     Version:          
Resolution:               |    Keywords:          
--------------------------+-------------------------------------------------
Changes (by lutter):

  * status:  new => assigned

Comment:

 I like the idea of attaching metadata to modules (and possibly other
 things in the future), though I don't like them as normal expressions
 inside the module. Other possibilities would be to embed that in specially
 formatted comments, e.g., metadata comments must start with (*@, so that
 you'd write
 {{{
   (*@metadata
     version = "1.0.0"
     author = "John Doe"
     description = "..."
   *)
   module Foo =
     let x = ...
 }}}
 or using a Java annotation-like syntax:
 {{{
   @metadata(
     version = "1.0.0",
     author = "John Doe",
     description = "..."
   )
   module Foo =
     let x = ...
 }}}

 I am not completely sold on either, but I can see how some sort of
 metadata facility could be useful.

 Also, it wouldn't be right to put that metadata under /augeas/load, since
 that deals in lenses, not modules; but figuring that out should be the
 easy part of this problem.

-- 
Ticket URL: <https://fedorahosted.org/augeas/ticket/99#comment:1>
Augeas <http://augeas.net/>
a configuration API




More information about the augeas-devel mailing list