This is an automated email from the ASF dual-hosted git repository.
janc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-core.git
The following commit(s) were added to refs/heads/master by this push:
new cb10a2fef documentation/sphinx: Fix formatting errors in `.rst` files
cb10a2fef is described below
commit cb10a2fef029178c4ba32eca6c2fe682db02bb54
Author: Wojciech Pietraszewski <[email protected]>
AuthorDate: Tue Sep 17 11:50:08 2024 +0200
documentation/sphinx: Fix formatting errors in `.rst` files
Fixes broken references to other documents/sections.
Moves remaining tutorials to the `mynewt-documentation` repository.
---
docs/os/modules/baselibc.rst | 2 +-
docs/os/modules/hal/hal_i2c/hal_i2c.rst | 3 +-
docs/os/tutorials/STM32F303.rst | 186 --------------------------------
docs/os/tutorials/pin-wheel-mods.rst | 106 ------------------
4 files changed, 2 insertions(+), 295 deletions(-)
diff --git a/docs/os/modules/baselibc.rst b/docs/os/modules/baselibc.rst
index 0f6ce1fbd..e165e163c 100644
--- a/docs/os/modules/baselibc.rst
+++ b/docs/os/modules/baselibc.rst
@@ -47,7 +47,7 @@ List of Functions
Documentation for libc functions is available from multiple places. One
example are the on-line manual pages at
-`https://www.freebsd.org/cgi/man.cgi <#https://www.freebsd.org/cgi/man.cgi>`__.
+`FreeBSD website <https://www.freebsd.org/cgi/man.cgi>`_.
baselibc supports most libc functionality; malloc(), printf-family,
string handling, and conversion routines.
diff --git a/docs/os/modules/hal/hal_i2c/hal_i2c.rst
b/docs/os/modules/hal/hal_i2c/hal_i2c.rst
index d6c2e1b39..f9a1959e9 100644
--- a/docs/os/modules/hal/hal_i2c/hal_i2c.rst
+++ b/docs/os/modules/hal/hal_i2c/hal_i2c.rst
@@ -13,8 +13,7 @@ board and often peripherals devices located off the circuit
board.
I2C is often though of as a 2-wire protocol because it uses two wires
(SDA, SCL) to send data between devices.
-For a detailed description of I2C, see the `I²C wikipedia
-page <https://en.wikipedia.org/wiki/I²C>`__
+For a detailed description of I²C, see the `wikipedia page
<https://en.wikipedia.org/wiki/I2C>`_
HAL\_I2C Theory Of Operation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/os/tutorials/STM32F303.rst b/docs/os/tutorials/STM32F303.rst
deleted file mode 100644
index 7ee46fac2..000000000
--- a/docs/os/tutorials/STM32F303.rst
+++ /dev/null
@@ -1,186 +0,0 @@
-Blinky, your "Hello World!", on STM32F303 Discovery
----------------------------------------------------
-
-Objective
-~~~~~~~~~
-
-Learn how to use packages from a default application repository of
-Mynewt to build your first *Hello World* application (Blinky) on a
-target board. Once built using the *newt* tool, this application will
-blink the LED lights on the target board.
-
-Create a project with a simple app that blinks an LED on the stmf303
-discovery board. In the process import some external libraries into your
-project. Download the application to the target and watch it blink!
-
-What you need
-~~~~~~~~~~~~~
-
-- Discovery kit with STM32F303VC MCU
-- Laptop running Mac OSX.
-- It is assumed you have already installed newt tool.
-- It is assumed you already installed native tools as described
- `here <../get_started/native_tools.html>`__
-
-Also, we assume that you're familiar with UNIX shells. Let's gets
-started!
-
-Create a project
-~~~~~~~~~~~~~~~~
-
-Create a new project to hold your work. For a deeper understanding, you
-can read about project creation in `Get Started -- Creating Your First
-Project <../get_started/project_create.html>`__ or just follow the
-commands below.
-
-If you've already created a project from another tutorial, you can
-re-use that project.
-
-::
-
- $ mkdir ~/dev
- $ cd ~/dev
- $ newt new myproj
- Downloading project skeleton from apache/incubator-mynewt-blinky...
- Installing skeleton in myproj...
- Project myproj successfully created.
-
- $ cd myproj
-
-**Note:** Don't forget to change into the ``myproj`` directory.
-
-Install dependencies
-~~~~~~~~~~~~~~~~~~~~
-
-Now you can install this into the project using:
-
-::
-
- $ newt install -v
- Downloading repository description for apache-mynewt-core... success!
- ...
- apache-mynewt-core successfully installed version 0.7.9-none
- ...
- Downloading repository description for mynewt_stm32f3... success!
- Downloading repository mynewt_stm32f3
- ...
- Resolving deltas: 100% (65/65), done.
- Checking connectivity... done.
- mynewt_stm32f3 successfully installed version 0.0.0-none
-
-Create targets
-~~~~~~~~~~~~~~
-
-Create two targets to build using the stmf3 board support package and
-the app blinky example from mynewt. The output of these commands are not
-shown here for brevity.
-
-The first target is the application image itself. The second target is
-the bootloader which allows you to upgrade your mynewt applications.
-
-::
-
- $ newt target create stmf3_blinky
- $ newt target set stmf3_blinky build_profile=optimized
- $ newt target set stmf3_blinky
bsp=@apache-mynewt-core/hw/bsp/stm32f3discovery
- $ newt target set stmf3_blinky app=apps/blinky
-
- $ newt target create stmf3_boot
- $ newt target set stmf3_boot app=@mcuboot/boot/mynewt
- $ newt target set stmf3_boot
bsp=@apache-mynewt-core/hw/bsp/stm32f3discovery
- $ newt target set stmf3_boot build_profile=optimized
-
- $ newt target show
-
- targets/stmf3_blinky
- app=apps/blinky
- bsp=@apache-mynewt-core/hw/bsp/stm32f3discovery
- build_profile=optimized
- targets/stmf3_boot
- app=@mcuboot/boot/mynewt
- bsp=@apache-mynewt-core/hw/bsp/stm32f3discovery
- build_profile=optimized
-
-Build the target executables
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-To build the images, use the ``newt build`` command below.
-
-::
-
- $ newt build stmf3_blinky
- ...
- Archiving stm32f3discovery.a
- Linking blinky.elf
- App successfully built:
~/dev/myproj/bin/stmf3_blinky/apps/blinky/blinky.elf
-
- $ newt build stmf3_boot
- Compiling log_shell.c
- Archiving log.a
- Linking boot.elf
- App successfully built: ~/dev/myproj/bin/stmf3_boot/apps/boot/boot.elf
-
-Sign and create the blinky application image
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-You must sign and version your application image to download it using
-newt. Use the ``newt create-image`` command to perform this action. Here
-we assign this image an arbitrary version ``1.2.3``.
-
-.. code-block:: console
-
- $ newt create-image stmf3_blinky 1.2.3
- App image successfully generated:
~/dev/myproj/bin/stmf3_blinky/apps/blinky/blinky.img
- Build manifest:~/dev/myproj/bin/stmf3_blinky/apps/blinky/manifest.json
-
-Configure the hardware
-~~~~~~~~~~~~~~~~~~~~~~
-
-The STM32F3DISCOVERY board includes an ST-LINK/V2 embedded debug tool
-interface that will be used to program/debug the board. To program the
-MCU on the board, simply plug in the two jumpers on CN4, as shown in the
-picture in red. If you want to learn more about the board you will find
-the User Manual at
-http://www.st.com/st-web-ui/static/active/jp/resource/technical/document/user_manual/DM00063382.pdf
-
-- |STMdiscovery|
-
-Download the Images
-~~~~~~~~~~~~~~~~~~~
-
-Use the ``newt load`` command to download the images to the target
-board.
-
-::
-
- $ newt -v load stmf3_boot
- $ newt -v load stmf3_blinky
-
-Watch the LED blink
-~~~~~~~~~~~~~~~~~~~
-
-Congratulations! You have built, downloaded, and run your first
-application using mynewt for the stm32f3 discovery board. One of the
-LEDs on the LED wheel should be blinking at 1 Hz.
-
-Want more?
-~~~~~~~~~~
-
-Want to make your board do something a little more exciting with the
-LEDs? Then try making the modifications to the Blinky app to make it a
-`pin-wheel app <pin-wheel-mods.html>`__ and you can light all the LEDs in
-a pin-wheel fashion.
-
-We have more fun tutorials for you to get your hands dirty. Be bold and
-try other Blinky-like `tutorials <../tutorials/nRF52.html>`__ or try
-enabling additional functionality such as `remote
-comms <project-slinky.html>`__ on the current board.
-
-If you see anything missing or want to send us feedback, please do so by
-signing up for appropriate mailing lists on our `Community
-Page <../../community.html>`__.
-
-Keep on hacking and blinking!
-
-.. |STMdiscovery| image:: pics/STM32f3discovery_connector.png
-
diff --git a/docs/os/tutorials/pin-wheel-mods.rst
b/docs/os/tutorials/pin-wheel-mods.rst
deleted file mode 100644
index 3bc104186..000000000
--- a/docs/os/tutorials/pin-wheel-mods.rst
+++ /dev/null
@@ -1,106 +0,0 @@
-Pin Wheel Modifications to "Blinky" on STM32F3 Discovery
---------------------------------------------------------
-
-Objective
-~~~~~~~~~~~~~~~
-
-
-Learn how to modify an existing app -- the `blinky <STM32F303.html>`__ app
--- to light all the LEDs on the STM32F3 Discovery board.
-
-What you need
-~~~~~~~~~~~~~
-
-- Discovery kit with STM32F303VC MCU
-- Laptop running Mac OSX.
-- It is assumed you have already installed and run the
- `blinky <STM32F303.html>`__ app succesfully.
-
-Since you've already successfully created your blinky app project,
-you'll need to modify only one file, main.c, in order to get this app
-working.
-
-The main.c file resides in the apps/blinky/src directory in your project
-folder so you can edit it with your favorite editor. You'll make the
-following changes:
-
-Replace the line:
-
-.. code:: c
-
- int g_led_pin;
-
-With the line:
-
-.. code:: c
-
- int g_led_pins[8] = {LED_BLINK_PIN_1, LED_BLINK_PIN_2, LED_BLINK_PIN_3,
LED_BLINK_PIN_4, LED_BLINK_PIN_5, LED_BLINK_PIN_6, LED_BLINK_PIN_7,
LED_BLINK_PIN_8};
-
-So that you now have an array of all 8 LED Pins on the board.
-
-Delete the line:
-
-.. code:: c
-
- g_led_pin = LED_BLINK_PIN;
-
-And in its place, add the following lines to initialize all the
-LED\_PINS correctly:
-
-.. code:: c
-
- int x;
- for(x = 0; x < 8; x++){
- hal_gpio_init_out(g_led_pins[x], 1);
- }
- int p = 0;
-
-We'll use that 'p' later. Next you'll want to change the line:
-
-.. code:: c
-
- os_time_delay(1000);
-
-to a shorter time in order to make it a little more interesting. A full
-1 second delay doesn't look great, so try 100 for starters and then you
-can adjust it to your liking.
-
-Finally, change the line:
-
-.. code:: c
-
- hal_gpio_toggle(g_led_pin);
-
-to look like this:
-
-.. code:: c
-
- hal_gpio_toggle(g_led_pins[p++]);
- p = (p > 7) ? 0 : p;
-
-Build the target and executables and download the images
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Run the same commands you used on the blinky app to build and load this
-one:
-
-.. code-block:: console
-
- $ newt create-image stmf3_blinky 1.2.3
- App image successfully generated:
~/dev/myproj/bin/stmf3_blinky/apps/blinky/blinky.img
- Build manifest:~/dev/myproj/bin/stmf3_blinky/apps/blinky/manifest.json
- $ newt -v load stmf3_boot
- $ newt -v load stmf3_blinky
-
-Watch the LEDs go round and round
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The colored LEDs should now all light up in succession, and once they're
-all lit, they should then go off in the same order. This should repeat
-continuously.
-
-If you see anything missing or want to send us feedback, please do so by
-signing up for appropriate mailing lists on our `Community
-Page <../../community.html>`__.
-
-Keep on hacking and blinking!
