incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject svn commit: r438542 - in /incubator/public/trunk: site-author/guides/releasemanagement.xml site-publish/guides/releasemanagement.html
Date Wed, 30 Aug 2006 16:55:13 GMT
Author: rdonkin
Date: Wed Aug 30 09:55:13 2006
New Revision: 438542

URL: http://svn.apache.org/viewvc?rev=438542&view=rev
Log:
Content on compression formats.

Modified:
    incubator/public/trunk/site-author/guides/releasemanagement.xml
    incubator/public/trunk/site-publish/guides/releasemanagement.html

Modified: incubator/public/trunk/site-author/guides/releasemanagement.xml
URL: http://svn.apache.org/viewvc/incubator/public/trunk/site-author/guides/releasemanagement.xml?rev=438542&r1=438541&r2=438542&view=diff
==============================================================================
--- incubator/public/trunk/site-author/guides/releasemanagement.xml (original)
+++ incubator/public/trunk/site-author/guides/releasemanagement.xml Wed Aug 30 09:55:13 2006
@@ -154,10 +154,6 @@
             <p>
             TODO: incubator rules
             </p>
-            <p>
-            TODO: should include apache in the title (gives trademark protection against
different jars 
-            with the same name)
-            </p>
         </section>
     </section>
     <section id='best-practice'><title>Best Practice</title>
@@ -176,16 +172,28 @@
                 </li>
             </ul>
         </section>
+        <section id='best-practice-naming'><title>Artifact Naming</title>
+        	<p>
+            TODO: should include apache in the title (gives trademark protection against
different jars 
+            with the same name)
+        	</p>
+        </section>
         <section id='best-practice-types'><title>Distribution Types</title>
         	<p>
  TODO: glossay - distribution type: based on the same tagged source built  
  TODO: Common Types of distribtuion
+ 			</p>
+ 			<p>
  TODO: the source distribution is canonical. every project should create a source distribution.
  compiled languages may also wish to create binary releases. these may be platform specific.
  some project may also convenience types which package the project for particular containers.
         	</p>
+        	<p>
+ All types of distribution ship as <a href='best-practice-formats'>compressed artifacts</a>.
+ This means a distribution type may be shipped as multiple compressed artifacts.
+        	</p>
         </section>
-           <section id='best-practice-downstream'><title>Downstream Packagers</title>
+        <section id='best-practice-downstream'><title>Downstream Packagers</title>
         	<p>
  TODO: glossay - downstream packager: takes an apache release and packages it for a particular
platform.
  TODO: best practice is to work with downstream packagers and link to their packages
@@ -199,9 +207,26 @@
         	add content to release documents; export not checkout
         	</p>
         </section>
-        <section id='best-practice-formats'><title>Formats</title>
+        <section id='best-practice-formats'><title>Compression Formats</title>
             <p>
-TODO source verses binary, *nix (tgz and b) and windows (zip). 
+<a href='best-practice-distributions'>Distributions</a> of all 
+<a href='best-practice-types'>types</a> should be shipped in a compress format
+to minimize bandwidth requirements. 
+			</p><p>
+Though utilities for all major compression formats are available for all major platforms,
+not all platforms support all major compression formats by default. 
+It is therefore convenient for users to ship each type of distribution in more than one
+compressed format. Ship one of tar.gz, bz or bz2 for UNIX and linux (but note 
+<a href='notes-on-compression-formats'>this</a>). 
+Ship zip for windows.
+			</p><p>
+Some formats are strongly associated with particular platforms. 
+Even when the uncompressed contents have no functional differences,
+this leads to conventional associations between particular compressed artifacts and
+platforms.
+For example, <code>zip</code> with <code>windows</code> and <code>tar.gz</code>
+with <code>UNIX</code> and <code>linux</code>.
+Users often expect this association.
 See <a href='notes-line-endings'>notes</a> on line endings for source distributions.
             </p>
             <p>
@@ -292,6 +317,10 @@
             TODO: Ship with source and binary
             </p>
         </section>
+        <section id='notes-on-compression-formats'><title></title>
+        TODO: discuss merits tgz, bz, bz2
+        TODO: problems with incompatibilities with older version of some utilities
+        </section>
         <section id='notes-on-line-endings'><title>On Line Endings</title>
             <p>
             TODO: windows vs *nix line endings. use svn to export. example.
@@ -408,6 +437,11 @@
             </p>
         </section>
         <section id='glossary-distribution'><title>Distribution</title>
+            <p>
+            TODO (include link to infra documentation)
+            </p>
+        </section>
+        <section id='glossary-distribution-type'><title>Distribution Type</title>
             <p>
             TODO (include link to infra documentation)
             </p>

Modified: incubator/public/trunk/site-publish/guides/releasemanagement.html
URL: http://svn.apache.org/viewvc/incubator/public/trunk/site-publish/guides/releasemanagement.html?rev=438542&r1=438541&r2=438542&view=diff
==============================================================================
--- incubator/public/trunk/site-publish/guides/releasemanagement.html (original)
+++ incubator/public/trunk/site-publish/guides/releasemanagement.html Wed Aug 30 09:55:13
2006
@@ -241,10 +241,6 @@
 <p>
             TODO: incubator rules
             </p>
-<p>
-            TODO: should include apache in the title (gives trademark protection against
different jars 
-            with the same name)
-            </p>
 </div>
 </div>
            <h2><img src="/images/redarrow.gif" />
@@ -270,16 +266,31 @@
             </ul>
 </div>
 <h3>
+   <a name="best-practice-naming">Artifact Naming</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO: should include apache in the title (gives trademark protection against
different jars 
+            with the same name)
+        	</p>
+</div>
+<h3>
    <a name="best-practice-types">Distribution Types</a>
 </h3>
 <div class="section-content">
 <p>
  TODO: glossay - distribution type: based on the same tagged source built  
  TODO: Common Types of distribtuion
+ 			</p>
+<p>
  TODO: the source distribution is canonical. every project should create a source distribution.
  compiled languages may also wish to create binary releases. these may be platform specific.
  some project may also convenience types which package the project for particular containers.
         	</p>
+<p>
+ All types of distribution ship as <a href="best-practice-formats">compressed artifacts</a>.
+ This means a distribution type may be shipped as multiple compressed artifacts.
+        	</p>
 </div>
 <h3>
    <a name="best-practice-downstream">Downstream Packagers</a>
@@ -302,11 +313,30 @@
         	</p>
 </div>
 <h3>
-   <a name="best-practice-formats">Formats</a>
+   <a name="best-practice-formats">Compression Formats</a>
 </h3>
 <div class="section-content">
 <p>
-TODO source verses binary, *nix (tgz and b) and windows (zip). 
+<a href="best-practice-distributions">Distributions</a> of all 
+<a href="best-practice-types">types</a> should be shipped in a compress format
+to minimize bandwidth requirements. 
+			</p>
+<p>
+Though utilities for all major compression formats are available for all major platforms,
+not all platforms support all major compression formats by default. 
+It is therefore convenient for users to ship each type of distribution in more than one
+compressed format. Ship one of tar.gz, bz or bz2 for UNIX and linux (but note 
+<a href="notes-on-compression-formats">this</a>). 
+Ship zip for windows.
+			</p>
+<p>
+Some formats are strongly associated with particular platforms. 
+Even when the uncompressed contents have no functional differences,
+this leads to conventional associations between particular compressed artifacts and
+platforms.
+For example, <code>zip</code> with <code>windows</code> and <code>tar.gz</code>
+with <code>UNIX</code> and <code>linux</code>.
+Users often expect this association.
 See <a href="notes-line-endings">notes</a> on line endings for source distributions.
             </p>
 <p>
@@ -422,6 +452,11 @@
             </p>
 </div>
 <h3>
+   <a name="notes-on-compression-formats"></a>
+</h3>
+<div class="section-content">
+</div>
+<h3>
    <a name="notes-on-line-endings">On Line Endings</a>
 </h3>
 <div class="section-content">
@@ -571,6 +606,14 @@
 </div>
 <h3>
    <a name="glossary-distribution">Distribution</a>
+</h3>
+<div class="section-content">
+<p>
+            TODO (include link to infra documentation)
+            </p>
+</div>
+<h3>
+   <a name="glossary-distribution-type">Distribution Type</a>
 </h3>
 <div class="section-content">
 <p>



---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@incubator.apache.org
For additional commands, e-mail: cvs-help@incubator.apache.org


Mime
View raw message