From: Guillem Jover <guillem@debian.org>
Date: Mon, 21 Jan 2008 08:00:19 +0000 (+0200)
Subject: Add README.feature-removal-schedule and README.api
X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=703aa4ce9eb0c374aa526c2118667358726c5f03;p=dpkg

Add README.feature-removal-schedule and README.api
---

diff --git a/ChangeLog b/ChangeLog
index 7c509be8..e27ce920 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2008-01-21  Guillem Jover  <guillem@debian.org>
+
+	* README.api: New file.
+	* README.feature-removal-schedule: Likewise.
+	* Makefile.am (EXTRA_DIST): Add README.feature-removal-schedule and
+	README.api.
+
 2008-01-21  Guillem Jover  <guillem@debian.org>
 
 	* configure.ac (AC_CHECK_FUNCS): Escape new lines.
diff --git a/Makefile.am b/Makefile.am
index 38bb1e62..28cd3b06 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -23,6 +23,8 @@ ACLOCAL_AMFLAGS = -I m4
 dist_pkgdata_DATA = cputable ostable triplettable
 
 EXTRA_DIST = \
+	README.api \
+	README.feature-removal-schedule \
 	README.translators \
 	debian/archtable \
 	debian/changelog \
diff --git a/README.api b/README.api
new file mode 100644
index 00000000..9eb10dd6
--- /dev/null
+++ b/README.api
@@ -0,0 +1,10 @@
+This is an (incomplete) list of currently provided APIs by dpkg, and
+their supported status.
+
+
+What: Dpkg (perl modules)
+Status: testing
+Description:
+ The API provided by these modules is not yet stable, it's only supposed to
+ be used internally by dpkg for now.
+
diff --git a/README.feature-removal-schedule b/README.feature-removal-schedule
new file mode 100644
index 00000000..c71e1c16
--- /dev/null
+++ b/README.feature-removal-schedule
@@ -0,0 +1,65 @@
+This is a list of features that are scheduled to be removed from dpkg.
+
+
+What: 822-date (program)
+Status: obsolete
+When: lenny+1
+Warning: program
+Why:
+ Should switch to use 'date -R'.
+
+What: cleanup-info (program)
+Status: deprecated
+When: lenny
+Warning: none
+Why:
+ This program was needed long time ago to fixup broken info dir files
+ generated by buggy install-info programs. Should not be needed anymore.
+
+What: Source-Version (substvar)
+Status: obsolete
+When: lenny+1
+Warning: lintian (substvar-source-version-is-deprecated)
+Why:
+ The semantics of Source-Version are missleading when applied to binNMUs.
+ Should switch to use binary:Version or source:Version substvars.
+
+What: Revision, Package-Revision, Package_Revision, Class, Recommended,
+      Optional (field)
+Status: obsolete
+When: lenny+1
+Warning: program
+Why:
+ These fields have been superseded by either other fields with better names
+ or values in other fields.
+
+What: recommended, contrib, base (priority)
+Status: obsolete
+When: lenny+1
+Warning: none
+Why:
+ These priorities have been superseded by either other fields or values in
+ other fields.
+
+What: --force-auto-install (dpkg option)
+Status: obsolete
+When: lenny+1
+Warning: program
+
+What: --largemem, --smallmem (dpkg option)
+Status: obsolete
+When: lenny+1
+Warning: program
+
+What: --no-auto-select (dpkg option)
+Status: deprecated
+When: lenny+1
+Warning: none
+
+What: -u, --udeb (dpkg-scanpackages option)
+Status: deprecated
+When: lenny+1
+Warning: none
+Why:
+ This option has been superseded by -tudeb.
+
diff --git a/debian/changelog b/debian/changelog
index 424dec10..4318a545 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -26,6 +26,8 @@ dpkg (1.14.16) UNRELEASED; urgency=low
     quotes in m4 files. Closes: #24514
   * Switch Maintainer address to <debian-dpkg@lists.debian.org> from
     <team@dpkg.org>.
+  * Add README.feature-removal-schedule describing the features to be removed
+    and README.api describing the provided APIs.
 
   [ Frank Lichtenheld ]
   * Make the -L option of dpkg-parsechangelog actually work (it's
diff --git a/debian/dpkg.docs b/debian/dpkg.docs
index caa7b8bc..aefc3483 100644
--- a/debian/dpkg.docs
+++ b/debian/dpkg.docs
@@ -1,3 +1,5 @@
 AUTHORS
 THANKS
 debian/usertags
+README.api
+README.feature-removal-schedule