|
|
|
|
|
|
|
|
|
|
xen-api
[Xen-API] [PATCH 1 of 2] Minor corrections to deprecation policy documen
# HG changeset patch
# User Jonathan Davies <jonathan.davies@xxxxxxxxxx>
# Date 1271664009 -3600
# Node ID 6b5fa1fa0edd1201116abd130a3ba1a4ea6a4804
# Parent ad754527bddd1c97d28fbffb1c30f56e49178252
Minor corrections to deprecation policy document.
Signed-off-by: Jonathan Davies <jonathan.davies@xxxxxxxxxx>
diff -r ad754527bddd -r 6b5fa1fa0edd docs/evolution/main.tex
--- a/docs/evolution/main.tex Fri Apr 16 11:44:32 2010 +0100
+++ b/docs/evolution/main.tex Mon Apr 19 09:00:09 2010 +0100
@@ -33,7 +33,7 @@
\item to allow bugs to be fixed efficiently\footnote{Some would consider even
a bugfix to be a semantic change which breaks backwards compatability -- what
if someone is relying on the buggy behaviour?};
\item to allow new, innovative features to be added easily;
\item to keep old, unmodified clients working as much as possible; and
-\item where backwards-incompatable changes are to be made, publish this
information early to enable affected parties to give timely feedback.
+\item where backwards-incompatible changes are to be made, publish this
information early to enable affected parties to give timely feedback.
\end{itemize}
\section{Background}
@@ -46,9 +46,9 @@
\begin{verbatim}
deprecated_since <release>
\end{verbatim}
-where \texttt{release} identifies a major release of the software.
+where \texttt{<release>} identifies a major release of the software.
-\item Every release must be accomponied by a {\em deprecation statement} which
lists all fields and messages marked as deprecated in the release. Next to each
deprecated item should be an explanation of how to modify a client to avoid
using the deprecated field or message.
+\item Every release must be accompanied by a {\em deprecation statement} which
lists all fields and messages marked as deprecated in the release. Next to each
deprecated item should be an explanation of how to modify a client to avoid
using the deprecated field or message.
\item The deprecation statement shall be prominently displayed in the XenAPI
html documentation.
xen-api.hg-2.patch
Description: Text Data
_______________________________________________
xen-api mailing list
xen-api@xxxxxxxxxxxxxxxxxxx
http://lists.xensource.com/mailman/listinfo/xen-api
|
|
|
|
|