Changes between Version 9 and Version 10 of ModuleEcosystem

Timestamp:

09/28/09 06:11:59 (12 years ago)

Author:

japhb

Comment:

WIP: Updating metadata instructions section to new design, part 3

ModuleEcosystem

@@ -182 +182 @@
    * abstract
    * instructions
+     * ''General rules:''
+       * ''only ''fetch'' and ''install'' stages are mandatory always; all others must exist iff the project requires it''
+       * type'' field is always mandatory if the stage exists at all''
+       * command'' field is always available for non-standard techniques, but only allowed if ''type'' is ''custom
+       * ''most other fields are optional''
      * fetch ''(mandatory)''
-       * type     ''(mandatory, short name of a VCS or protocol, such as ''svn'', ''git'', or ''http''; or ''custom'')''
-       * revision ''(optional, defaults to ''HEAD'' equivalent)''
-       * branch   ''(optional, defaults to ''trunk''/''master'' equivalent)''
-       * command  ''(only if ''type'' is ''custom'')''
+       * type     ''(short name of a VCS or protocol, such as ''svn'', ''git'', or ''http''; or ''custom'')''
+       * revision ''(defaults to ''HEAD'' equivalent)''
+       * branch   ''(defaults to ''trunk''/''master'' equivalent)''
        * include_externals ''(fetch externals/submodules; defaults to ''false'')''
-     * unpack ''(optional)''
-       * type ''(mandatory, archive type, such as ''tar'', ''zip'', etc.)''
-       * compression ''(''gzip'', ''bzip2'', etc.  optional, defaults to autodetection)''
-     * patch ''(optional)''
+       * command
+     * unpack
+       * type        ''(archive type, such as ''tar'', ''zip'', etc.)''
+       * compression ''(''gzip'', ''bzip2'', ...; defaults to autodetection)''
+       * command
+     * patch
        * ''list of:''
          * type     ''(''unified'', ''git'', etc.)''
          * uri      ''(location of patch file)''
-         * command  ''(only if ''type'' is ''custom'')''
          * reversed ''(defaults to ''false'')''
-     * configure ''(optional)''
+         * command
+     * configure
        * type       ''(''sh'', ''perl5-mm'', ''perl5-build'', ''perl5-configure'', ''nqp'', ''custom'', ...)'' 
-       * command    ''(only if ''type'' is ''custom'')''
        * extra_args ''(extra arguments for configure script)''
-     * build ''(optional)''
+       * command
+     * build
        * type       ''(''make'', ''perl5-build'', ''custom'', ...)'' 
-       * command    ''(only if ''type'' is ''custom'')''
        * extra_args ''(extra arguments for build tool)''
-     * test ''(optional)''
+       * command
+     * test
        * type       ''(''make'', ''perl5-build'', ''custom'', ...)'' 
-       * command    ''(only if ''type'' is ''custom'')''
        * extra_args ''(extra arguments for test harness)''
+       * command
      * install ''(mandatory)''
        * type       ''(''make'', ''perl5-build'', ''custom'', ...)'' 
-       * command    ''(only if ''type'' is ''custom'')''
        * extra_args ''(extra arguments for installer)''
+       * command
      * runtime ''(here for completeness; necessary?)''
  * Manifest fields ''(still under discussion; for scriptless installs)'':