aboutsummaryrefslogtreecommitdiffstats
path: root/doc/manual/support.rst
blob: e936a6bbb217e8ba6412f7ea33638d8daf1c9736 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
Support Information
=======================

Supported Platforms
------------------------

For Botan 2, the tier-1 supported platforms are

* Linux x86-64, GCC 4.8 or higher
* Linux x86-64, Clang 3.5 or higher
* Linux aarch64, GCC 4.8+
* Linux ppc64le, GCC 4.8+
* Windows x86-64, Visual C++ 2015 and 2017

These platforms are all tested by continuous integration, and the developers
have access to hardware in order to test patches. Problems affecting these
platforms are considered release blockers.

For Botan 2, the tier-2 supported platforms are

* Linux x86-32, GCC 4.8+
* Linux arm32, GCC 4.8+
* Windows x86-64, MinGW GCC
* Apple OS X x86-64, XCode Clang
* iOS arm32/arm64, XCode Clang
* Android arm32, NDK Clang
* FreeBSD x86-64, Clang 3.8+
* IncludeOS x86-32, Clang 3.8+

Some (but not all) of the tier-2 platforms are tested by CI. Things should
mostly work, and if problems are encountered, the Botan devs will probably be
able to help. But they are not as well tested as tier-1.

Of course many other modern OSes such as OpenBSD, NetBSD, AIX, Solaris or QNX
are also probably fine (Botan has been tested on all of them successfully in the
past), but none of the core developers run these OSes and may not be able to
help so much in debugging problems. Patches to improve the build for these
platforms are welcome, as are any reports of successful use.

In theory any working C++11 compiler is fine but in practice, we only test with
GCC, Clang, and Visual C++.  There is support in the build system for several
commercial C++ compilers (Intel, PGI, Sun Studio, Ekopath, etc) all of which
worked with older (C++98) versions of both the code and the compilers, but it is
not known if the latest versions of these compilers can compile the library
properly.

Branch Support Status
-------------------------

Following table provides the support status for Botan branches as of August 2018.
Any branch not listed here (including 1.11) is no longer supported.
Dates in the future are approximate.

============== ============== ========================== ============
Branch         First Release  End of Active Development  End of Life
============== ============== ========================== ============
1.8            2008-12-08     2010-08-31                 2016-02-13
1.10           2011-06-20     2012-07-10                 2018-12-31
2.x            2017-01-06     2020?                      2022 or later
3.x            2020?          ?                          ?
============== ============== ========================== ============

"Active development" refers to adding new features and optimizations. At the
conclusion of the active development phase, only bugfixes are applied.

Getting Help
------------------

To get help with Botan, open an issue on
`GitHub <https://github.com/randombit/botan/issues>`_