1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-16 18:13:49 +01:00

Merge pull request #21773 from LasseRosenow/guides-remove-managing-a-release-toc

doc/guides: remove toc from managing a release and fix using timers guide
This commit is contained in:
crasbe 2025-10-10 08:59:10 +00:00 committed by GitHub
commit 355e5f41f8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 3 additions and 15 deletions

View File

@ -50,7 +50,7 @@ also use soon. Using `ztimer_sleep(ZTIMER_SEC, 5);` we simply wait for around
But what if we want to do something else while waiting for the timer to expire? But what if we want to do something else while waiting for the timer to expire?
Let's take a closer look at how we can use timers in RIOT. Let's take a closer look at how we can use timers in RIOT.
### Step 1: Creating a Callback ## Step 2: Creating a Callback
Timers are a way to schedule tasks to be executed at a later time. Timers are a way to schedule tasks to be executed at a later time.
In RIOT, you have to tell the timers two things: In RIOT, you have to tell the timers two things:
@ -76,7 +76,7 @@ and prints the string to the console. Congrats, you have created a callback func
now all that is left is to create the timer and schedule it. now all that is left is to create the timer and schedule it.
To do that lets restructure our `main` function to use the timer. To do that lets restructure our `main` function to use the timer.
### Step 2: Scheduling the Timer ## Step 3: Scheduling the Timer
Go into your `main` function and include the following code: Go into your `main` function and include the following code:
@ -102,7 +102,7 @@ This code tells the timer to fire in 3 seconds.
The first argument specifies which type of clock we want to use, The first argument specifies which type of clock we want to use,
the second argument is the timer we created, and the third argument is the time in seconds. the second argument is the timer we created, and the third argument is the time in seconds.
### Step 3: Running the Program ## Step 4: Running the Program
Now that we have created the timer and scheduled it, we can run the program. Now that we have created the timer and scheduled it, we can run the program.
Compile the program using `make` and flash it to your board using `make flash`. Compile the program using `make` and flash it to your board using `make flash`.

View File

@ -3,18 +3,6 @@ title: Managing a Release
description: This page describes the process of managing a release. description: This page describes the process of managing a release.
--- ---
## Contents
1. [Checklist](#1-checklist)
2. [Preparation](#2-preparation)
3. [Feature Freeze and Testing](#3-feature-freeze-and-testing)
4. [Drafting Release Notes](#4-drafting-release-notes)
5. [Actual Release](#5-actual-release)
6. [Other Repositories](#6-other-repositories)
7. [Important Fixes after Release](#7-important-fixes-after-release)
8. [Resources](#8-resources)
9. [Forum Post Templates](#9-forum-post-templates)
## 1. Checklist ## 1. Checklist
Steps marked with a :scroll: icon can also be automated with the release manager script. Steps marked with a :scroll: icon can also be automated with the release manager script.