Commit b76af9242faa0b7ff892d44cc0cf0e4304536024
1 parent
db7d6030
Clean up documentation around gnutls and C++-11
Showing
2 changed files
with
36 additions
and
8 deletions
README.md
| @@ -31,7 +31,9 @@ QPDF requires a C++ compiler that supports C++-11. | @@ -31,7 +31,9 @@ QPDF requires a C++ compiler that supports C++-11. | ||
| 31 | 31 | ||
| 32 | QPDF depends on the external libraries [zlib](http://www.zlib.net/) and [jpeg](http://www.ijg.org/files/). The [libjpeg-turbo](https://libjpeg-turbo.org/) library is also known to work since it is compatible with the regular jpeg library, and QPDF doesn't use any interfaces that aren't present in the straight jpeg8 API. These are part of every Linux distribution and are readily available. Download information appears in the documentation. For Windows, you can download pre-built binary versions of these libraries for some compilers; see [README-windows.md](README-windows.md) for additional details. | 32 | QPDF depends on the external libraries [zlib](http://www.zlib.net/) and [jpeg](http://www.ijg.org/files/). The [libjpeg-turbo](https://libjpeg-turbo.org/) library is also known to work since it is compatible with the regular jpeg library, and QPDF doesn't use any interfaces that aren't present in the straight jpeg8 API. These are part of every Linux distribution and are readily available. Download information appears in the documentation. For Windows, you can download pre-built binary versions of these libraries for some compilers; see [README-windows.md](README-windows.md) for additional details. |
| 33 | 33 | ||
| 34 | -If the optional gnutls crypto provider is enabled, then gnutls is also required. This is discussed more in `Crypto providers` below. | 34 | +If the optional gnutls crypto provider is enabled, |
| 35 | +then [gnutls](https://www.gnutls.org/) is also required. This is | ||
| 36 | +discussed more in `Crypto providers` below. | ||
| 35 | 37 | ||
| 36 | # Licensing terms of embedded software | 38 | # Licensing terms of embedded software |
| 37 | 39 |
manual/qpdf-manual.xml
| @@ -118,6 +118,11 @@ | @@ -118,6 +118,11 @@ | ||
| 118 | <itemizedlist> | 118 | <itemizedlist> |
| 119 | <listitem> | 119 | <listitem> |
| 120 | <para> | 120 | <para> |
| 121 | + A C++ compiler that supports C++-11. | ||
| 122 | + </para> | ||
| 123 | + </listitem> | ||
| 124 | + <listitem> | ||
| 125 | + <para> | ||
| 121 | zlib: <ulink url="http://www.zlib.net/">http://www.zlib.net/</ulink> | 126 | zlib: <ulink url="http://www.zlib.net/">http://www.zlib.net/</ulink> |
| 122 | </para> | 127 | </para> |
| 123 | </listitem> | 128 | </listitem> |
| @@ -131,6 +136,13 @@ | @@ -131,6 +136,13 @@ | ||
| 131 | </listitem> | 136 | </listitem> |
| 132 | <listitem> | 137 | <listitem> |
| 133 | <para> | 138 | <para> |
| 139 | + <emphasis>Recommended but not required:</emphasis> gnutls: | ||
| 140 | + <ulink url="https://www.gnutls.org/">https://www.gnutls.org/</ulink> | ||
| 141 | + to be able to use the gnutls crypto provider | ||
| 142 | + </para> | ||
| 143 | + </listitem> | ||
| 144 | + <listitem> | ||
| 145 | + <para> | ||
| 134 | gnu make 3.81 or newer: <ulink url="http://www.gnu.org/software/make">http://www.gnu.org/software/make</ulink> | 146 | gnu make 3.81 or newer: <ulink url="http://www.gnu.org/software/make">http://www.gnu.org/software/make</ulink> |
| 135 | </para> | 147 | </para> |
| 136 | </listitem> | 148 | </listitem> |
| @@ -151,13 +163,6 @@ | @@ -151,13 +163,6 @@ | ||
| 151 | -u</command>. | 163 | -u</command>. |
| 152 | </para> | 164 | </para> |
| 153 | </listitem> | 165 | </listitem> |
| 154 | - <listitem> | ||
| 155 | - <para> | ||
| 156 | - A C++ compiler that works well with STL and has the <type>long | ||
| 157 | - long</type> type. Most modern C++ compilers should fit the bill | ||
| 158 | - fine. QPDF is tested with gcc, clang, and Microsoft Visual C++. | ||
| 159 | - </para> | ||
| 160 | - </listitem> | ||
| 161 | </itemizedlist> | 166 | </itemizedlist> |
| 162 | </para> | 167 | </para> |
| 163 | <para> | 168 | <para> |
| @@ -4625,6 +4630,27 @@ print "\n"; | @@ -4625,6 +4630,27 @@ print "\n"; | ||
| 4625 | <itemizedlist> | 4630 | <itemizedlist> |
| 4626 | <listitem> | 4631 | <listitem> |
| 4627 | <para> | 4632 | <para> |
| 4633 | + Build Changes | ||
| 4634 | + </para> | ||
| 4635 | + <itemizedlist> | ||
| 4636 | + <listitem> | ||
| 4637 | + <para> | ||
| 4638 | + A C++-11 compiler is now required to build qpdf. | ||
| 4639 | + </para> | ||
| 4640 | + </listitem> | ||
| 4641 | + <listitem> | ||
| 4642 | + <para> | ||
| 4643 | + A new crypto provider that uses gnutls for crypto functions | ||
| 4644 | + is now available and can be enabled at build time. See <xref | ||
| 4645 | + linkend="ref.crypto"/> for more information about crypto | ||
| 4646 | + providers and <xref linkend="ref.crypto.build"/> for | ||
| 4647 | + specific information about the build. | ||
| 4648 | + </para> | ||
| 4649 | + </listitem> | ||
| 4650 | + </itemizedlist> | ||
| 4651 | + </listitem> | ||
| 4652 | + <listitem> | ||
| 4653 | + <para> | ||
| 4628 | Library Enhancements | 4654 | Library Enhancements |
| 4629 | </para> | 4655 | </para> |
| 4630 | <itemizedlist> | 4656 | <itemizedlist> |