Move development documentation to doc/

2 files changed, 123 insertions, 0 deletions

diff --git a/doc/README.api b/doc/README.api
new file mode 100644
index 000000000..d918df116
--- /dev/null
+++ b/doc/README.api
@@ -0,0 +1,22 @@
+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.
+
+What: custom changelog parsers in /usr/lib/dpkg/parsechangelog
+Status: stable
+Version: 2.0
+Description:
+ Since dpkg 1.14.16, the set of command-line options that custome
+ changelog parsers must support has been expanded (see
+ dpkg-parsechangelog(1)). For compatibility, changelog parsers supporting
+ only the old options are supported in lenny. In lenny+1, that support
+ will be dropped.
+ .
+ For reference, only the -v option was supported in version 1.0 of this
+ API.
diff --git a/doc/README.feature-removal-schedule b/doc/README.feature-removal-schedule
new file mode 100644
index 000000000..225ec2fd6
--- /dev/null
+++ b/doc/README.feature-removal-schedule
@@ -0,0 +1,101 @@
+This is a list of features that are scheduled to be removed from dpkg.
+
+
+What: Source-Version (substvar)
+Status: obsolete
+When: 1.16.x
+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: 1.15.x
+Warning: program
+Why:
+ These fields have been superseded by either other fields with better names
+ or values in other fields.
+
+What: -u, --udeb (dpkg-scanpackages option)
+Status: deprecated
+When: 1.16.x
+Warning: program
+Why:
+ This option has been superseded by -tudeb.
+
+What: support of custom changelog parsers understanding only -v
+Status: obsolete
+When: 1.15.x
+Warning: none
+Why:
+ The debian changelog parser has been enhanced. It supports new options
+ that enable more fine-grained retrieval of information. Those new options
+ will be used by scripts (like dpkg-genchanges).
+ .
+ Custom changelog parsers must be updated to support the new API (see
+ dpkg-parsechangelog(1) and README.api).
+
+What: support of PGP
+Status: deprecated
+When: 1.15.x
+Warning: program
+Why:
+ PGP is not part of Debian and GnuPG has been the standard tool for digital
+ signatures for several years already. Supporting only GnuPG enables us to
+ rely on some of its features.
+
+What: --print-installation-architecture (dpkg option)
+Status: obsolete
+When: 1.15.x
+Warning: program
+Why:
+ Obsoleted long time ago (2005-01-22). Remaining packages should switch to
+ use 'dpkg --print-architecture'.
+
+What --forget-old-unavail (dpkg option)
+Status: obsolete
+When: 1.16.x
+Warning: program
+Why:
+ Purged packages are properly cleaned up now by dpkg, and old unavailable
+ leftovers are automatically cleaned up on database parsing. So there's no
+ need anymore for this manual action.
+
+History of feature removals
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+What: cleanup-info (program)
+Status: removed
+Since: 1.15.0
+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: --largemem, --smallmem (dpkg option)
+Status: removed
+When: 1.15.1
+Why:
+ These options have been no-ops for a long time.
+
+What: --force-auto-select (dpkg option)
+Status: removed
+When: 1.15.1
+Why:
+ This option has been a no-op for so long, that there's no traces on git
+ history of its usage.
+
+What: recommended, contrib, base (priority)
+Status: removed
+When: 1.15.1
+Why:
+ These priorities have been superseded by either other fields or values in
+ other fields.
+
+What: 822-date (program)
+Status: removed
+When: 1.15.1
+Why:
+ Should switch to use 'date -R'.
+