aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorlloyd <[email protected]>2012-07-27 16:57:14 +0000
committerlloyd <[email protected]>2012-07-27 16:57:14 +0000
commit16ccb3c130ad29aee2e640d498606314ac486f55 (patch)
tree0f22cdafd021bdb0eb842978fb925c4bdfd0e31b /doc
parent84c31975154e805c6a2ac75a79b550e5cac9ddb3 (diff)
Small doc tweaks
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.rst2
-rw-r--r--doc/index.rst22
-rw-r--r--doc/release_process.rst13
-rw-r--r--doc/x509.rst2
4 files changed, 21 insertions, 18 deletions
diff --git a/doc/filters.rst b/doc/filters.rst
index d71df1225..cb8f010b6 100644
--- a/doc/filters.rst
+++ b/doc/filters.rst
@@ -1,5 +1,5 @@
-Information Flow: Pipes and Filters
+Pipe/Filter Message Processing
========================================
Many common uses of cryptography involve processing one or more
diff --git a/doc/index.rst b/doc/index.rst
index 318880ab0..16e6377b3 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -2,12 +2,14 @@
Welcome
========================================
-Botan is a :doc:`BSD-licensed <license>` crypto library for C++. It
-provides applications with most any :doc:`cryptographic algorithm
-<algos>` you might be looking for, along with :doc:`tls`, :doc:`X.509
-certificates and CRLs <x509>`, a :doc:`pipeline-style message
-processing system <filters>`, and a wide variety of other features. A
-third party open source implementation of `SSHv2
+Botan is a crypto library for C++ released under the :doc:`BSD license
+<license>`.
+
+It provides most any :doc:`cryptographic algorithm <algos>` you might
+be looking for, along with :doc:`tls`, :doc:`X.509 certificates and
+CRLs <x509>`, a :doc:`pipeline-style message processing system
+<filters>`, and a wide variety of other features. A third party open
+source implementation of `SSHv2
<http://www.netsieben.com/products/ssh/>`_ that uses botan is also
available. In addition to C++ you can use botan from :doc:`Python
<python>` or `Node.js <https://github.com/justinfreitag/node-botan>`_
@@ -31,8 +33,9 @@ x86 and x86-64 processors are also included.
It runs on most common operating systems and can be used with a number
of different commercial and open source compilers. The :doc:`build log
-<build_log>` contains information about recently tested targets. It is
-already included in most major package distributions, including
+<build_log>` contains information about recently tested targets. It
+has more than a few :doc:`known users <users>` and is already included
+in most major package distributions, including
\
`Fedora <https://admin.fedoraproject.org/pkgdb/acls/name/botan>`_,
`EPEL <http://dl.fedoraproject.org/pub/epel/6/SRPMS/repoview/botan.html>`_ (for RHEL/CentOS),
@@ -46,8 +49,7 @@ already included in most major package distributions, including
`Cygwin <http://cygwin.com/packages/botan/>`_,
`MacPorts <http://www.macports.org/ports.php?by=name&amp;substr=botan>`_,
`OpenPKG <http://www.openpkg.org/product/packages/?package=botan>`_, and
-`T2 SDE <http://www.t2-project.org/packages/botan.html>`_ and has
-more than a few :doc:`known users <users>`.
+`T2 SDE <http://www.t2-project.org/packages/botan.html>`_
It was started as a personal project by `Jack Lloyd
<http://www.randombit.net>`_,who continues to be the maintainer and
diff --git a/doc/release_process.rst b/doc/release_process.rst
index 5419ab468..0d15c7601 100644
--- a/doc/release_process.rst
+++ b/doc/release_process.rst
@@ -10,9 +10,10 @@ Pre Release Checks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Confirm that the release notes under ``doc/relnotes`` are accurate and
-complete, updating the datestamp in the release notes and in
-``readme.txt``. Additionally confirm the version number in
-``botan_version.py`` is correct. Change the entry for the appropriate branch in ``doc/download.rst`` to point to the new release.
+complete and that the version number in ``botan_version.py`` is
+correct. Update the release date in the release notes and in
+``readme.txt``, and change the entry for the appropriate branch in
+``doc/download.rst`` to point to the new release.
Check in these changes (alone, with no other modifications) with a
checkin message along the lines of "Update for X.Y.Z release", then
@@ -85,6 +86,6 @@ Post Release Process
Immediately after the new release is created, update
``botan_version.py`` and ``readme.txt`` once again, incrementing the
-version number as appropriate and removing the release dates. For
-release notes, use "Not Yet Released" as the placeholder.
-
+version number and removing the release dates. Create a new release
+notes file for the next release. Use "Not Yet Released" as the
+placeholder for the release date.
diff --git a/doc/x509.rst b/doc/x509.rst
index e7d5c3cdf..c7f871898 100644
--- a/doc/x509.rst
+++ b/doc/x509.rst
@@ -1,7 +1,7 @@
.. _x509_certificates:
-Certificate Handling
+X.509 Certificates and CRLs
=================================
A certificate is a binding between some identifying information