Commit graph

1557 commits

Author SHA1 Message Date
Henrik Tjäder
532765719f docs: make mdBook emit error codes 2022-02-09 17:45:52 +01:00
Gabriel Górski
44f994dea2 Add a remark about Sync and Send traits requirement for resources 2022-02-08 19:25:24 +01:00
bors[bot]
ab26a1e185
Merge #602
602: book: Restore accidentally removed files r=korken89 a=AfoHT

- book: Restore accidentally removed files
- Update changelog


Co-authored-by: Henrik Tjäder <henrik@grepit.se>
2022-02-08 18:09:45 +00:00
Henrik Tjäder
7af09cb126 book: Restore accidentally removed files 2022-02-08 19:08:29 +01:00
bors[bot]
5adee8d3f9
Merge #601
601: Make bors run r=AfoHT a=korken89



Co-authored-by: Emil Fresk <emil.fresk@gmail.com>
2022-02-07 08:30:32 +00:00
Emil Fresk
d161938138 Make bors run 2022-02-07 09:28:47 +01:00
bors[bot]
84a8225d11
Merge #599
599: Docs: SW and HW tasks r=korken89 a=AfoHT

Reword and (hopefully) clarify SW and HW tasks

Closes #576


Co-authored-by: Henrik Tjäder <henrik@grepit.se>
2022-02-07 07:57:11 +00:00
bors[bot]
3bb41ab039
Merge #598
598: CONTRIBUTION.md now includes CI prep. r=korken89 a=AfoHT

Split out from Per’s previous work in `lockall` branch with some minor updates


Co-authored-by: Per Lindgren <per.lindgren@ltu.se>
2022-02-07 07:52:36 +00:00
Henrik Tjäder
a39d306649 Docs: SW and HW tasks 2022-02-05 13:38:01 +01:00
Per Lindgren
9c559df22e CONTRIBUTION.md now includes CI prep. 2022-02-05 12:45:36 +01:00
bors[bot]
9f8248a0c9
Merge #593
593: RTIC macro expansion: Try to find target-dir r=korken89 a=AfoHT

Seems over-engineered, but for projects where 

```
[build]
target-dir = "target"
```
is set to anything other than default `target` RTIC did simply not produce any `rtic-expansion.rs`.

This changes the approach to not giving up if not finding `target/` by looking at `OUT_DIR` and traversing back until `TARGET` is found.

As the `TARGET` target-triple variable is not available, approximate the `TARGET` folder (found in `target-dir`) with `s.starts_with("thumbv")`.

`target-dir` as set in `.cargo/config` will now be the parent directory of the `Path` ending with `TARGET`

## Example running with default target:
```
cortex-m-rtic on  expansionoutdir [$!?] is 📦 v1.0.0 via R v1.58.0 took 4s
❯ cargo build --example spawn --target thumbv7em-none-eabihf
OUT_DIR
"/home/henrik/rust/rtic/cortex-m-rtic/target/thumbv7em-none-eabihf/debug/build/cortex-m-rtic-5bd81e8412a790d5/out"

target/ exists

Write file:
target/rtic-expansion.rs

    Finished dev [unoptimized + debuginfo] target(s) in 7.20s

```

## Contrived example
With `.cargo/config` containing:

```
[build]
target-dir = "/tmp/cargothingy/../rust/./target/cargo"`
```

```
cortex-m-rtic on  expansionoutdir [$!?] is 📦 v1.0.0 via R v1.58.0 took 3s
❯ cargo build --example spawn --target thumbv7em-none-eabihf
OUT_DIR
"/tmp/cargothingy/../rust/./target/cargo/thumbv7em-none-eabihf/debug/build/cortex-m-rtic-5bd81e8412a790d5/out"
"/tmp/cargothingy/../rust/./target/cargo"

Write file:
/tmp/cargothingy/../rust/./target/cargo/rtic-expansion.rs

    Finished dev [unoptimized + debuginfo] target(s) in 6.42s

```

## Less extreme with relative paths
```
[build]
target-dir = "../../cargothingy/target/buildfiles/and-stuff"
```

```
OUT_DIR
"/home/henrik/rust/rtic/cortex-m-rtic/../../cargothingy/target/buildfiles/and-stuff/thumbv7em-none-eabihf/debug/build/cortex-m-rtic-5bd81e8412a790d5/out"
"/home/henrik/rust/rtic/cortex-m-rtic/../../cargothingy/target/buildfiles/and-stuff"

Write file:
/home/henrik/rust/rtic/cortex-m-rtic/../../cargothingy/target/buildfiles/and-stuff/rtic-expansion.rs

    Finished dev [unoptimized + debuginfo] target(s) in 6.78s

```

Note: If the user creates a folder named target in the same directory where `Cargo.toml`/crate root is, that will be used for storing the expansion.

```
<...>
OUT_DIR
"/home/henrik/rust/rtic/cortex-m-rtic/../../cargothingy/target/buildfiles/and-stuff/thumbv7em-none-eabihf/debug/build/cortex-m-rtic-5bd81e8412a790d5/out"

target/ exists

Write file:
target/rtic-expansion.rs

    Finished dev [unoptimized + debuginfo] target(s) in 6.62s
```


Co-authored-by: Henrik Tjäder <henrik@grepit.se>
2022-02-05 09:52:26 +00:00
bors[bot]
686cfa066a
Merge #595
595: Update tips_monotonic_impl.md r=AfoHT a=jordens

* There is no RTIC 0.6, only several RCs.
* Timers without interrupts (like the DWT cycle counter alone) will not be useful for `Monotonic` impls.
* Clarified some of the descriptions of the various implementations.

Close #597 
Close #594

Co-authored-by: Robert Jördens <rj@quartiq.de>
2022-02-04 19:26:05 +00:00
Robert Jördens
b855c1bc9b add changelog entry 2022-02-04 20:09:32 +01:00
Robert Jördens
c83a69599a
use permalinks for (currently broken) mono links 2022-02-04 11:25:34 +01:00
Robert Jördens
c7f6e924dc
Update tips_monotonic_impl.md
* There is no RTIC 0.6, only several RCs.
* Timers without interrupts (like the DWT cycle counter alone) will not be useful for `Monotonic` impls.
* Clarified some of the descriptions of the various implementations.
2022-02-03 12:58:50 +01:00
Henrik Tjäder
9f54b4aca8 RTIC macro expansion: Try to find target-dir 2022-01-28 21:21:06 +01:00
bors[bot]
c3c75f2200
Merge #591
591: Fix running command examples in chapter 1.5.5 Monotonic r=AfoHT a=GreenPenguino

Run the right examples in chapter 1.5.5 in the book

Co-authored-by: Erik <erik_97@live.nl>
2022-01-24 15:11:45 +00:00
Erik
2b07e3e0dc Fix running command examples in chapter 1.5.5 Monotonic 2022-01-24 12:27:42 +01:00
bors[bot]
69cacd0597
Merge #588
588: Highlight how to run examples locally r=perlindgren a=AfoHT

How examples are run never gets properly introduced before used in `by-example/resources.md`

Fixes #587 

Co-authored-by: Henrik Tjäder <henrik@grepit.se>
2022-01-22 22:07:37 +00:00
Henrik Tjäder
a34f0205b3 Highlight how to run examples locally 2022-01-21 13:28:14 +01:00
bors[bot]
d51aaf3ad3
Merge #584
584: mq/minor corrections r=korken89 a=mareq



Co-authored-by: Mareq Balint <mareq@balint.eu>
2022-01-08 06:19:22 +00:00
bors[bot]
4a16310443
Merge #585
585: Fix the locals.rs comment r=korken89 a=keadwen

I believe that is a typo s/shared/local_to_bar

Co-authored-by: Jakub Młynarczyk <jkbmlynarczyk@gmail.com>
2022-01-08 06:14:24 +00:00
Jakub Młynarczyk
20f1c396d5
Fix the locals.rs comment
I believe that is a typo s/shared/local_to_bar
2022-01-08 16:36:59 +11:00
Mareq Balint
ce6e014cf0
Correct grammar in 1.5.2 Software tasks & spawn 2022-01-07 22:33:23 +00:00
Mareq Balint
3da25c75cf
Correct wording in 1.2 Resource usage 2022-01-07 22:31:30 +00:00
bors[bot]
2c921ac67c
Merge #580
580: Spawn at periodic r=korken89 a=perlindgren

Examples on drift free usage under RTIC 1.0.

Co-authored-by: Per Lindgren <per.lindgren@ltu.se>
2022-01-06 14:20:20 +00:00
Per Lindgren
305e8295d5 Drift free timing examples 2022-01-04 22:21:57 +01:00
bors[bot]
dcba1a55dd
Merge #579
579: CI: Add link to HackMD to rtic.rs/meeting/ r=perlindgren a=AfoHT



Co-authored-by: Henrik Tjäder <henrik@grepit.se>
2022-01-04 18:42:03 +00:00
Henrik Tjäder
fcc412dfb9 CI: Add link to HackMD to rtic.rs/meeting/ 2022-01-04 19:38:57 +01:00
bors[bot]
8cff6827d1
Merge #577
577: Added changelog enforcer r=perlindgren a=korken89



Co-authored-by: Emil Fresk <emil.fresk@gmail.com>
2022-01-03 17:45:50 +00:00
Emil Fresk
5d645b1311 Added changelog enforcer 2022-01-03 18:37:54 +01:00
bors[bot]
f990268147
Merge #573
573: Improved docs on where the 12 MHz comes from in SysTick r=perlindgren a=korken89



Co-authored-by: Emil Fresk <emil.fresk@gmail.com>
2021-12-26 11:43:54 +00:00
Emil Fresk
7bec234766 Improved docs on where the 12 MHz comes from in SysTick 2021-12-26 11:42:14 +01:00
bors[bot]
5a4bcae1fb
Merge #572
572: cargo xtask is now ~40x faster r=AfoHT a=korken89



Co-authored-by: Emil Fresk <emil.fresk@gmail.com>
2021-12-26 10:26:45 +00:00
Emil Fresk
ef4e4aaaa3 cargo xtask is now ~40x faster 2021-12-26 11:05:35 +01:00
bors[bot]
3a1d42b614
Merge #571
571: Added nRF52 RTC based monotonic to the book r=AfoHT a=korken89



Co-authored-by: Emil Fresk <emil.fresk@gmail.com>
2021-12-26 09:46:46 +00:00
Emil Fresk
68fb811a11 Added nRF52 RTC based monotonic to the book 2021-12-26 10:19:04 +01:00
bors[bot]
d8746d669b
Merge #569
569: README: Remove rustc badge and Requirements r=korken89 a=perlindgren

Remove rustc badge and requirements to edition 2018.

Co-authored-by: Per Lindgren <per.lindgren@ltu.se>
Co-authored-by: Emil Fresk <emil.fresk@gmail.com>
2021-12-26 09:15:17 +00:00
Emil Fresk
19551d50e0
Update README.md
Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
2021-12-26 10:14:17 +01:00
Per Lindgren
bd38a4a0cc README: User documentation 2021-12-25 19:37:42 +01:00
bors[bot]
be25fdf621
Merge #568
568: Docfix: remove pre-release note r=AfoHT a=perlindgren



Co-authored-by: Per Lindgren <per.lindgren@ltu.se>
2021-12-25 17:38:22 +00:00
Per Lindgren
887b068611 README: Remove rustc badge and Requirements 2021-12-25 18:37:29 +01:00
Per Lindgren
28cf223bfd Docfix: MSRV and Semantic Versioning 2021-12-25 18:15:41 +01:00
Per Lindgren
53306b1a7b Docfix: remove pre-release note 2021-12-25 17:59:19 +01:00
bors[bot]
152955c18a
Merge #567
567: Promote v1.0 in docs r=korken89 a=AfoHT



Co-authored-by: Henrik Tjäder <henrik@grepit.se>
2021-12-25 15:24:00 +00:00
Henrik Tjäder
2d8252f3e5 Promote v1.0 in docs 2021-12-25 16:18:28 +01:00
bors[bot]
bc883e393d
Merge #565 #566
565: Edition: Bump to 2021 r=korken89 a=AfoHT



566: v1.0.0 r=korken89 a=AfoHT

This should fail building until all deps are released and accessible on crates.io

(There are some required PRs for edition2021 for each repo, alternatively just bringing in the v1.0 PR should have commits included, we can drop the extra PRs later on)

https://github.com/rtic-rs/rtic-monotonic/pull/6
https://github.com/rtic-rs/rtic-core/pull/22
https://github.com/rtic-rs/rtic-syntax/pull/68


Co-authored-by: Henrik Tjäder <henrik@grepit.se>
2021-12-25 15:05:26 +00:00
bors[bot]
b74ca90f60
Merge #564
564: Clippy lints r=korken89 a=AfoHT



Co-authored-by: Henrik Tjäder <henrik@grepit.se>
2021-12-25 14:58:30 +00:00
Henrik Tjäder
2b90cd3433 Bump version to 1.0.0 2021-12-25 14:59:27 +01:00
Henrik Tjäder
c297b4ee8d Clippy lints 2021-12-25 13:17:16 +01:00