summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJF <jf@codingfield.com>2020-10-27 20:55:18 (GMT)
committerJF <jf@codingfield.com>2020-10-27 20:55:18 (GMT)
commit7de43a16608e599369867cb3cfa7d5776a5b6380 (patch)
tree1750edfed02f547102e468eca485caab3b08e98d /doc
parent5983e33b8d7702800dc91a3229b9a7cee75eb006 (diff)
parentc5bf09d21b2ed8e2435ec625e351594f58713924 (diff)
Fix conflicts
Diffstat (limited to 'doc')
-rw-r--r--doc/MemoryAnalysis.md4
-rw-r--r--doc/buildAndProgram.md2
-rw-r--r--doc/filesInReleaseNotes.md2
3 files changed, 4 insertions, 4 deletions
diff --git a/doc/MemoryAnalysis.md b/doc/MemoryAnalysis.md
index 1bf6e24..95bd611 100644
--- a/doc/MemoryAnalysis.md
+++ b/doc/MemoryAnalysis.md
@@ -1,6 +1,6 @@
# Memory analysis
## FreeRTOS heap and task stack
-FreeRTOS statically allocate its own heap buffer in a global variable named `ucHeap`. This is an aray of *uint8_t*. Its size is specified by the definition `configTOTAL_HEAP_SIZE` in *FreeRTOSConfig.h*
+FreeRTOS statically allocate its own heap buffer in a global variable named `ucHeap`. This is an array of *uint8_t*. Its size is specified by the definition `configTOTAL_HEAP_SIZE` in *FreeRTOSConfig.h*
FreeRTOS uses this buffer to allocate memory for tasks stack and all the RTOS object created during runtime (timers, mutexes,...).
The function `xPortGetFreeHeapSize()` returns the amount of memory available in this *ucHeap* buffer. If this value reaches 0, FreeRTOS runs out of memory.
@@ -75,4 +75,4 @@ add_definitions(-D__STACK_SIZE=8192)
*TODO*
#Tools
- - https://github.com/eliotstock/memory : display the memory usage (FLASH/RAM) using the .map file from GCC. \ No newline at end of file
+ - https://github.com/eliotstock/memory : display the memory usage (FLASH/RAM) using the .map file from GCC.
diff --git a/doc/buildAndProgram.md b/doc/buildAndProgram.md
index 26f3665..72870e3 100644
--- a/doc/buildAndProgram.md
+++ b/doc/buildAndProgram.md
@@ -18,7 +18,7 @@ CMake configures the project according to variables you specify the command line
Variable | Description | Example|
----------|-------------|--------|
-**ARM_NONE_EABI_TOOLCHAIN_PATH**|path to the toolchain directory|`-DARM_NONE_EABI_TOOLCHAIN_PATH=/home/jf/nrf52/gcc-arm-none-eabi-9-2019-q4-major/`|
+**ARM_NONE_EABI_TOOLCHAIN_PATH**|path to the toolchain directory|`-DARM_NONE_EABI_TOOLCHAIN_PATH=/home/jf/nrf52/gcc-arm-none-eabi-9-2020-q2-update/`|
**NRF5_SDK_PATH**|path to the NRF52 SDK|`-DNRF5_SDK_PATH=/home/jf/nrf52/Pinetime/sdk`|
**USE_JLINK, USE_GDB_CLIENT and USE_OPENOCD**|Enable *JLink* mode, *GDB Client* (Black Magic Probe) mode or *OpenOCD* mode (set the one you want to use to `1`)|`-DUSE_JLINK=1`
**CMAKE_BUILD_TYPE**| Build type (Release or Debug). Release is applied by default if this variable is not specified.|`-DCMAKE_BUILD_TYPE=Debug`
diff --git a/doc/filesInReleaseNotes.md b/doc/filesInReleaseNotes.md
index d293051..2fdfadf 100644
--- a/doc/filesInReleaseNotes.md
+++ b/doc/filesInReleaseNotes.md
@@ -42,7 +42,7 @@ This firmware is intended to be used with our [MCUBoot-based bootloader](../boot
The following files are not directly usable by the bootloader:
- - **pinetime-mcuboot-app.bin** : Output file of GCC containing debug symbols, useful is you want to debug the firmware using GDB.
+ - **pinetime-mcuboot-app.out** : Output file of GCC containing debug symbols, useful is you want to debug the firmware using GDB.
- **pinetime-mcuboot-app.hex** : Firmware in Intel HEX file format.
- **pinetime-mcuboot-app.bin** : Firmware in binary format.
- **pinetime-mcuboot-app.map** : Map file containing all the symbols, addresses in memory,...