Skip to content

Commit 639c706

Browse files
authored
Refactor section headings in NOTES.md
Updated section headings from H2 to H3 for better hierarchy and clarity.
1 parent 9b0fb62 commit 639c706

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

NOTES.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ This file is linked to from the EWARM 10.10 release notes regarding "Missing CMS
33
This should be taken into account when changing the file.
44
END OF NOTE -->
55

6-
## Important Notes
6+
# Important Notes
77

8-
### Missing CMSIS headers
8+
## Missing CMSIS headers
99
CMSIS, or Cortex Microcontroller Software Interface Standard, consists of a vendor-independent hardware abstraction layer for Arm Cortex processors which provides consistent device support. Developed by Arm, it provides simple software interfaces to the processor and the peripherals, simplifying software re-use, reducing the learning curve for developers, and reducing the time to market for new devices.
1010

1111
Some of the example projects use legacy versions of CMSIS. When building a project requiring them, you might face a fatal error such as:
1212

1313
>Fatal Error[Pe1696]: cannot open source file “core_cm3.h”
14-
## Solution 1
14+
### Solution 1
1515
For the latest CMSIS, update the project settings to match your environment.
1616

1717
Clone `CMSIS_6`:
@@ -24,7 +24,7 @@ Go to **Project Options > C/C++ Compiler > Preprocessor > Additional Include Dir
2424
```
2525
Note that some registers changed from `CMSIS_5` to `CMSIS_6`, so that migrating code might be required in some cases. In such cases, consider [Solution 2](#solution-2).
2626

27-
## Solution 2
27+
### Solution 2
2828
Use CMSIS 5 for a seamless experience so that no code migration should be necessary.
2929

3030
Clone `CMSIS_5`:
@@ -36,12 +36,12 @@ Go to **Project Options > C/C++ Compiler > Preprocessor > Additional Include Dir
3636
<path/to/CMSIS_5>/CMSIS/Core/Include
3737
```
3838

39-
### File names on Linux
39+
## File names on Linux
4040
Many legacy projects were developed primarily on Windows, where file systems are case-insensitive. As a result, **you may encounter case-sensitivity issues when building these projects on Linux**.
4141

4242
Linux treats file names like `MyFavoriteMCU.icf`, `MYFAVORITEMCU.ICF`, and `myfavoritemcu.icf` as completely different files, whereas Windows sees them as the same. This can lead to broken file references, missing assets, or building errors if the exact case doesn't match.
4343

4444
Adjusting the affected file names to comply with such requirements should fix these issues.
4545

46-
### Path names on Linux
46+
## Path names on Linux
4747
Many legacy projects were developed primarily on Windows, where the path separators can be either backward-slash `\` or forward-slash `/`. Backward-slashes however are not portable across Linux file systems. When building projects on Linux, you might find hardcoded backward-slashes in some path names. Any path names using backward-slashes as separators are going to need to be selectively updated to use forward-slashes wherever required, e.g., on hard-coded include paths.

0 commit comments

Comments
 (0)