From 493bad55f8e97b8ddf885631f908deb684bf96ce Mon Sep 17 00:00:00 2001 From: Avi Date: Wed, 1 Sep 2021 17:35:30 +0200 Subject: [PATCH] Fix #308, Correct documentation typos --- README.md | 4 ++-- SECURITY.md | 2 +- fsw/pc-rtems/README.txt | 4 ++-- fsw/pc-rtems/README_RTEMS_5.txt | 6 +++--- unit-test-coverage/mcp750-vxworks/adaptors/CMakeLists.txt | 2 +- unit-test-coverage/ut-stubs/inc/README.md | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ad5844b4..65ef4720 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ or any other system where direct access is not possible. Renames the existing ` ### Development Build: v1.5.0-rc1+dev101 -- Removes unnecessary global config structure `Target_PspConfigData` and associated elements infavor of the new version API. +- Removes unnecessary global config structure `Target_PspConfigData` and associated elements in favor of the new version API. - The mem pool stats TLM command now works on 64-bit Linux and sends out the expected telemetry packet. Converts `CFE_PSP_MemoryTable` to internal object (instead of external) that should only be accessed via the PSP API. Replace `uint32`s with `size_t`. Use full range (SIZE_MAX) in the Linux/RTEMS implementation. - See and @@ -68,7 +68,7 @@ Converts `CFE_PSP_MemoryTable` to internal object (instead of external) that sho ### Development Build: 1.5.0-rc1+dev68 -- Updates continuous integration workfow by adding static analysis with timeout and code format check. Adds status badges to ReadMe and removes old TravisCI artifacts. +- Updates continuous integration workflow by adding static analysis with timeout and code format check. Adds status badges to ReadMe and removes old TravisCI artifacts. - Adds CodeQL analysis to continuous integration - Apply standard formatting to psp codebase. Only changes whitespace. - Adds missing "+dev" to development version output diff --git a/SECURITY.md b/SECURITY.md index fd381864..54c9a35e 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -6,7 +6,7 @@ To report a vulnerability for the PSP subsystem please [submit an issue](https:/ For general cFS vulnerabilities please [open a cFS framework issue](https://github.com/nasa/cfs/issues/new/choose) and see our [top-level security policy](https://github.com/nasa/cFS/security/policy). -In either case please use the "Bug Report" template and provide as much information as possible. Apply appropraite labels for each report. For security related reports, tag the issue with the "security" label. +In either case please use the "Bug Report" template and provide as much information as possible. Apply appropriate labels for each report. For security related reports, tag the issue with the "security" label. ## Testing diff --git a/fsw/pc-rtems/README.txt b/fsw/pc-rtems/README.txt index cd13243b..3066b4e8 100644 --- a/fsw/pc-rtems/README.txt +++ b/fsw/pc-rtems/README.txt @@ -19,9 +19,9 @@ I. Setting up and compiling RTEMS BSP 1) install RTEMS toolchain for i386-rtems4.11 (or relevant target arch) into /opt/rtems-4.11 -The RTEMS official docs have instructions for this, which should supercede anything here. +The RTEMS official docs have instructions for this, which should supersede anything here. -Basic use of the the "rtems source builder" tool which works at the time of this writing: +Basic use of the "rtems source builder" tool which works at the time of this writing: OFFICIAL RTEMS SOURCE BUILDER CLONE URL: git://git.rtems.org/rtems-source-builder.git diff --git a/fsw/pc-rtems/README_RTEMS_5.txt b/fsw/pc-rtems/README_RTEMS_5.txt index b2f1f753..0b03a4f2 100644 --- a/fsw/pc-rtems/README_RTEMS_5.txt +++ b/fsw/pc-rtems/README_RTEMS_5.txt @@ -20,9 +20,9 @@ I. Setting up and compiling RTEMS BSP 1) install RTEMS toolchain for i386-rtems5 (or relevant target arch) into ${HOME}/rtems5 -The RTEMS official docs have instructions for this, which should supercede anything here. +The RTEMS official docs have instructions for this, which should supersede anything here. -Basic use of the the "rtems source builder" tool which works at the time of this writing: +Basic use of the "rtems source builder" tool which works at the time of this writing: OFFICIAL RTEMS SOURCE BUILDER CLONE URL: git://git.rtems.org/rtems-source-builder.git @@ -37,7 +37,7 @@ cd rtems-source-builder/rtems Note - at the time of this writing 5.1 is the current "stable" branch and 5.1 represents the latest point release tag on that branch. We are going to use the "5" branch, which will eventually be released as 5.2. The latest -5 branch has a bux fix for the RFS file system needed by the cFS for this target. +5 branch has a bug fix for the RFS file system needed by the cFS for this target. If you use the 5.1 release tag (or tarball) you will most likely not be able to run the cFS without an error. diff --git a/unit-test-coverage/mcp750-vxworks/adaptors/CMakeLists.txt b/unit-test-coverage/mcp750-vxworks/adaptors/CMakeLists.txt index c670ddd3..df809f49 100644 --- a/unit-test-coverage/mcp750-vxworks/adaptors/CMakeLists.txt +++ b/unit-test-coverage/mcp750-vxworks/adaptors/CMakeLists.txt @@ -12,7 +12,7 @@ # "Adaptors" help enable the unit test code to reach functions/objects that # are otherwise not exposed. -# NOTE: These source files are compile with OVERRIDES on the headers just like +# NOTE: These source files are compiled with OVERRIDES on the headers just like # the FSW code is compiled. This is how it is able to include internal headers # which otherwise would fail. But that also means that adaptor code cannot call # any library functions, as this would also reach a stub, not the real function. diff --git a/unit-test-coverage/ut-stubs/inc/README.md b/unit-test-coverage/ut-stubs/inc/README.md index 720a7bff..5a8cd1f0 100644 --- a/unit-test-coverage/ut-stubs/inc/README.md +++ b/unit-test-coverage/ut-stubs/inc/README.md @@ -1,7 +1,7 @@ ABOUT THE SYSTEM HEADER OVERRIDES ================================= -The "overrides" directory contain replacement versions of many system-provided +The "overrides" directory contains replacement versions of many system-provided header files. All replacement functions and types are identified using an `OCS_` prefix.