From ab39c5fd9906b72e86b1b3dd82b7b5a476e3c4f5 Mon Sep 17 00:00:00 2001
From: Julian Andres Klode <jak@debian.org>
Date: Wed, 10 Jun 2015 12:02:41 +0200
Subject: doc: Prepare for 1.0 release

Change the whatsnew page to a two-component variant (1.0, so we do not
get bug fix releases mixed in there, and update the pages for the changes
planned for 1.0.

Not all have been committed yet, though.
---
 doc/source/conf.py             |  2 +-
 doc/source/library/apt_pkg.rst |  7 +++++++
 doc/source/whatsnew/1.0.rst    | 26 ++++++++++++++++++++++++++
 3 files changed, 34 insertions(+), 1 deletion(-)
 create mode 100644 doc/source/whatsnew/1.0.rst

(limited to 'doc/source')

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 6775269f..36d89c06 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -95,7 +95,7 @@ if int(release_raw) >= 90:
     version = '.'.join(version_s)
     del version_s
 else:
-    version = '.'.join(release.split("~")[0].split('.')[:3])
+    version = '.'.join(release.split("~")[0].split('.')[:2])
 del release_raw
 
 # The language for content autogenerated by Sphinx. Refer to documentation
diff --git a/doc/source/library/apt_pkg.rst b/doc/source/library/apt_pkg.rst
index f8ba186a..fd505b20 100644
--- a/doc/source/library/apt_pkg.rst
+++ b/doc/source/library/apt_pkg.rst
@@ -787,6 +787,11 @@ Resolving Dependencies with :class:`ProblemResolver`
         The section of the package, as specified in the record. The list of
         possible sections is defined in the Policy. This is a string.
 
+        .. deprecated:: 1.0
+
+            A package can have multiple versions with different sections, so
+            the section information should be accessed from the version class.
+
     .. attribute:: version_list
 
         A list of :class:`Version` objects for all versions of this package
@@ -1481,6 +1486,8 @@ Records (Release files, Packages, Sources)
         ``(str: md5, int: size, str: path, str:type)``, where
         'type' can be 'diff' (includes .debian.tar.gz), 'dsc', 'tar'.
 
+        .. deprecated: 1.0
+
     .. attribute:: index
 
         A list of :class:`IndexFile` objects associated with this
diff --git a/doc/source/whatsnew/1.0.rst b/doc/source/whatsnew/1.0.rst
new file mode 100644
index 00000000..317410f9
--- /dev/null
+++ b/doc/source/whatsnew/1.0.rst
@@ -0,0 +1,26 @@
+What's New In python-apt 1.0
+==============================
+Python-Apt 1.0 fixes several issues and use of deprecated methods. Most
+importantly, it introduces large file support
+
+New features
+------------
+* :class:`apt_pkg.AcquireFile` can now take a hash string that is not an
+  md5 value, using the new `hash` argument.
+
+
+
+Deprecated
+----------
+The following features are deprecated, starting with this release:
+
+* The `section` member of :class:`apt_pkg.Package`
+* The `files` member of of :class:`apt_pkg.SourceRecords`
+* The `md5` argument to :class:`apt_pkg.AcquireFile`, it is replaced by
+  the `hash` argument.
+
+Maintenance
+-----------
+
+* :mod:`apt_inst` now supports ar and tar archives that are larger than 4 GiB
+* Various smaller bug fixes
-- 
cgit v1.2.3