apr-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From r..@apache.org
Subject cvs commit: apr-site versioning.html
Date Fri, 10 May 2002 22:26:02 GMT
rbb         02/05/10 15:26:02

  Modified:    .        versioning.html
  Log:
  Expand on the idea of deprecating functions a bit.
  
  Revision  Changes    Path
  1.4       +20 -7     apr-site/versioning.html
  
  Index: versioning.html
  ===================================================================
  RCS file: /home/cvs/apr-site/versioning.html,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- versioning.html	10 May 2002 20:00:36 -0000	1.3
  +++ versioning.html	10 May 2002 22:26:02 -0000	1.4
  @@ -247,12 +247,25 @@
         
         <dt>Deprecating functions</dt>
         <dd>
  -	Since a function must remain available for applications coded
  -	against a previous minor release, it is only possible to
  -	"<em>deprecate</em>" a function. It <strong>cannot</strong> be
  -	removed from the headers (so that source compatibility is
  -	retained) and it cannot be removed from the library (so that
  -	binary compatibility is retained).
  +        <p>
  +	  Since a function must remain available for applications coded
  +	  against a previous minor release, it is only possible to
  +	  "<em>deprecate</em>" a function. It <strong>cannot</strong>
be
  +	  removed from the headers (so that source compatibility is
  +	  retained) and it cannot be removed from the library (so that
  +	  binary compatibility is retained).
  +	</p>
  +	<p>
  +	  If you deprecate a function in APR, please mark it as such in
  +	  the function documentation, using the doxygen "\deprecated" tag.
  +	  Deprecated functions can only be removed in major releases.
  +	</p>
  +	<p>
  +	  Finally, if you are deprecating a function so that you can change
  +	  the name of the function, please use the method described above
  +	  under "Replacing functions", so that projects which use APR can
  +	  retain binary compatibility.
  +	</p>
         </dd>
         
       </dl>
  @@ -286,6 +299,6 @@
       </p>
   
       <hr />
  -Last modified: $Date: 2002/05/10 20:00:36 $
  +Last modified: $Date: 2002/05/10 22:26:02 $
     </body>
   </html>
  
  
  

Mime
View raw message