aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorlloyd <[email protected]>2012-07-11 15:48:48 +0000
committerlloyd <[email protected]>2012-07-11 15:48:48 +0000
commitb69b268c9b3160f165400437fc6e12791ca7f2c6 (patch)
treebcecfef4adb075a6193b7ea67dbece8f7dd7eb28 /doc
parent6760cb17f76fca4d0f521299d4241656a3469e56 (diff)
Use subsections in 1.11.0 release notes.
Remove installer link for 1.8. Update 1.10 installer to 1.10.3 and link to signatures as well. Add note in download links that 1.11 requires a C++11 compiler. Add build records for Windows 1.10.3 with VC 2010.
Diffstat (limited to 'doc')
-rw-r--r--doc/build_log.rst3
-rw-r--r--doc/conf.py22
-rw-r--r--doc/download.rst25
-rw-r--r--doc/relnotes/1_11_0.rst30
4 files changed, 48 insertions, 32 deletions
diff --git a/doc/build_log.rst b/doc/build_log.rst
index 0db803394..1b1e4e712 100644
--- a/doc/build_log.rst
+++ b/doc/build_log.rst
@@ -17,6 +17,9 @@ Date Version OS CPU Compile
2012-07-09 1.11.0 Gentoo Intel Core i7-860 GCC 4.7.0 OK
2012-07-09 1.11.0 Gentoo Intel Core i7-860 Clang 3.1 OK
+2012-07-11 1.10.3 Windows 7 x64 x86 Visual C++ 16.00.30319.01 OK
+2012-07-11 1.10.3 Windows 7 x64 x86-64 Visual C++ 16.00.30319.01 OK
+
2012-07-09 1.10.2 Gentoo Intel Core i7-860 GCC 4.7.0 OK
2012-07-09 1.10.2 Gentoo Intel Core i7-860 GCC 4.6.3 OK
2012-07-09 1.10.2 Gentoo Intel Core i7-860 GCC 4.5.3 OK
diff --git a/doc/conf.py b/doc/conf.py
index c03e922d0..a5aa58568 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -49,24 +49,24 @@ templates_path = ['_sphinx/templates']
if is_website_build and use_disqus:
templates_path += ['_sphinx/disqus']
+files_dir = 'http://botan.randombit.net/files'
+
extlinks = {
'pr': ('http://bugs.randombit.net/show_bug.cgi?id=%s', 'PR '),
- 'tgz': ('http://botan.randombit.net/files/Botan-%s.tgz', 'tar/gz for '),
- 'tgz_sig': ('http://botan.randombit.net/files/Botan-%s.tgz.asc', 'tar/gz sig '),
- 'tbz': ('http://botan.randombit.net/files/Botan-%s.tbz', 'tar/bzip for '),
- 'tbz_sig': ('http://botan.randombit.net/files/Botan-%s.tbz.asc', 'tar/bzip sig '),
-
'wikipedia': ('http://en.wikipedia.org/wiki/%s', ''),
-
'viewmtn': ('http://viewmtn.randombit.net/tree/h:%s', ''),
-
'botan-devel': ('http://lists.randombit.net/pipermail/botan-devel/%s.html', None),
- 'installer_x86_32': ('http://botan.randombit.net/files/win32/botan-%s_win32.exe',
- 'x86-32 '),
+ 'tgz': (files_dir + '/Botan-%s.tgz', 'tar/gz for '),
+ 'tgz_sig': (files_dir + '/Botan-%s.tgz.asc', 'tar/gz sig '),
+ 'tbz': (files_dir + '/Botan-%s.tbz', 'tar/bzip for '),
+ 'tbz_sig': (files_dir + '/Botan-%s.tbz.asc', 'tar/bzip sig '),
+
+ 'installer_x86_32': (files_dir + '/win32/botan-%s_win32.exe', 'x86-32 '),
+ 'installer_x86_64': (files_dir + '/win32/botan-%s_win64.exe', 'x86-64 '),
- 'installer_x86_64': ('http://botan.randombit.net/files/win32/botan-%s_win64.exe',
- 'x86-64 ')
+ 'installer_sig_x86_32': (files_dir + '/win32/botan-%s_win32.exe.asc', None),
+ 'installer_sig_x86_64': (files_dir + '/win32/botan-%s_win64.exe.asc', None),
}
source_suffix = '.rst'
diff --git a/doc/download.rst b/doc/download.rst
index 4db7d8dda..1211ec178 100644
--- a/doc/download.rst
+++ b/doc/download.rst
@@ -14,13 +14,17 @@ Unsure which release you want? Check the :ref:`FAQ <devel_vs_stable>`.
release `may be available <http://botan.randombit.net/download.html>`_.
Current Development Series (1.11)
----------------------------------------------------------------------------
+----------------------------------------
The latest version of the current development series, from branch
``net.randombit.botan``, is :doc:`relnotes/1_11_0`
+.. note::
+
+ Versions 1.11.0 and later require a C++11 compiler.
+
Current Stable Series (1.10)
----------------------------------------------------------------------------
+----------------------------------------
The latest version of the current stable series, from branch
``net.randombit.botan.1_10``, is :doc:`relnotes/1_10_3`:
@@ -30,25 +34,20 @@ The latest version of the current stable series, from branch
Windows Installer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Windows installers for :installer_x86_32:`1.10.1` and
-:installer_x86_64:`1.10.1` for use with Visual C++ 2010 are
-also available.
+Windows installers for use with Visual C++ 2010
+:installer_x86_32:`1.10.3` (:installer_sig_x86_32:`sig <1.10.3>`)
+and
+:installer_x86_64:`1.10.3` (:installer_sig_x86_64:`sig <1.10.3>`)
+are also available.
Previous Stable Series (1.8)
----------------------------------------------------------------------------
+----------------------------------------
The latest version of the previous stable series, from branch
``net.randombit.botan.1_8`` is :doc:`relnotes/1_8_13`:
:tgz:`1.8.13` (:tgz_sig:`sig <1.8.13>`),
:tbz:`1.8.13` (:tbz_sig:`sig <1.8.13>`)
-Windows Installer
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Windows installers for :installer_x86_32:`1.8.11` and
-:installer_x86_64:`1.8.11` for use with Visual C++ 2008 are also
-available.
-
Accessing Version Control
----------------------------------------
diff --git a/doc/relnotes/1_11_0.rst b/doc/relnotes/1_11_0.rst
index 32af46774..6536ae34d 100644
--- a/doc/relnotes/1_11_0.rst
+++ b/doc/relnotes/1_11_0.rst
@@ -1,10 +1,15 @@
Version 1.11.0, Not Yet Released
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-In this release, many new features of C++11 are being used in the
-library. Currently GCC 4.7 and Clang 3.1 are known to work. This
-version of the library cannot be compiled by or used with a C++98
-compiler.
+.. note::
+
+ In this release, many new features of C++11 are being used in the
+ library. Currently GCC 4.7 and Clang 3.1 are known to work well.
+ This version of the library cannot be compiled by or used with a
+ C++98 compiler.
+
+TLS and PKI Changes
+""""""""""""""""""""""""""""""""""""""""
There have been many changes and improvements to :doc:`TLS
<../tls>`. The interface is now purely event driven and does not
@@ -24,11 +29,14 @@ The API for X.509 path validation has changed, with
``x509_path_validate`` in x509path.h now handles path validation and
``Certificate_Store`` handles storage of certificates and CRLs.
+Memory Container Changes
+""""""""""""""""""""""""""""""""""""""""
+
The memory container types have changed substantially. The
-MemoryVector and SecureVector container types have been removed, and
-an alias of std::vector using an allocator that clears memory named
-secure_vector is used for key material, with std::vector being used
-for everything else.
+``MemoryVector`` and ``SecureVector`` container types have been
+removed, and an alias of ``std::vector`` using an allocator that
+clears memory named ``secure_vector`` is used for key material, with
+plain ``std::vector`` being used for everything else.
The technique used for mlock'ing memory on Linux and BSD systems is
much improved. Now a single page-aligned block of memory (the exact
@@ -37,10 +45,16 @@ using a best-fit allocator and all metadata held outside the mmap'ed
range, in an effort to make best use of the very limited amount of
memory current Linux kernels allow unpriveledged users to lock.
+New LZMA Compression Filter
+""""""""""""""""""""""""""""""""""""""""
+
A filter using LZMA was contributed by Vojtech Kral. It is available
if LZMA support was enabled at compilation time by passing
``--with-lzma`` to ``configure.py``.
+ECC Key Decoding Problem Resolved
+""""""""""""""""""""""""""""""""""""""""
+
:rfc:`5915` adds some extended information which can be included in
ECC private keys which the ECC key decoder did not expect, causing an
exception when such a key was loaded. In particular, recent versions