You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by bw...@apache.org on 2003/02/09 12:59:09 UTC

cvs commit: jakarta-turbine-maven/xdocs/reference project-descriptor.xml

bwalding    2003/02/09 03:59:09

  Modified:    xdocs/reference project-descriptor.xml
  Log:
  Update doc for new license section
  
  Revision  Changes    Path
  1.8       +39 -0     jakarta-turbine-maven/xdocs/reference/project-descriptor.xml
  
  Index: project-descriptor.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-maven/xdocs/reference/project-descriptor.xml,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- project-descriptor.xml	31 Jan 2003 21:50:17 -0000	1.7
  +++ project-descriptor.xml	9 Feb 2003 11:59:09 -0000	1.8
  @@ -213,6 +213,15 @@
             </td>
           </tr>
           <tr>
  +          <td><a href="#licenses">licenses</a></td>
  +          <td>
  +            Describes the licenses for this project.  This is used to generate
  +            the <a href="build-file.html#maven:docs">License</a> page of
  +            the project's web site. Typically the licenses listed for the project
  +            are that of the project itself, and not of dependencies.
  +          </td>
  +        </tr>
  +        <tr>
             <td><a href="#dependencies">dependencies</a></td>
             <td>
               Describes the dependencies to a project.  This is used to
  @@ -456,6 +465,36 @@
                 The roles the contributor plays in the project.  Each role is
                 describe by a <code>role</code> element, the body of which is a
                 role name.
  +            </td>
  +          </tr>
  +        </table>
  +      </subsection>
  +
  +    </section>
  +    <section name="licenses">
  +      <p>
  +        This element describes all of the licenses for this project.  Each license is described by a
  +        <code>license</code> element, which is then describe by additional
  +        elements (described below).  The auto-generated site documentation
  +        references this information.  Projects should only list the license(s) that
  +        applies to the project and not the licenses that apply to dependencies.
  +      </p>
  +      <subsection name="license">
  +        <table>
  +          <tr><th>Element</th><th>Description</th></tr>
  +          <tr>
  +            <td>name</td>
  +            <td>The full legal name of the license.</td>
  +          </tr>
  +          <tr>
  +            <td>url</td>
  +            <td>The official url for the license text.</td>
  +          </tr>
  +          <tr>
  +            <td>distribution</td>
  +            <td>The primary method by which this project may be distributed. 
  +            	repo: may be downloaded from the Maven repository. manual: user
  +            	must manually download and install the dependency.
               </td>
             </tr>
           </table>