Skip to content

Commit 5f95f6e

Browse files
author
AtomVM Doc Bot
committed
Update Documentation for main
1 parent 17bcd5f commit 5f95f6e

File tree

208 files changed

+588
-455
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

208 files changed

+588
-455
lines changed

main/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 01dd8eaacac08c7666441da772e27654
3+
config: 9a77fef7496c03df33fe53da4d761517
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

main/CHANGELOG.html

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Changelog &mdash; AtomVM 0.7.0-dev+git.ac69559b documentation</title>
9+
<title>Changelog &mdash; AtomVM 0.7.0-dev+git.179144b0 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
1212
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
@@ -17,7 +17,7 @@
1717
<link rel="canonical" href="https://doc.atomvm.org/main/CHANGELOG.html" />
1818
<script src="_static/jquery.js?v=5d32c60e"></script>
1919
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20-
<script src="_static/documentation_options.js?v=ff1032c2"></script>
20+
<script src="_static/documentation_options.js?v=3325ffd0"></script>
2121
<script src="_static/doctools.js?v=fd6eb6e6"></script>
2222
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
2323
<script src="_static/js/theme.js"></script>
@@ -264,6 +264,8 @@ <h3>Added<a class="headerlink" href="#added" title="Link to this heading"></a
264264
<li><p>Added option to set a custom callback for esp32 network driver
265265
<code class="docutils literal notranslate"><span class="pre">disconnected</span></code> events</p></li>
266266
<li><p>Added <code class="docutils literal notranslate"><span class="pre">network:sta_status/0</span></code> to get the current connection state of the sta interface.</p></li>
267+
<li><p>Added ESP32 <code class="docutils literal notranslate"><span class="pre">-DATOMVM_ELIXIR_SUPPORT=on</span></code> configuration option</p></li>
268+
<li><p>Added support for ESP32 development builds to include NVS partition data at build time</p></li>
267269
</ul>
268270
</section>
269271
<section id="changed">
@@ -290,6 +292,11 @@ <h3>Changed<a class="headerlink" href="#changed" title="Link to this heading">
290292
<li><p>Function arguments are added to stacktrace also for some NIFs, when one of the arguments is badarg</p></li>
291293
<li><p>Using a custom callback for STA disconnected events in esp32 network driver will stop automatic re-connect,
292294
allowing applications to use scan results or other means to decide when and where to connect.</p></li>
295+
<li><p>ESP32 cmake build options are now also exposed in <code class="docutils literal notranslate"><span class="pre">idf.py</span> <span class="pre">menuconfig</span></code>.</p></li>
296+
<li><p>ESP32 Elixir support is determined automatically from the offset of <code class="docutils literal notranslate"><span class="pre">boot.avm</span></code> in the partition
297+
table.</p></li>
298+
<li><p>ESP32 ports now flash a complete working image using the <code class="docutils literal notranslate"><span class="pre">idf.py</span> <span class="pre">flash</span></code> task.</p></li>
299+
<li><p>ESP32 platform now uses reproducible builds.</p></li>
293300
</ul>
294301
</section>
295302
<section id="fixed">

main/CODE_OF_CONDUCT.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Contributor Covenant Code of Conduct &mdash; AtomVM 0.7.0-dev+git.ac69559b documentation</title>
9+
<title>Contributor Covenant Code of Conduct &mdash; AtomVM 0.7.0-dev+git.179144b0 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
1212
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
@@ -17,7 +17,7 @@
1717
<link rel="canonical" href="https://doc.atomvm.org/main/CODE_OF_CONDUCT.html" />
1818
<script src="_static/jquery.js?v=5d32c60e"></script>
1919
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20-
<script src="_static/documentation_options.js?v=ff1032c2"></script>
20+
<script src="_static/documentation_options.js?v=3325ffd0"></script>
2121
<script src="_static/doctools.js?v=fd6eb6e6"></script>
2222
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
2323
<script src="_static/js/theme.js"></script>

main/CONTRIBUTING.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Contributing &mdash; AtomVM 0.7.0-dev+git.ac69559b documentation</title>
9+
<title>Contributing &mdash; AtomVM 0.7.0-dev+git.179144b0 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
1212
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
@@ -17,7 +17,7 @@
1717
<link rel="canonical" href="https://doc.atomvm.org/main/CONTRIBUTING.html" />
1818
<script src="_static/jquery.js?v=5d32c60e"></script>
1919
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20-
<script src="_static/documentation_options.js?v=ff1032c2"></script>
20+
<script src="_static/documentation_options.js?v=3325ffd0"></script>
2121
<script src="_static/doctools.js?v=fd6eb6e6"></script>
2222
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
2323
<script src="_static/js/theme.js"></script>

main/C_CODING_STYLE.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>AtomVM C Coding Style Guide (AVMCCS Guide) &mdash; AtomVM 0.7.0-dev+git.ac69559b documentation</title>
9+
<title>AtomVM C Coding Style Guide (AVMCCS Guide) &mdash; AtomVM 0.7.0-dev+git.179144b0 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
1212
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
@@ -17,7 +17,7 @@
1717
<link rel="canonical" href="https://doc.atomvm.org/main/C_CODING_STYLE.html" />
1818
<script src="_static/jquery.js?v=5d32c60e"></script>
1919
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20-
<script src="_static/documentation_options.js?v=ff1032c2"></script>
20+
<script src="_static/documentation_options.js?v=3325ffd0"></script>
2121
<script src="_static/doctools.js?v=fd6eb6e6"></script>
2222
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
2323
<script src="_static/js/theme.js"></script>

main/LICENSES/Apache-2.0.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>&lt;no title&gt; &mdash; AtomVM 0.7.0-dev+git.ac69559b documentation</title>
9+
<title>&lt;no title&gt; &mdash; AtomVM 0.7.0-dev+git.179144b0 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
1111
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=9edc463e" />
1212
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=4ae1632d" />
@@ -17,7 +17,7 @@
1717
<link rel="canonical" href="https://doc.atomvm.org/main/LICENSES/Apache-2.0.html" />
1818
<script src="../_static/jquery.js?v=5d32c60e"></script>
1919
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20-
<script src="../_static/documentation_options.js?v=ff1032c2"></script>
20+
<script src="../_static/documentation_options.js?v=3325ffd0"></script>
2121
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
2222
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
2323
<script src="../_static/js/theme.js"></script>

main/SECURITY.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Security Policy &mdash; AtomVM 0.7.0-dev+git.ac69559b documentation</title>
9+
<title>Security Policy &mdash; AtomVM 0.7.0-dev+git.179144b0 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
1212
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
@@ -17,7 +17,7 @@
1717
<link rel="canonical" href="https://doc.atomvm.org/main/SECURITY.html" />
1818
<script src="_static/jquery.js?v=5d32c60e"></script>
1919
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20-
<script src="_static/documentation_options.js?v=ff1032c2"></script>
20+
<script src="_static/documentation_options.js?v=3325ffd0"></script>
2121
<script src="_static/doctools.js?v=fd6eb6e6"></script>
2222
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
2323
<script src="_static/js/theme.js"></script>

main/UPDATING.html

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>AtomVM Update Instructions &mdash; AtomVM 0.7.0-dev+git.ac69559b documentation</title>
9+
<title>AtomVM Update Instructions &mdash; AtomVM 0.7.0-dev+git.179144b0 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
1212
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
@@ -17,7 +17,7 @@
1717
<link rel="canonical" href="https://doc.atomvm.org/main/UPDATING.html" />
1818
<script src="_static/jquery.js?v=5d32c60e"></script>
1919
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20-
<script src="_static/documentation_options.js?v=ff1032c2"></script>
20+
<script src="_static/documentation_options.js?v=3325ffd0"></script>
2121
<script src="_static/doctools.js?v=fd6eb6e6"></script>
2222
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
2323
<script src="_static/js/theme.js"></script>
@@ -113,6 +113,17 @@ <h2>v0.6.6 -&gt; Unreleased<a class="headerlink" href="#v0-6-6-unreleased" title
113113
<li><p><code class="docutils literal notranslate"><span class="pre">binary_to_integer</span></code> and <code class="docutils literal notranslate"><span class="pre">list_to_integer</span></code> do not raise <code class="docutils literal notranslate"><span class="pre">overflow</span></code> error anymore, they instead
114114
raise <code class="docutils literal notranslate"><span class="pre">badarg</span></code> when trying to parse an integer that exceeds 256 bits. Update any relevant error
115115
handling code.</p></li>
116+
<li><p>ESP32 builds with Elixir support may be configured without making changes to git-tracked files
117+
using <code class="docutils literal notranslate"><span class="pre">idf.py</span> <span class="pre">-DATOMVM_ELIXIR_SUPPORT=on</span> <span class="pre">set-target</span> <span class="pre">${CHIP}</span></code> instead of copying
118+
partitions-elixir.csv to partitions.csv. This configures the build to use partitions-elixir.csv for
119+
the partition table. The <code class="docutils literal notranslate"><span class="pre">main.avm</span></code> offset in the partition table will determine which flavor of
120+
esp32boot libraries to include for the <code class="docutils literal notranslate"><span class="pre">idf.py</span> <span class="pre">flash</span></code> task and the image assembled by
121+
<code class="docutils literal notranslate"><span class="pre">build/mkimage.sh</span></code>.</p></li>
122+
<li><p>ESP32 release builds may be configured with <code class="docutils literal notranslate"><span class="pre">idf.py</span> <span class="pre">-DATOMVM_RELEASE=on</span> <span class="pre">set-target</span> <span class="pre">${CHIP}</span></code>
123+
rather than copy sdkconfig.release-defaults.in to sdkconfig.defaults.in (which still requires a
124+
<code class="docutils literal notranslate"><span class="pre">reconfigure</span></code> or <code class="docutils literal notranslate"><span class="pre">set-target</span></code> to be run to pick up the changes), this may also be combined with the
125+
<code class="docutils literal notranslate"><span class="pre">ATOMVM_ELIXIR_SUPPORT</span></code> option. For example, an Elixir-supported release build is configured using:
126+
<code class="docutils literal notranslate"><span class="pre">idf.py</span> <span class="pre">-DATOMVM_ELIXIR_SUPPORT=on</span> <span class="pre">-DATOMVM_RELEASE=on</span> <span class="pre">set-target</span> <span class="pre">${CHIP}</span></code></p></li>
116127
</ul>
117128
</section>
118129
<section id="v0-6-4-v0-6-5">

main/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '0.7.0-dev+git.ac69559b',
2+
VERSION: '0.7.0-dev+git.179144b0',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

main/api-reference-documentation.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>API Reference Documentation &mdash; AtomVM 0.7.0-dev+git.ac69559b documentation</title>
9+
<title>API Reference Documentation &mdash; AtomVM 0.7.0-dev+git.179144b0 documentation</title>
1010
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
1111
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=9edc463e" />
1212
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
@@ -17,7 +17,7 @@
1717
<link rel="canonical" href="https://doc.atomvm.org/main/api-reference-documentation.html" />
1818
<script src="_static/jquery.js?v=5d32c60e"></script>
1919
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
20-
<script src="_static/documentation_options.js?v=ff1032c2"></script>
20+
<script src="_static/documentation_options.js?v=3325ffd0"></script>
2121
<script src="_static/doctools.js?v=fd6eb6e6"></script>
2222
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
2323
<script src="_static/js/theme.js"></script>

0 commit comments

Comments
 (0)