Skip to content

Commit aa0c85b

Browse files
committed
Forward port changes from v0.6 release branch
Merge fixes to other links to documentation (use doc.atomvm.org).
2 parents 10429ba + 425e02a commit aa0c85b

File tree

5 files changed

+18
-18
lines changed

5 files changed

+18
-18
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ C source modules (`.c`) should be organized as follows:
169169

170170
#### Documentation
171171

172-
[Doxygen Javadoc style](https://www.doxygen.nl/manual/docblocks.html) code comments will be picked up and added to the documentation. Changes will automatically be added to the [libAtomVM Source Files](https://www.atomvm.net/doc/main/c_api_docs.html#libatomvm-source-files) and the [libAtomVM Index](https://www.atomvm.net/doc/main/apidocs/libatomvm/index.html#libatomvm-index). But to have `Data Structures`, `Types`, `MACROS`, and `Functions` appear in the correct C Library APIs section the corresponding entries must be added to the similarly named `*.rst` files in the `AtomVM/doc/src/apidocs/libatomvm/` directory. The exact names of the files that need to be altered are: `data_structures.rst`, `functions.rst`, `macros.rst`, and `types.rst`. The other files in the directory handle auto`generated content and do not need to be altered.
172+
[Doxygen Javadoc style](https://www.doxygen.nl/manual/docblocks.html) code comments will be picked up and added to the documentation. Changes will automatically be added to the [libAtomVM Source Files](https://doc.atomvm.org/main/apidocs/libatomvm/index.html#libatomvm-source-files) and the [libAtomVM Index](https://doc.atomvm.org/main/apidocs/libatomvm/index.html#libatomvm-index). But to have `Data Structures`, `Types`, `MACROS`, and `Functions` appear in the correct C Library APIs section the corresponding entries must be added to the similarly named `*.rst` files in the `AtomVM/doc/src/apidocs/libatomvm/` directory. The exact names of the files that need to be altered are: `data_structures.rst`, `functions.rst`, `macros.rst`, and `types.rst`. The other files in the directory handle auto`generated content and do not need to be altered.
173173

174174
In the rare case that a function declaration and definition are both in different header files (rather than the definition in a `*.c` file) this can cause rendering errors for `Doxygen`. The work around for these cases can be demonstrated with this example for the function `sys_listener_destroy` it is documented and declared in `sys.h` and defined as follows in `listeners.h`:
175175

README.Md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,21 @@ AtomVM implements from scratch a minimal Erlang VM that supports a subset of Erl
1515
Supported Platforms
1616
===================
1717

18-
* Linux, macOS, FreeBSD, DragonFly ([generic_unix](https://www.atomvm.net/doc/main/getting-started-guide.html#getting-started-on-the-generic-unix-platform))
19-
* ESP32 SoC (with IDF/FreeRTOS, see [esp32](https://www.atomvm.net/doc/main/getting-started-guide.html#getting-started-on-the-esp32-platform))
20-
* STM32 MCUs (with LibOpenCM3, see [stm32](https://www.atomvm.net/doc/main/getting-started-guide.html#getting-started-on-the-stm32-platform))
21-
* Raspberry Pi Pico and Pico 2 (see [rp2](https://www.atomvm.net/doc/main/getting-started-guide.html#getting-started-on-the-raspberry-pi-pico-platform))
22-
* Browsers and NodeJS with WebAssembly (see [emscripten](https://www.atomvm.net/doc/main/getting-started-guide.html#getting-started-with-atomvm-webassembly))
18+
* Linux, macOS, FreeBSD, DragonFly ([generic_unix](https://doc.atomvm.org/main/getting-started-guide.html#getting-started-on-the-generic-unix-platform))
19+
* ESP32 SoC (with IDF/FreeRTOS, see [esp32](https://doc.atomvm.org/main/getting-started-guide.html#getting-started-on-the-esp32-platform))
20+
* STM32 MCUs (with LibOpenCM3, see [stm32](https://doc.atomvm.org/main/getting-started-guide.html#getting-started-on-the-stm32-platform))
21+
* Raspberry Pi Pico and Pico 2 (see [rp2](https://doc.atomvm.org/main/getting-started-guide.html#getting-started-on-the-raspberry-pi-pico-platform))
22+
* Browsers and NodeJS with WebAssembly (see [emscripten](https://doc.atomvm.org/main/getting-started-guide.html#getting-started-with-atomvm-webassembly))
2323

2424
AtomVM aims to be easily portable to new platforms with a minimum effort, so additional platforms
2525
might be supported in a near future.
2626

2727
Getting Started
2828
===============
2929
There is much more information, including a more complete
30-
["Getting Started Guide"](https://www.atomvm.net/doc/main/getting-started-guide.html),
30+
["Getting Started Guide"](https://doc.atomvm.org/main/getting-started-guide.html),
3131
[examples](https://www.atomvm.net/sample-code),
32-
detailed [build instructions](https://www.atomvm.net/doc/main/build-instructions.html),
32+
detailed [build instructions](https://doc.atomvm.org/main/build-instructions.html),
3333
and [contact information](https://www.atomvm.net/contact) available on the
3434
[AtomVM](https://atomvm.net) project website.
3535

@@ -66,14 +66,14 @@ $ make
6666
$ ./src/AtomVM ./examples/erlang/hello_world.avm
6767
```
6868

69-
Complete [Build Instructions](https://www.atomvm.net/doc/main/build-instructions.html) are
69+
Complete [Build Instructions](https://doc.atomvm.org/main/build-instructions.html) are
7070
available in the documentation for
71-
[Generic UNIX](https://www.atomvm.net/doc/main/build-instructions.html) (Linux, MacOS, FreeBSD, DragonFly),
72-
[ESP32](https://www.atomvm.net/doc/main/build-instructions.html#building-for-esp32),
73-
[STM32](https://www.atomvm.net/doc/main/build-instructions.html#building-for-stm32),
74-
[Raspberry Pi Pico and Pico 2](https://www.atomvm.net/doc/main/build-instructions.html#building-for-raspberry-pi-pico)
71+
[Generic UNIX](https://doc.atomvm.org/main/build-instructions.html) (Linux, MacOS, FreeBSD, DragonFly),
72+
[ESP32](https://doc.atomvm.org/main/build-instructions.html#building-for-esp32),
73+
[STM32](https://doc.atomvm.org/main/build-instructions.html#building-for-stm32),
74+
[Raspberry Pi Pico and Pico 2](https://doc.atomvm.org/main/build-instructions.html#building-for-raspberry-pi-pico)
7575
(rp2), and
76-
[WASM](https://www.atomvm.net/doc/main/build-instructions.html#building-for-nodejs-web) (NodeJS/Web).
76+
[WASM](https://doc.atomvm.org/main/build-instructions.html#building-for-nodejs-web) (NodeJS/Web).
7777

7878
Project Status
7979
==============
@@ -82,7 +82,7 @@ Project Status
8282

8383
AtomVM is no longer just a prototype — it has reached a solid level of compatibility with the BEAM
8484
ecosystem. It can execute unmodified, compiled BEAM modules, and most
85-
[core standard library functions](https://www.atomvm.net/doc/main/api-reference-documentation.html)
85+
[core standard library functions](https://doc.atomvm.org/main/api-reference-documentation.html)
8686
are already supported.
8787

8888
AtomVM is tested with code compiled with any version from OTP 21 to 27 (28 is supported only in `main` branch).

src/platforms/esp32/test/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ AtomVM provides two paths for testing "on device", the locally run QEMU emulator
1010

1111
# QEMU emulator testing
1212

13-
Instructions for running the tests [on QEMU are documented here](https://www.atomvm.net/doc/main/build-instructions.html#running-tests-for-esp32).
13+
Instructions for running the tests [on QEMU are documented here](https://doc.atomvm.org/main/build-instructions.html#running-tests-for-esp32).
1414

1515
# Wokwi CI simulator testing
1616

src/platforms/esp32/tools/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,5 +64,5 @@ file(COPY ${CMAKE_BINARY_DIR}/${CMAKE_FILES_DIRECTORY}/flash.sh
6464

6565
if (NOT EXISTS ../../../../build/libs/esp32boot/esp32boot.avm)
6666
message(WARNING "A generic_unix build must be done first in the top level AtomVM/build directory! \n\
67-
Consult https://www.atomvm.net/doc/main/build-instructions.html for build instructions.")
67+
Consult https://doc.atomvm.org/main/build-instructions.html for build instructions.")
6868
endif()

tools/test/smoke-test/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ Your ESP32 device is now flashed with the ESP32 image you specified.
151151

152152
The [`atomvm_examples`](https://github.com/atomvm/atomvm_examples) repo is a good place to start smoke testing. We assume you know how to clone this repo using git.
153153

154-
Note that you will need a supported OTP version and at least a recent version of the [rebar3](https://rebar3.org) tool. If you want to smoke test Elixir programs, you should also have a comaptible version of the Elixir compiler and runtime available. Consult the AtomVM [Relaase Notes](https://www.atomvm.net/doc/main/release-notes.html) for compatibility information.
154+
Note that you will need a supported OTP version and at least a recent version of the [rebar3](https://rebar3.org) tool. If you want to smoke test Elixir programs, you should also have a comaptible version of the Elixir compiler and runtime available. Consult the AtomVM [Release Notes](https://doc.atomvm.org/main/release-notes.html) for compatibility information.
155155

156156
To run an example program, `cd` into the appropriate example directory, and build and flash the program. We will show an example with the [`hello_world`](https://github.com/atomvm/atomvm_examples/tree/master/erlang/hello_world) program.
157157

0 commit comments

Comments
 (0)