Skip to content

Commit

Permalink
Update docs for 1.3.6 release (#842)
Browse files Browse the repository at this point in the history
  • Loading branch information
lsh123 authored Oct 7, 2024
1 parent 22bb104 commit abdda70
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 43 deletions.
22 changes: 11 additions & 11 deletions docs/api/xmlsec-xmlsec.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,10 @@ <h2><span class="refentrytitle"><a name="xmlsec-xmlsec.top_of_page"></a>xmlsec</
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="xmlsec-xmlsec.html#XMLSEC-DEPRECATED:CAPS" title="XMLSEC_DEPRECATED">XMLSEC_DEPRECATED</a></td>
</tr>
<tr>
<td class="typedef_keyword">typedef</td>
<td class="function_name"><font>xmlSecPtr</font></td>
</tr>
Expand Down Expand Up @@ -138,10 +142,6 @@ <h2><span class="refentrytitle"><a name="xmlsec-xmlsec.top_of_page"></a>xmlsec</
<td class="function_name"><a class="link" href="xmlsec-xmlsec.html#xmlSecByte" title="xmlSecByte">xmlSecByte</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="xmlsec-xmlsec.html#XMLSEC-DEPRECATED:CAPS" title="XMLSEC_DEPRECATED">XMLSEC_DEPRECATED</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="xmlsec-xmlsec.html#xmlSecCheckVersionMode" title="enum xmlSecCheckVersionMode">xmlSecCheckVersionMode</a></td>
</tr>
Expand Down Expand Up @@ -302,6 +302,13 @@ <h2><span class="refentrytitle"><a name="xmlsec-xmlsec.top_of_page"></a>xmlsec</
<div class="refsect1">
<a name="xmlsec-xmlsec.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="XMLSEC-DEPRECATED:CAPS"></a><h3>XMLSEC_DEPRECATED</h3>
<pre class="programlisting">#define XMLSEC_DEPRECATED __attribute__((deprecated))
</pre>
<p>Marks function as deprecated.</p>
</div>
<hr>
<div class="refsect2">
<a name="xmlSecPtr"></a><h3>xmlSecPtr</h3>
<pre class="programlisting">typedef void* xmlSecPtr;
</pre>
Expand Down Expand Up @@ -349,13 +356,6 @@ <h2><span class="refentrytitle"><a name="xmlsec-xmlsec.top_of_page"></a>xmlsec</
</div>
<hr>
<div class="refsect2">
<a name="XMLSEC-DEPRECATED:CAPS"></a><h3>XMLSEC_DEPRECATED</h3>
<pre class="programlisting">#define XMLSEC_DEPRECATED __attribute__((deprecated))
</pre>
<p>Marks function as deprecated.</p>
</div>
<hr>
<div class="refsect2">
<a name="xmlSecCheckVersionMode"></a><h3>enum xmlSecCheckVersionMode</h3>
<p>The xmlsec library version mode.</p>
<div class="refsect3">
Expand Down
2 changes: 1 addition & 1 deletion docs/api/xmlsec.devhelp2
Original file line number Diff line number Diff line change
Expand Up @@ -1014,14 +1014,14 @@
<keyword type="macro" name="xmlSecCheckVersionExact" link="xmlsec-xmlsec.html#xmlSecCheckVersionExact"/>
<keyword type="macro" name="xmlSecCheckVersion" link="xmlsec-xmlsec.html#xmlSecCheckVersion"/>
<keyword type="function" name="xmlSecCheckVersionExt ()" link="xmlsec-xmlsec.html#xmlSecCheckVersionExt"/>
<keyword type="macro" name="XMLSEC_DEPRECATED" link="xmlsec-xmlsec.html#XMLSEC-DEPRECATED:CAPS"/>
<keyword type="typedef" name="xmlSecPtr" link="xmlsec-xmlsec.html#xmlSecPtr"/>
<keyword type="macro" name="XMLSEC_SIZE_T_FMT" link="xmlsec-xmlsec.html#XMLSEC-SIZE-T-FMT:CAPS"/>
<keyword type="typedef" name="xmlSecSize" link="xmlsec-xmlsec.html#xmlSecSize"/>
<keyword type="macro" name="XMLSEC_SIZE_MIN" link="xmlsec-xmlsec.html#XMLSEC-SIZE-MIN:CAPS"/>
<keyword type="macro" name="XMLSEC_SIZE_MAX" link="xmlsec-xmlsec.html#XMLSEC-SIZE-MAX:CAPS"/>
<keyword type="macro" name="XMLSEC_SIZE_FMT" link="xmlsec-xmlsec.html#XMLSEC-SIZE-FMT:CAPS"/>
<keyword type="typedef" name="xmlSecByte" link="xmlsec-xmlsec.html#xmlSecByte"/>
<keyword type="macro" name="XMLSEC_DEPRECATED" link="xmlsec-xmlsec.html#XMLSEC-DEPRECATED:CAPS"/>
<keyword type="enum" name="enum xmlSecCheckVersionMode" link="xmlsec-xmlsec.html#xmlSecCheckVersionMode"/>
<keyword type="macro" name="xmlSecNodeGetName()" link="xmlsec-xmltree.html#xmlSecNodeGetName"/>
<keyword type="function" name="xmlSecGetDefaultLineFeed ()" link="xmlsec-xmltree.html#xmlSecGetDefaultLineFeed"/>
Expand Down
30 changes: 3 additions & 27 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,11 @@ <h1>XML Security Library</h1>
see the Copyright file in the distribution for details.<br><br></p>
<p><b>News</b></p>
<ul>
<li>TBD<br>
<li>October 22, 2024<br>
The <a href="download.html">XML Security Library 1.3.6</a> release includes the following changes:
<ul>
<li>(xmlsec-openssl) Fixed build if OpenSSL 3.0 doesn't have engines support enabled.</li>
<li>(xmlsec-mscng, xmlsec-mscrypto) Added support for multiple trusted certs with the same subject.</li>
<li>(windows) Disabled iconv support by default (use 'iconv=yes' option for 'configure.js' to re-enable it).</li>
<li>Several other small fixes (see <a href="https://github.com/lsh123/xmlsec/commits/master">more details</a>).</li>
</ul>
Expand Down Expand Up @@ -355,32 +357,6 @@ <h1>XML Security Library</h1>
</ul>
</li>
<br>
<li>October 25, 2022<br>
The <a href="download.html">XML Security Library 1.2.35</a> release includes the following changes:
<ul>
<li>
Migration to OpenSSL 3.0 API (based on PR by @snargit). Note that OpenSSL engines
are disabled by default when XMLSec library is compiled against OpenSSL 3.0.
To re-enable OpenSSL engines, use "--enable-openssl3-engines" configure flag
(there will be a lot of deprecation warnings).
</li>
<li>
The OpenSSL before 1.1.0 and LibreSSL before 2.7.0 are now deprecated and
will be removed in the future versions of XMLSec Library.
</li>
<li>
Refactored all the integer casts to ensure cast-safety. Fixed all warnings
and enabled "-Werror" and "-pedantic" flags on CI builds.
</li>
<li>
Added configure flag to use size_t for xmlSecSize (currently disabled by default
for backward compatibility).
</li>
<li>Moved all CI builds to GitHub actions.</li>
<li>Several other small fixes (<a href="https://github.com/lsh123/xmlsec/commits/master">more details</a>).</li>
</ul>
</li>
<br>
</ul>
<br><br><a href="news.html">News page</a>
</td></tr></table></td>
Expand Down
10 changes: 8 additions & 2 deletions docs/news.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,14 @@
<h1>XML Security Library News</h1>
</div>
<ul>
<li>TBD<br>
TODO: COPY FROM index.html
<li>October 22, 2024<br>
The <a href="download.html">XML Security Library 1.3.6</a> release includes the following changes:
<ul>
<li>(xmlsec-openssl) Fixed build if OpenSSL 3.0 doesn't have engines support enabled.</li>
<li>(xmlsec-mscng, xmlsec-mscrypto) Added support for multiple trusted certs with the same subject.</li>
<li>(windows) Disabled iconv support by default (use 'iconv=yes' option for 'configure.js' to re-enable it).</li>
<li>Several other small fixes (see <a href="https://github.com/lsh123/xmlsec/commits/master">more details</a>).</li>
</ul>
</li>
<br>

Expand Down
2 changes: 1 addition & 1 deletion man/xmlsec1-config.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH XMLSEC1-CONFIG "1" "July 2024" "xmlsec1-config 1.3.6" "User Commands"
.TH XMLSEC1-CONFIG "1" "October 2024" "xmlsec1-config 1.3.6" "User Commands"
.SH NAME
xmlsec1-config \- detail installed version of xmlsec library
.SH SYNOPSIS
Expand Down
2 changes: 1 addition & 1 deletion man/xmlsec1.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
.TH XMLSEC1 "1" "July 2024" "xmlsec1 1.3.6 (openssl)" "User Commands"
.TH XMLSEC1 "1" "October 2024" "xmlsec1 1.3.6 (openssl)" "User Commands"
.SH NAME
xmlsec1 \- sign, verify, encrypt and decrypt XML documents
.SH SYNOPSIS
Expand Down

0 comments on commit abdda70

Please sign in to comment.