os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add guidelines for deprecating features.

Browse source 
Partially submitted by:	sheldonh
Approved by:		-developers
This commit is contained in:
Mike Barcroft 2001-10-23 17:11:14 +00:00
parent d8e47ccdae
commit 84255d06ed
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=11012
1 changed files with 32 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

35
en_US.ISO8859-1/articles/committers-guide/article.sgml
View file

@ -522,11 +522,11 @@
</itemizedlist> </itemizedlist>
<para>You will almost certainly get a conflict because <para>You will almost certainly get a conflict because
of the <literal>$Id: article.sgml,v 1.85 2001-10-16 11:52:49 keramida Exp $</literal> (or in FreeBSD's case, of the <literal>$Id: article.sgml,v 1.86 2001-10-23 17:11:14 mike Exp $</literal> (or in FreeBSD's case,
<literal>$FreeBSD<!-- stop expansion -->$</literal>) lines, so you will have to edit <literal>$FreeBSD<!-- stop expansion -->$</literal>) lines, so you will have to edit
the file to resolve the conflict (remove the marker lines and the file to resolve the conflict (remove the marker lines and
the second <literal>$Id: article.sgml,v 1.85 2001-10-16 11:52:49 keramida Exp $</literal> line, leaving the original the second <literal>$Id: article.sgml,v 1.86 2001-10-23 17:11:14 mike Exp $</literal> line, leaving the original
<literal>$Id: article.sgml,v 1.85 2001-10-16 11:52:49 keramida Exp $</literal> line intact).</para> <literal>$Id: article.sgml,v 1.86 2001-10-23 17:11:14 mike Exp $</literal> line intact).</para>
</listitem> </listitem>
<listitem> <listitem>
@ -1761,6 +1761,35 @@ docs:Documentation Bug:nik:</programlisting>
any style or whitespace changes in separate commits that are any style or whitespace changes in separate commits that are
clearly labeled as such in the commit message.</para> clearly labeled as such in the commit message.</para>
</sect2> </sect2>
<sect2>
<title>Deprecating Features</title>
<para>When it is necessary to remove functionality from software
in the base system the following guidelines should be followed
whenever possible:</para>
<orderedlist>
<listitem>
<para>Mention is made in the manual page and possibly the
release notes that the option, utility, or interface is
deprecated. Use of the deprecated feature generates a
warning.</para>
</listitem>
<listitem>
<para>The option, utility, or interface is preserved until
the next major (point zero) release.</para>
</listitem>
<listitem>
<para>The option, utility, or interface is removed and no
longer documented. It is now obsolete. It is also
generally a good idea to note its removal in the release
notes.</para>
</listitem>
</orderedlist>
</sect2>
</sect1> </sect1>
<sect1> <sect1>