Skip to content

Commit

Permalink
Deploying to gh-pages from @ c75dd79 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
andrie committed Oct 15, 2023
1 parent 282ad2f commit fb16a8f
Show file tree
Hide file tree
Showing 8 changed files with 63 additions and 43 deletions.
2 changes: 1 addition & 1 deletion r-admin/Installing-R-under-Unix-alikes.html
Original file line number Diff line number Diff line change
Expand Up @@ -607,7 +607,7 @@ <h3 class="subsection anchored" data-number="2.7.3" data-anchor-id="c-support"><
</section>
<section id="c-standards" class="level3 subsection" data-number="2.7.4">
<h3 class="subsection anchored" data-number="2.7.4" data-anchor-id="c-standards"><span class="header-section-number">2.7.4</span> C standards</h3>
<p>Compiling R requires C99 or later: C11 and C17 are minor updates, but the substantial update planned for ‘C23’ (now expected in 2024) will also be supported.</p>
<p>Compiling R requires C99 or later: C11 and C17 are minor updates, but the substantial update planned for ‘C23’ (now expected <em>ca</em> April 2024) will also be supported.</p>
<p>As from R 4.3.0 there is support for packages to indicate their preferred C version. Macros <code>CC17</code>, <code>C17FLAGS</code>, <code>CC23</code> and <code>C23FLAGS</code> can be set in <code>config.site</code> (there are examples there). Those for C17 should support C17 or earlier and not allow C23 additions so for example <code>bool</code>, <code>true</code> and <code>false</code> can be used as identifiers. Those for C23 should support new types such as <code>bool</code>.</p>
<p>Some compilers warn enthusiastically about prototypes. For most, omitting <code>-Wstrict-prototypes</code> in <code>C17FLAGS</code> suffices. However, versions 15 and later of LLVM <code>clang</code> and 14.0.3 and later of Apple clang warn by default in all modes if <code>-Wall</code> or <code>-pedantic</code> is used, and may need <code>-Wno-strict-prototypes</code>.</p>
</section>
Expand Down
2 changes: 1 addition & 1 deletion r-admin/search.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion r-exts/Creating-R-packages.html
Original file line number Diff line number Diff line change
Expand Up @@ -1709,7 +1709,7 @@ <h2 class="section anchored" data-number="1.6" data-anchor-id="writing-portable-
<li><p>Take care in naming LaTeX macros (also known as ‘commands’) in vignette sources: if these are also defined in a future version of one of the LaTeX packages used there will be a fatal error. One instance in 2021 was package <code>hyperref</code> newly defining <code>\C</code>, <code>\F</code>, <code>\G</code>, <code>\U</code> and <code>\textapprox</code>. If you are confident that your definitions will be the only ones relevant you can use <code>\renewcommand</code> but it is better to use names clearly associated with your package.</p></li>
<li><p>Make sure that any version requirement for Java code is both declared in the <code>SystemRequirements</code> field<a href="#fn89" class="footnote-ref" id="fnref89" role="doc-noteref"><sup>89</sup></a> and tested at runtime (not least as the Java installation when the package is installed might not be the same as when the package is run and will not be for binary packages).</p>
<p>When specifying a minimum Java version please use the official version names, which are (confusingly)</p>
<div class="sourceCode" id="cb117"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb117-1"><a href="#cb117-1" aria-hidden="true" tabindex="-1"></a><span class="fl">1.1</span> <span class="fl">1.2</span> <span class="fl">1.3</span> <span class="fl">1.4</span> <span class="fl">5.0</span> <span class="dv">6</span> <span class="dv">7</span> <span class="dv">8</span> <span class="dv">9</span> <span class="dv">10</span> <span class="dv">11</span> <span class="dv">12</span> <span class="dv">13</span> <span class="dv">14</span> <span class="dv">15</span> <span class="dv">16</span> <span class="dv">17</span> <span class="dv">18</span> <span class="dv">19</span> <span class="dv">20</span> (announced <span class="dv">21</span>)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="sourceCode" id="cb117"><pre class="sourceCode r code-with-copy"><code class="sourceCode r"><span id="cb117-1"><a href="#cb117-1" aria-hidden="true" tabindex="-1"></a><span class="fl">1.1</span> <span class="fl">1.2</span> <span class="fl">1.3</span> <span class="fl">1.4</span> <span class="fl">5.0</span> <span class="dv">6</span> <span class="dv">7</span> <span class="dv">8</span> <span class="dv">9</span> <span class="dv">10</span> <span class="dv">11</span> <span class="dv">12</span> <span class="dv">13</span> <span class="dv">14</span> <span class="dv">15</span> <span class="dv">16</span> <span class="dv">17</span> <span class="dv">18</span> <span class="dv">19</span> <span class="dv">20</span> <span class="dv">21</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>and as from 2018 a year.month scheme such as <code>18.9</code> is also in use. Fortunately only the integer values are likely to be relevant. If at all possible, use one of the LTS versions (8, 11, 17, 21 …) as the minimum version. The preferred form of version specification is</p>
<div class="sourceCode" id="cb118"><pre class="sourceCode default code-with-copy"><code class="sourceCode default"><span id="cb118-1"><a href="#cb118-1" aria-hidden="true" tabindex="-1"></a>SystemRequirements: Java (&gt;= 11)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>A suitable test for Java at least version 8 for packages using <a href="https://CRAN.R-project.org/package=rJava"><strong>rJava</strong></a> would be something like</p>
Expand Down
6 changes: 3 additions & 3 deletions r-exts/The-R-API.html
Original file line number Diff line number Diff line change
Expand Up @@ -401,9 +401,9 @@ <h3 class="subsection anchored" data-number="6.1.2" data-anchor-id="user-control
<p>Memory obtained by these macros should be aligned in the same way as <code>malloc</code>, that is ‘suitably aligned for any kind of variable’.</p>
<p>Historically the macros <code>Calloc</code>, <code>Free</code> and <code>Realloc</code> were used, and these remain available unless <code>STRICT_R_HEADERS</code> was defined prior to the inclusion of the header.</p>
<div class="sourceCode" id="cb9"><pre class="sourceCode c code-with-copy"><code class="sourceCode c"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="dt">char</span> <span class="op">*</span> CallocCharBuf<span class="op">(</span><span class="dt">size_t</span> n<span class="op">)</span></span>
<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a><span class="dt">void</span> <span class="op">*</span> Memcpy<span class="op">(</span>p<span class="op">,</span> q<span class="op">,</span> n<span class="op">)</span></span>
<span id="cb9-3"><a href="#cb9-3" aria-hidden="true" tabindex="-1"></a><span class="dt">void</span> <span class="op">*</span> Memzero<span class="op">(</span>p<span class="op">,</span> m<span class="op">)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p><code>CallocCharBuf</code> is shorthand for <code>R_Calloc(n+1, char)</code> to allow for the <code>nul</code> terminator. <code>Memcpy</code> and <code>Memzero</code> take <code>n</code> items from array <code>p</code> and copy them to array <code>p</code> or zero them respectively.</p>
<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a><span class="dt">void</span> <span class="op">*</span> Memcpy<span class="op">(</span>q<span class="op">,</span> p<span class="op">,</span> n<span class="op">)</span></span>
<span id="cb9-3"><a href="#cb9-3" aria-hidden="true" tabindex="-1"></a><span class="dt">void</span> <span class="op">*</span> Memzero<span class="op">(</span>p<span class="op">,</span> n<span class="op">)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p><code>CallocCharBuf(n)</code> is shorthand for <code>R_Calloc(n+1, char)</code> to allow for the <code>nul</code> terminator. <code>Memcpy</code> and <code>Memzero</code> take <code>n</code> items from array <code>p</code> and copy them to array <code>q</code> or zero them respectively.</p>
</section>
</section>
<section id="error-signaling" class="level2 section" data-number="6.2">
Expand Down
4 changes: 2 additions & 2 deletions r-exts/search.json

Large diffs are not rendered by default.

50 changes: 31 additions & 19 deletions r-ints/Function-and-variable-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -691,124 +691,136 @@ <h1 class="title">Function and variable index</h1>
</tr>
<tr class="odd">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_native_routine_registration_"><code>_R_CHECK_NATIVE_ROUTINE_REGISTRATION_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_mbcs_conversion_failure_"><code>_R_CHECK_MBCS_CONVERSION_FAILURE_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="even">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_news_in_plain_text_"><code>_R_CHECK_NEWS_IN_PLAIN_TEXT_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_native_routine_registration_"><code>_R_CHECK_NATIVE_ROUTINE_REGISTRATION_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="odd">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_no_recommended_"><code>_R_CHECK_NO_RECOMMENDED_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_news_in_plain_text_"><code>_R_CHECK_NEWS_IN_PLAIN_TEXT_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="even">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_no_stop_on_test_error_"><code>_R_CHECK_NO_STOP_ON_TEST_ERROR_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_no_recommended_"><code>_R_CHECK_NO_RECOMMENDED_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="odd">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_one_test_elapsed_timeout_"><code>_R_CHECK_ONE_TEST_ELAPSED_TIMEOUT_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_no_stop_on_test_error_"><code>_R_CHECK_NO_STOP_ON_TEST_ERROR_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="even">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_one_vignette_elapsed_timeout_"><code>_R_CHECK_ONE_VIGNETTE_ELAPSED_TIMEOUT_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_one_test_elapsed_timeout_"><code>_R_CHECK_ONE_TEST_ELAPSED_TIMEOUT_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="odd">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_orphaned_"><code>_R_CHECK_ORPHANED_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_one_vignette_elapsed_timeout_"><code>_R_CHECK_ONE_VIGNETTE_ELAPSED_TIMEOUT_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="even">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_overwrite_registered_s3_methods_"><code>_R_CHECK_OVERWRITE_REGISTERED_S3_METHODS_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_orphaned_"><code>_R_CHECK_ORPHANED_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="odd">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_packages_used_in_tests_use_subdirs_"><code>_R_CHECK_PACKAGES_USED_IN_TESTS_USE_SUBDIRS_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_overwrite_registered_s3_methods_"><code>_R_CHECK_OVERWRITE_REGISTERED_S3_METHODS_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="even">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_permissions_"><code>_R_CHECK_PERMISSIONS_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_packages_used_in_tests_use_subdirs_"><code>_R_CHECK_PACKAGES_USED_IN_TESTS_USE_SUBDIRS_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="odd">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_pkgman_elapsed_timeout_"><code>_R_CHECK_PKGMAN_ELAPSED_TIMEOUT_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_permissions_"><code>_R_CHECK_PERMISSIONS_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="even">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_pkg_sizes_"><code>_R_CHECK_PKG_SIZES_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_pkgman_elapsed_timeout_"><code>_R_CHECK_PKGMAN_ELAPSED_TIMEOUT_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="odd">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_pkg_sizes_threshold_"><code>_R_CHECK_PKG_SIZES_THRESHOLD_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_pkg_sizes_"><code>_R_CHECK_PKG_SIZES_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="even">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_pragmas_"><code>_R_CHECK_PRAGMAS_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_pkg_sizes_threshold_"><code>_R_CHECK_PKG_SIZES_THRESHOLD_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="odd">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_rd_allow_empty_item_in_describe_"><code>_R_CHECK_RD_ALLOW_EMPTY_ITEM_IN_DESCRIBE_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_pragmas_"><code>_R_CHECK_PRAGMAS_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="even">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_rd_checkrd_minlevel_"><code>_R_CHECK_RD_CHECKRD_MINLEVEL_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_rd_allow_empty_item_in_describe_"><code>_R_CHECK_RD_ALLOW_EMPTY_ITEM_IN_DESCRIBE_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="odd">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_rd_contents_"><code>_R_CHECK_RD_CONTENTS_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_rd_checkrd_minlevel_"><code>_R_CHECK_RD_CHECKRD_MINLEVEL_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="even">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_rd_examples_t_and_f_"><code>_R_CHECK_RD_EXAMPLES_T_AND_F_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_rd_contents_"><code>_R_CHECK_RD_CONTENTS_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="odd">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_rd_line_widths_"><code>_R_CHECK_RD_LINE_WIDTHS_</code></a>:</td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_rd_examples_t_and_f_"><code>_R_CHECK_RD_EXAMPLES_T_AND_F_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="even">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_rd_line_widths_"><code>_R_CHECK_RD_LINE_WIDTHS_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="odd">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_rd_math_rendering_"><code>_R_CHECK_RD_MATH_RENDERING_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="even">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_rd_note_lost_braces_"><code>_R_CHECK_RD_NOTE_LOST_BRACES_</code></a>:</td>
<td style="text-align: left;">&nbsp;</td>
<td style="text-align: left;"><a href="Tools.html">Tools</a></td>
</tr>
<tr class="odd">
<td></td>
<td style="text-align: left;"><a href="Tools.html#index-_r_check_rd_style_"><code>_R_CHECK_RD_STYLE_</code></a>:</td>
Expand Down
Loading

0 comments on commit fb16a8f

Please sign in to comment.