From fbfc9ad56354ce7185a0e813392f76fe7a45d42f Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Tue, 6 Dec 2022 13:19:16 -0500 Subject: [PATCH] Update check-spelling to v0.0.21 (#1790) * spelling: async Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> * spelling: basic Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> * spelling: file for Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> * spelling: files Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> * spelling: generic Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> * spelling: github.com/nasa/fprime Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> * spelling: header Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> * spelling: into Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> * spelling: multiline Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> * spelling: sync Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> * spelling: workaround Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> * Update check-spelling to v0.0.21 Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> Co-authored-by: M Starch --- .github/actions/spelling/README.md | 1 + .github/actions/spelling/advice.md | 2 +- .github/actions/spelling/allow.txt | 6 + .github/actions/spelling/candidate.patterns | 527 ++++++++++++++++++ .github/actions/spelling/excludes.txt | 34 +- .github/actions/spelling/expect.txt | 21 +- .../actions/spelling/line_forbidden.patterns | 27 +- .github/actions/spelling/patterns.txt | 65 ++- .github/workflows/spelling.yml | 54 +- .../schema/default/interface_schema.rng | 2 +- .../default/internal_interface_schema.rng | 2 +- Autocoders/Python/src/fprime_ac/models/Arg.py | 2 +- .../fprime_ac/parsers/XmlComponentParser.py | 4 +- .../src/fprime_ac/parsers/XmlPortsParser.py | 2 +- Autocoders/Python/templates/CMakeLists.txt | 2 +- CFDP/Checksum/CMakeLists.txt | 2 +- CFDP/Checksum/GTest/CMakeLists.txt | 2 +- Drv/BlockDriver/CMakeLists.txt | 2 +- Drv/ByteStreamDriverModel/CMakeLists.txt | 2 +- Drv/DataTypes/CMakeLists.txt | 2 +- Drv/GpioDriverPorts/CMakeLists.txt | 2 +- Drv/I2cDriverPorts/CMakeLists.txt | 2 +- Drv/Ip/CMakeLists.txt | 2 +- Drv/LinuxGpioDriver/CMakeLists.txt | 2 +- Drv/LinuxI2cDriver/CMakeLists.txt | 2 +- Drv/LinuxSpiDriver/CMakeLists.txt | 2 +- Drv/LinuxUartDriver/CMakeLists.txt | 2 +- Drv/SpiDriverPorts/CMakeLists.txt | 2 +- Drv/TcpClient/CMakeLists.txt | 2 +- Drv/TcpServer/CMakeLists.txt | 2 +- Drv/Udp/CMakeLists.txt | 2 +- Fw/Buffer/CMakeLists.txt | 2 +- Fw/Cfg/CMakeLists.txt | 2 +- Fw/Cmd/CMakeLists.txt | 2 +- Fw/Com/CMakeLists.txt | 2 +- Fw/Comp/CMakeLists.txt | 2 +- Fw/FilePacket/CMakeLists.txt | 2 +- Fw/FilePacket/GTest/CMakeLists.txt | 2 +- Fw/Log/CMakeLists.txt | 2 +- Fw/Logger/CMakeLists.txt | 2 +- Fw/Logger/test/ut/Main.cpp | 6 +- Fw/Obj/CMakeLists.txt | 2 +- Fw/Port/CMakeLists.txt | 2 +- Fw/Prm/CMakeLists.txt | 2 +- Fw/SerializableFile/CMakeLists.txt | 2 +- .../test/TestSerializable/CMakeLists.txt | 2 +- Fw/Test/CMakeLists.txt | 2 +- Fw/Time/CMakeLists.txt | 2 +- Fw/Tlm/CMakeLists.txt | 2 +- Fw/Types/CMakeLists.txt | 2 +- Fw/Types/GTest/CMakeLists.txt | 2 +- Os/Baremetal/TaskRunner/BareTaskHandle.hpp | 2 +- Os/Baremetal/TaskRunner/CMakeLists.txt | 2 +- Os/CMakeLists.txt | 2 +- Os/Stubs/CMakeLists.txt | 2 +- RPI/RpiDemo/CMakeLists.txt | 2 +- RPI/Top/CMakeLists.txt | 2 +- Ref/PingReceiver/CMakeLists.txt | 2 +- Ref/RecvBuffApp/CMakeLists.txt | 2 +- Ref/SendBuffApp/CMakeLists.txt | 2 +- Ref/SignalGen/CMakeLists.txt | 2 +- Ref/Top/CMakeLists.txt | 2 +- Svc/ActiveLogger/CMakeLists.txt | 2 +- Svc/ActiveRateGroup/CMakeLists.txt | 2 +- Svc/ActiveTextLogger/CMakeLists.txt | 2 +- Svc/AssertFatalAdapter/CMakeLists.txt | 2 +- Svc/BufferLogger/CMakeLists.txt | 2 +- Svc/BufferManager/CMakeLists.txt | 2 +- Svc/CmdDispatcher/CMakeLists.txt | 2 +- Svc/CmdSequencer/CMakeLists.txt | 2 +- Svc/CmdSequencer/docs/sdd.md | 2 +- .../test/ut/SequenceFiles/File.hpp | 2 +- Svc/ComLogger/CMakeLists.txt | 2 +- Svc/ComSplitter/CMakeLists.txt | 2 +- Svc/Cycle/CMakeLists.txt | 2 +- Svc/Deframer/CMakeLists.txt | 2 +- Svc/Fatal/CMakeLists.txt | 2 +- Svc/FatalHandler/CMakeLists.txt | 2 +- Svc/FileDownlink/CMakeLists.txt | 2 +- Svc/FileDownlinkPorts/CMakeLists.txt | 2 +- Svc/FileManager/CMakeLists.txt | 2 +- Svc/FileUplink/CMakeLists.txt | 2 +- Svc/Framer/CMakeLists.txt | 2 +- Svc/FramingProtocol/CMakeLists.txt | 2 +- Svc/GenericHub/CMakeLists.txt | 2 +- ...leAppAi.xml => GenericHubExampleAppAi.xml} | 0 ...aterAppAi.xml => GenericRepeaterAppAi.xml} | 0 Svc/GroundInterface/CMakeLists.txt | 2 +- Svc/Health/CMakeLists.txt | 2 +- Svc/LinuxTime/CMakeLists.txt | 2 +- Svc/LinuxTimer/CMakeLists.txt | 2 +- Svc/PassiveConsoleTextLogger/CMakeLists.txt | 2 +- Svc/Ping/CMakeLists.txt | 2 +- Svc/PolyDb/CMakeLists.txt | 2 +- Svc/PolyIf/CMakeLists.txt | 2 +- Svc/PrmDb/CMakeLists.txt | 2 +- Svc/RateGroupDriver/CMakeLists.txt | 2 +- Svc/Sched/CMakeLists.txt | 2 +- Svc/Seq/CMakeLists.txt | 2 +- Svc/StaticMemory/CMakeLists.txt | 2 +- Svc/SystemResources/CMakeLists.txt | 2 +- Svc/Time/CMakeLists.txt | 2 +- Svc/TlmChan/CMakeLists.txt | 2 +- Svc/TlmPacketizer/CMakeLists.txt | 2 +- Svc/WatchDog/CMakeLists.txt | 2 +- Utils/Hash/CMakeLists.txt | 2 +- Utils/Types/CMakeLists.txt | 2 +- docs/UsersGuide/dev/testAPI/user_guide.md | 30 +- 108 files changed, 830 insertions(+), 135 deletions(-) create mode 100644 .github/actions/spelling/candidate.patterns rename Svc/GenericHub/docs/{GenricHubExampleAppAi.xml => GenericHubExampleAppAi.xml} (100%) rename Svc/GenericRepeater/docs/{GenricRepeaterAppAi.xml => GenericRepeaterAppAi.xml} (100%) diff --git a/.github/actions/spelling/README.md b/.github/actions/spelling/README.md index ca5ca67d08..8dd5e9f88d 100644 --- a/.github/actions/spelling/README.md +++ b/.github/actions/spelling/README.md @@ -7,6 +7,7 @@ File | Purpose | Format | Info [excludes.txt](excludes.txt) | Files to ignore entirely | perl regular expression | [excludes](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-excludes) [only.txt](only.txt) | Only check matching files (applied after excludes) | perl regular expression | [only](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-only) [patterns.txt](patterns.txt) | Patterns to ignore from checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns) +[candidate.patterns](candidate.patterns) | Patterns that might be worth adding to [patterns.txt](patterns.txt) | perl regular expression with optional comment block introductions (all matches will be suggested) | [candidates](https://github.com/check-spelling/check-spelling/wiki/Feature:-Suggest-patterns) [line_forbidden.patterns](line_forbidden.patterns) | Patterns to flag in checked lines | perl regular expression (order matters, first match wins) | [patterns](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-patterns) [expect.txt](expect.txt) | Expected words that aren't in the dictionary | one word per line (sorted, alphabetically) | [expect](https://github.com/check-spelling/check-spelling/wiki/Configuration#expect) [advice.md](advice.md) | Supplement for GitHub comment when unrecognized words are found | GitHub Markdown | [advice](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-advice) diff --git a/.github/actions/spelling/advice.md b/.github/actions/spelling/advice.md index 54f0c9b5e5..1004eeaa60 100644 --- a/.github/actions/spelling/advice.md +++ b/.github/actions/spelling/advice.md @@ -1,5 +1,5 @@ -
If the flagged items are false positives +
If the flagged items are :exploding_head: false positives If items relate to a ... * binary file (or some other file you wouldn't want to check at all). diff --git a/.github/actions/spelling/allow.txt b/.github/actions/spelling/allow.txt index e69de29bb2..f008fff9df 100644 --- a/.github/actions/spelling/allow.txt +++ b/.github/actions/spelling/allow.txt @@ -0,0 +1,6 @@ +github +https +ssh +ubuntu +workaround +workarounds diff --git a/.github/actions/spelling/candidate.patterns b/.github/actions/spelling/candidate.patterns new file mode 100644 index 0000000000..91d1e8a8f1 --- /dev/null +++ b/.github/actions/spelling/candidate.patterns @@ -0,0 +1,527 @@ +# marker to ignore all code on line +^.*/\* #no-spell-check-line \*/.*$ +# marker to ignore all code on line +^.*\bno-spell-check(?:-line|)(?:\s.*|)$ + +# https://cspell.org/configuration/document-settings/ +# cspell inline +^.*\b[Cc][Ss][Pp][Ee][Ll]{2}:\s*[Dd][Ii][Ss][Aa][Bb][Ll][Ee]-[Ll][Ii][Nn][Ee]\b + +# patch hunk comments +^\@\@ -\d+(?:,\d+|) \+\d+(?:,\d+|) \@\@ .* +# git index header +index [0-9a-z]{7,40}\.\.[0-9a-z]{7,40} + +# cid urls +(['"])cid:.*?\g{-1} + +# data url in parens +\(data:[^)]*?(?:[A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})[^)]*\) +# data url in quotes +([`'"])data:.*?(?:[A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,}).*\g{-1} +# data url +data:[-a-zA-Z=;:/0-9+]*,\S* + +# https/http/file urls +#(?:\b(?:https?|ftp|file)://)[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|] + +# mailto urls +mailto:[-a-zA-Z=;:/?%&0-9+@.]{3,} + +# magnet urls +magnet:[?=:\w]+ + +# magnet urls +"magnet:[^"]+" + +# obs: +"obs:[^"]*" + +# The `\b` here means a break, it's the fancy way to handle urls, but it makes things harder to read +# In this examples content, I'm using a number of different ways to match things to show various approaches +# asciinema +\basciinema\.org/a/[0-9a-zA-Z]+ + +# apple +\bdeveloper\.apple\.com/[-\w?=/]+ +# Apple music +\bembed\.music\.apple\.com/fr/playlist/usr-share/[-\w.]+ + +# appveyor api +\bci\.appveyor\.com/api/projects/status/[0-9a-z]+ +# appveyor project +\bci\.appveyor\.com/project/(?:[^/\s"]*/){2}builds?/\d+/job/[0-9a-z]+ + +# Amazon + +# Amazon +\bamazon\.com/[-\w]+/(?:dp/[0-9A-Z]+|) +# AWS S3 +\b\w*\.s3[^.]*\.amazonaws\.com/[-\w/&#%_?:=]* +# AWS execute-api +\b[0-9a-z]{10}\.execute-api\.[-0-9a-z]+\.amazonaws\.com\b +# AWS ELB +\b\w+\.[-0-9a-z]+\.elb\.amazonaws\.com\b +# AWS SNS +\bsns\.[-0-9a-z]+.amazonaws\.com/[-\w/&#%_?:=]* +# AWS VPC +vpc-\w+ + +# While you could try to match `http://` and `https://` by using `s?` in `https?://`, sometimes there +# YouTube url +\b(?:(?:www\.|)youtube\.com|youtu.be)/(?:channel/|embed/|user/|playlist\?list=|watch\?v=|v/|)[-a-zA-Z0-9?&=_%]* +# YouTube music +\bmusic\.youtube\.com/youtubei/v1/browse(?:[?&]\w+=[-a-zA-Z0-9?&=_]*) +# YouTube tag +<\s*youtube\s+id=['"][-a-zA-Z0-9?_]*['"] +# YouTube image +\bimg\.youtube\.com/vi/[-a-zA-Z0-9?&=_]* +# Google Accounts +\baccounts.google.com/[-_/?=.:;+%&0-9a-zA-Z]* +# Google Analytics +\bgoogle-analytics\.com/collect.[-0-9a-zA-Z?%=&_.~]* +# Google APIs +\bgoogleapis\.(?:com|dev)/[a-z]+/(?:v\d+/|)[a-z]+/[-@:./?=\w+|&]+ +# Google Storage +\b[-a-zA-Z0-9.]*\bstorage\d*\.googleapis\.com(?:/\S*|) +# Google Calendar +\bcalendar\.google\.com/calendar(?:/u/\d+|)/embed\?src=[@./?=\w&%]+ +\w+\@group\.calendar\.google\.com\b +# Google DataStudio +\bdatastudio\.google\.com/(?:(?:c/|)u/\d+/|)(?:embed/|)(?:open|reporting|datasources|s)/[-0-9a-zA-Z]+(?:/page/[-0-9a-zA-Z]+|) +# The leading `/` here is as opposed to the `\b` above +# ... a short way to match `https://` or `http://` since most urls have one of those prefixes +# Google Docs +/docs\.google\.com/[a-z]+/(?:ccc\?key=\w+|(?:u/\d+|d/(?:e/|)[0-9a-zA-Z_-]+/)?(?:edit\?[-\w=#.]*|/\?[\w=&]*|)) +# Google Drive +\bdrive\.google\.com/(?:file/d/|open)[-0-9a-zA-Z_?=]* +# Google Groups +\bgroups\.google\.com/(?:(?:forum/#!|d/)(?:msg|topics?|searchin)|a)/[^/\s"]+/[-a-zA-Z0-9$]+(?:/[-a-zA-Z0-9]+)* +# Google Maps +\bmaps\.google\.com/maps\?[\w&;=]* +# Google themes +themes\.googleusercontent\.com/static/fonts/[^/\s"]+/v\d+/[^.]+. +# Google CDN +\bclients2\.google(?:usercontent|)\.com[-0-9a-zA-Z/.]* +# Goo.gl +/goo\.gl/[a-zA-Z0-9]+ +# Google Chrome Store +\bchrome\.google\.com/webstore/detail/[-\w]*(?:/\w*|) +# Google Books +\bgoogle\.(?:\w{2,4})/books(?:/\w+)*\?[-\w\d=&#.]* +# Google Fonts +\bfonts\.(?:googleapis|gstatic)\.com/[-/?=:;+&0-9a-zA-Z]* +# Google Forms +\bforms\.gle/\w+ +# Google Scholar +\bscholar\.google\.com/citations\?user=[A-Za-z0-9_]+ +# Google Colab Research Drive +\bcolab\.research\.google\.com/drive/[-0-9a-zA-Z_?=]* + +# GitHub SHAs (api) +\bapi.github\.com/repos(?:/[^/\s"]+){3}/[0-9a-f]+\b +# GitHub SHAs (markdown) +(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|) +# GitHub SHAs +\bgithub\.com(?:/[^/\s"]+){2}[@#][0-9a-f]+\b +# GitHub wiki +\bgithub\.com/(?:[^/]+/){2}wiki/(?:(?:[^/]+/|)_history|[^/]+(?:/_compare|)/[0-9a-f.]{40,})\b +# githubusercontent +/[-a-z0-9]+\.githubusercontent\.com/[-a-zA-Z0-9?&=_\/.]* +# githubassets +\bgithubassets.com/[0-9a-f]+(?:[-/\w.]+) +# gist github +\bgist\.github\.com/[^/\s"]+/[0-9a-f]+ +# git.io +\bgit\.io/[0-9a-zA-Z]+ +# GitHub JSON +"node_id": "[-a-zA-Z=;:/0-9+]*" +# Contributor +\[[^\]]+\]\(https://github\.com/[^/\s"]+\) +# GHSA +GHSA(?:-[0-9a-z]{4}){3} + +# GitLab commit +\bgitlab\.[^/\s"]*/\S+/\S+/commit/[0-9a-f]{7,16}#[0-9a-f]{40}\b +# GitLab merge requests +\bgitlab\.[^/\s"]*/\S+/\S+/-/merge_requests/\d+/diffs#[0-9a-f]{40}\b +# GitLab uploads +\bgitlab\.[^/\s"]*/uploads/[-a-zA-Z=;:/0-9+]* +# GitLab commits +\bgitlab\.[^/\s"]*/(?:[^/\s"]+/){2}commits?/[0-9a-f]+\b + +# binanace +accounts.binance.com/[a-z/]*oauth/authorize\?[-0-9a-zA-Z&%]* + +# bitbucket diff +\bapi\.bitbucket\.org/\d+\.\d+/repositories/(?:[^/\s"]+/){2}diff(?:stat|)(?:/[^/\s"]+){2}:[0-9a-f]+ +# bitbucket repositories commits +\bapi\.bitbucket\.org/\d+\.\d+/repositories/(?:[^/\s"]+/){2}commits?/[0-9a-f]+ +# bitbucket commits +\bbitbucket\.org/(?:[^/\s"]+/){2}commits?/[0-9a-f]+ + +# bit.ly +\bbit\.ly/\w+ + +# bitrise +\bapp\.bitrise\.io/app/[0-9a-f]*/[\w.?=&]* + +# bootstrapcdn.com +\bbootstrapcdn\.com/[-./\w]+ + +# cdn.cloudflare.com +\bcdnjs\.cloudflare\.com/[./\w]+ + +# circleci +\bcircleci\.com/gh(?:/[^/\s"]+){1,5}.[a-z]+\?[-0-9a-zA-Z=&]+ + +# gitter +\bgitter\.im(?:/[^/\s"]+){2}\?at=[0-9a-f]+ + +# gravatar +\bgravatar\.com/avatar/[0-9a-f]+ + +# ibm +[a-z.]*ibm\.com/[-_#=:%!?~.\\/\d\w]* + +# imgur +\bimgur\.com/[^.]+ + +# Internet Archive +\barchive\.org/web/\d+/(?:[-\w.?,'/\\+&%$#_:]*) + +# discord +/discord(?:app\.com|\.gg)/(?:invite/)?[a-zA-Z0-9]{7,} + +# Disqus +\bdisqus\.com/[-\w/%.()!?&=_]* + +# medium link +\blink\.medium\.com/[a-zA-Z0-9]+ +# medium +\bmedium\.com/\@?[^/\s"]+/[-\w]+ + +# microsoft +\b(?:https?://|)(?:(?:download\.visualstudio|docs|msdn2?|research)\.microsoft|blogs\.msdn)\.com/[-_a-zA-Z0-9()=./%]* +# powerbi +\bapp\.powerbi\.com/reportEmbed/[^"' ]* +# vs devops +\bvisualstudio.com(?::443|)/[-\w/?=%&.]* +# microsoft store +\bmicrosoft\.com/store/apps/\w+ + +# mvnrepository.com +\bmvnrepository\.com/[-0-9a-z./]+ + +# now.sh +/[0-9a-z-.]+\.now\.sh\b + +# oracle +\bdocs\.oracle\.com/[-0-9a-zA-Z./_?#&=]* + +# chromatic.com +/\S+.chromatic.com\S*[")] + +# codacy +\bapi\.codacy\.com/project/badge/Grade/[0-9a-f]+ + +# compai +\bcompai\.pub/v1/png/[0-9a-f]+ + +# mailgun api +\.api\.mailgun\.net/v3/domains/[0-9a-z]+\.mailgun.org/messages/[0-9a-zA-Z=@]* +# mailgun +\b[0-9a-z]+.mailgun.org + +# /message-id/ +/message-id/[-\w@./%]+ + +# Reddit +\breddit\.com/r/[/\w_]* + +# requestb.in +\brequestb\.in/[0-9a-z]+ + +# sched +\b[a-z0-9]+\.sched\.com\b + +# Slack url +slack://[a-zA-Z0-9?&=]+ +# Slack +\bslack\.com/[-0-9a-zA-Z/_~?&=.]* +# Slack edge +\bslack-edge\.com/[-a-zA-Z0-9?&=%./]+ +# Slack images +\bslack-imgs\.com/[-a-zA-Z0-9?&=%.]+ + +# shields.io +\bshields\.io/[-\w/%?=&.:+;,]* + +# stackexchange -- https://stackexchange.com/feeds/sites +\b(?:askubuntu|serverfault|stack(?:exchange|overflow)|superuser).com/(?:questions/\w+/[-\w]+|a/) + +# Sentry +[0-9a-f]{32}\@o\d+\.ingest\.sentry\.io\b + +# Twitter markdown +\[\@[^[/\]:]*?\]\(https://twitter.com/[^/\s"')]*(?:/status/\d+(?:\?[-_0-9a-zA-Z&=]*|)|)\) +# Twitter hashtag +\btwitter\.com/hashtag/[\w?_=&]* +# Twitter status +\btwitter\.com/[^/\s"')]*(?:/status/\d+(?:\?[-_0-9a-zA-Z&=]*|)|) +# Twitter profile images +\btwimg\.com/profile_images/[_\w./]* +# Twitter media +\btwimg\.com/media/[-_\w./?=]* +# Twitter link shortened +\bt\.co/\w+ + +# facebook +\bfburl\.com/[0-9a-z_]+ +# facebook CDN +\bfbcdn\.net/[\w/.,]* +# facebook watch +\bfb\.watch/[0-9A-Za-z]+ + +# dropbox +\bdropbox\.com/sh?/[^/\s"]+/[-0-9A-Za-z_.%?=&;]+ + +# ipfs protocol +ipfs://[0-9a-z]* +# ipfs url +/ipfs/[0-9a-z]* + +# w3 +\bw3\.org/[-0-9a-zA-Z/#.]+ + +# loom +\bloom\.com/embed/[0-9a-f]+ + +# regex101 +\bregex101\.com/r/[^/\s"]+/\d+ + +# figma +\bfigma\.com/file(?:/[0-9a-zA-Z]+/)+ + +# freecodecamp.org +\bfreecodecamp\.org/[-\w/.]+ + +# image.tmdb.org +\bimage\.tmdb\.org/[/\w.]+ + +# mermaid +\bmermaid\.ink/img/[-\w]+|\bmermaid-js\.github\.io/mermaid-live-editor/#/edit/[-\w]+ + +# Wikipedia +\ben\.wikipedia\.org/wiki/[-\w%.#]+ + +# gitweb +[^"\s]+/gitweb/\S+;h=[0-9a-f]+ + +# HyperKitty lists +/archives/list/[^@/]+\@[^/\s"]*/message/[^/\s"]*/ + +# lists +/thread\.html/[^"\s]+ + +# list-management +\blist-manage\.com/subscribe(?:[?&](?:u|id)=[0-9a-f]+)+ + +# kubectl.kubernetes.io/last-applied-configuration +"kubectl.kubernetes.io/last-applied-configuration": ".*" + +# pgp +\bgnupg\.net/pks/lookup[?&=0-9a-zA-Z]* + +# Spotify +\bopen\.spotify\.com/embed/playlist/\w+ + +# Mastodon +\bmastodon\.[-a-z.]*/(?:media/|\@)[?&=0-9a-zA-Z_]* + +# scastie +\bscastie\.scala-lang\.org/[^/]+/\w+ + +# images.unsplash.com +\bimages\.unsplash\.com/(?:(?:flagged|reserve)/|)[-\w./%?=%&.;]+ + +# pastebin +\bpastebin\.com/[\w/]+ + +# heroku +\b\w+\.heroku\.com/source/archive/\w+ + +# quip +\b\w+\.quip\.com/\w+(?:(?:#|/issues/)\w+)? + +# badgen.net +\bbadgen\.net/badge/[^")\]'\s]+ + +# statuspage.io +\w+\.statuspage\.io\b + +# media.giphy.com +\bmedia\.giphy\.com/media/[^/]+/[\w.?&=]+ + +# tinyurl +\btinyurl\.com/\w+ + +# getopts +\bgetopts\s+(?:"[^"]+"|'[^']+') + +# ANSI color codes +(?:\\(?:u00|x)1b|\x1b)\[\d+(?:;\d+|)m + +# URL escaped characters +\%[0-9A-F][A-F] +# IPv6 +\b(?:[0-9a-fA-F]{0,4}:){3,7}[0-9a-fA-F]{0,4}\b +# c99 hex digits (not the full format, just one I've seen) +0x[0-9a-fA-F](?:\.[0-9a-fA-F]*|)[pP] +# Punycode +\bxn--[-0-9a-z]+ +# sha +sha\d+:[0-9]*[a-f]{3,}[0-9a-f]* +# sha-... -- uses a fancy capture +(['"]|")[0-9a-f]{40,}\g{-1} +# hex runs +\b[0-9a-fA-F]{16,}\b +# hex in url queries +=[0-9a-fA-F]*?(?:[A-F]{3,}|[a-f]{3,})[0-9a-fA-F]*?& +# ssh +(?:ssh-\S+|-nistp256) [-a-zA-Z=;:/0-9+]{12,} + +# PGP +\b(?:[0-9A-F]{4} ){9}[0-9A-F]{4}\b +# GPG keys +\b(?:[0-9A-F]{4} ){5}(?: [0-9A-F]{4}){5}\b +# Well known gpg keys +.well-known/openpgpkey/[\w./]+ + +# uuid: +\b[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\b +# hex digits including css/html color classes: +(?:[\\0][xX]|\\u|[uU]\+|#x?|\%23)[0-9_a-fA-FgGrR]*?[a-fA-FgGrR]{2,}[0-9_a-fA-FgGrR]*(?:[uUlL]{0,3}|u\d+)\b +# integrity +integrity="sha\d+-[-a-zA-Z=;:/0-9+]{40,}" + +# https://www.gnu.org/software/groff/manual/groff.html +# man troff content +\\f[BCIPR] +# ' +\\\(aq + +# .desktop mime types +^MimeTypes?=.*$ +# .desktop localized entries +^[A-Z][a-z]+\[[a-z]+\]=.*$ +# Localized .desktop content +Name\[[^\]]+\]=.* + +# IServiceProvider +\bI(?=(?:[A-Z][a-z]{2,})+\b) + +# crypt +"\$2[ayb]\$.{56}" + +# scrypt / argon +\$(?:scrypt|argon\d+[di]*)\$\S+ + +# Input to GitHub JSON +content: "[-a-zA-Z=;:/0-9+]*=" + +# Python stringprefix / binaryprefix +# Note that there's a high false positive rate, remove the `?=` and search for the regex to see if the matches seem like reasonable strings +(?v# +(?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_])) +# Compiler flags (Scala) +(?:^|[\t ,>"'`=(])-J-[DPWXY](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,}) +# Compiler flags +(?:^|[\t ,"'`=(])-[DPWXYLlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,}) +# Compiler flags (linker) +,-B +# curl arguments +\b(?:\\n|)curl(?:\s+-[a-zA-Z]{1,2}\b)*(?:\s+-[a-zA-Z]{3,})(?:\s+-[a-zA-Z]+)* +# set arguments +\bset(?:\s+-[abefimouxE]{1,2})*\s+-[abefimouxE]{3,}(?:\s+-[abefimouxE]+)* +# tar arguments +\b(?:\\n|)g?tar(?:\.exe|)(?:(?:\s+--[-a-zA-Z]+|\s+-[a-zA-Z]+|\s[ABGJMOPRSUWZacdfh-pr-xz]+\b)(?:=[^ ]*|))+ +# tput arguments -- https://man7.org/linux/man-pages/man5/terminfo.5.html -- technically they can be more than 5 chars long... +\btput\s+(?:(?:-[SV]|-T\s*\w+)\s+)*\w{3,5}\b +# macOS temp folders +/var/folders/\w\w/[+\w]+/(?:T|-Caches-)/ diff --git a/.github/actions/spelling/excludes.txt b/.github/actions/spelling/excludes.txt index 1200e9ad0c..d3d2a1a562 100644 --- a/.github/actions/spelling/excludes.txt +++ b/.github/actions/spelling/excludes.txt @@ -1,26 +1,37 @@ # See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-excludes (?:^|/)(?i)COPYRIGHT (?:^|/)(?i)LICEN[CS]E +(?:^|/)3rdparty/ (?:^|/)go\.sum$ (?:^|/)package(?:-lock|)\.json$ +(?:^|/)pyproject.toml +(?:^|/)requirements(?:-dev|-doc|-test|)\.txt$ (?:^|/)vendor/ /doc/xml/ /html/ /third-party/ +/__init__\.py$ ignore$ +\.a$ \.ai$ \.avi$ \.bak$ \.bin$ \.bmp$ \.bz2$ +\.class$ +\.coveragerc$ \.crt$ \.dat$ +\.dll$ \.doc$ \.docx$ +\.drawio$ \.DS_Store$ \.eot$ +\.exe$ \.gif$ +\.git-blame-ignore-revs$ \.gitattributes$ \.graffle$ \.gz$ @@ -28,8 +39,10 @@ ignore$ \.ico$ \.inv$ \.jar$ +\.jks$ \.jpe?g$ \.key$ +\.lib$ \.lock$ \.log$ \.map$ @@ -38,6 +51,7 @@ ignore$ \.min\.. \.mod$ \.mp[34]$ +\.o$ \.ocf$ \.otf$ \.pdf$ @@ -45,17 +59,23 @@ ignore$ \.png$ \.pptx$ \.psd$ +\.pyc$ +\.pylintrc$ \.rtf$ +\.s$ \.ser$ \.sty$ \.svg$ +\.svgz?$ +\.tar$ \.tex$ +\.tiff?$ \.ttf$ \.vm$ \.vsdx$ \.wav$ -\.woff$ -\.woff2$ +\.webm$ +\.webp$ \.woff2?$ \.xls$ \.xlsx$ @@ -77,12 +97,22 @@ ignore$ ^Svc/TlmChan/TlmChan\.hpp$ ^\.github/actions/spelling/ ^\Q.github/workflows/spelling.yml\E$ +^\QAutocoders/Python/doc/tlmLayout/LayoutExampleTlmLayoutAi.csv\E$ +^\QAutocoders/Python/src/fprime_ac/generators/templates/serialize/includes1SerialH.tmpl\E$ +^\QAutocoders/Python/test/command_multi_inst/docs/Test1.md\E$ +^\QAutocoders/Python/test/event_multi_inst/docs/TestLog.md\E$ +^\QAutocoders/Python/test/tlm_multi_inst/docs/TestTlm.md\E$ +^\Qcmake/platform/README.md\E$ +^\Qdocs/Tutorials/FullSystemTutorial/Tutorial.md\E$ ^\QDrv/BlockDriver/BlockDriver.hpp\E$ ^\QDrv/LinuxGpioDriver/LinuxGpioDriver.hpp\E$ ^\QDrv/LinuxSpiDriver/LinuxSpiDriver.hpp\E$ ^\QDrv/TcpClient/TcpClient.hpp\E$ ^\QFw/Types/Linux/StandardTypes.hpp\E$ +^\QRef/SignalGen/check.xml\E$ ^\Qrequirements.txt\E$ +^\QSTest/README.md\E$ +^\QSvc/FileDownlink/check.xml\E$ ^\QSvc/LinuxTime/LinuxTime.hpp\E$ ^\QSvc/PrmDb/PrmDb.hpp\E$ ^\QSvc/TlmChan/TlmChan.hpp\E$ diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt index e2921d28ba..bf0cd57c9a 100644 --- a/.github/actions/spelling/expect.txt +++ b/.github/actions/spelling/expect.txt @@ -77,6 +77,7 @@ autocoders autocoding autocompletion autodoc +autodocs Autodocumentation autogen Autogenerate @@ -105,6 +106,7 @@ bitmaps bitset ble blog +blogs BLSPSERIALDRIVERCOMPONENTIMPLCFG bocchino bodychars @@ -280,7 +282,6 @@ databinding DATAROOTDIR datastore dawbarton -db DBUILD DCMAKE DDDTHH @@ -462,7 +463,6 @@ fbuild fcheck fclose fcntl -fd fds fdset featuredarticles @@ -860,7 +860,6 @@ mname modbus MOSI MOVEFILE -mq mqd mqueue Mrf @@ -883,6 +882,7 @@ multline munmap mutex mutexattr +Mutexed mutexes mval mycompany @@ -905,7 +905,6 @@ newself newstring newtio nfds -Nh Nicolich ninjaaron NMEA @@ -1020,12 +1019,15 @@ pkts plainnat plantuml plugin +plugins pname png PNGs +POLLERR pollerr pollfd POLLIN +POLLPRI pollpri POLYDB POLYDBCOMP @@ -1080,6 +1082,7 @@ ptmcg pton ptr ptype +puml punc pushd pwd @@ -1166,7 +1169,6 @@ riverbankcomputing Rizvi rootdir ror -rp rpaetz rpi RPIDEMO @@ -1204,6 +1206,7 @@ scons scp scrollbars sdd +SDFLIGHT searchdata SEARCHENGINE segfault @@ -1293,6 +1296,7 @@ srand srandom srange src +SRCS sre sscanf ssh @@ -1344,6 +1348,7 @@ strtol strtoul subdir subfolder +subfolders subgrouping subhist subhistory @@ -1437,7 +1442,6 @@ timothycanham tions tjh TKC -tl tlc tlist tlm @@ -1487,7 +1491,6 @@ trimwhitespace trinomials TRUNC truncstring -tt tts ttype Tuszynski @@ -1529,6 +1532,7 @@ unistd Unithem unittest UNITTESTASSERT +unittests unprintables unsubscribe upcalls @@ -1567,7 +1571,6 @@ virtualization virtualized vla vlist -vm VMIN vmstat vsnprintf @@ -1600,7 +1603,6 @@ WORKDIR workflow worklist Woverloaded -wp writelines WRONLY wrs @@ -1613,6 +1615,7 @@ wxgui Xabcdefx xapian xargs +Xcode XBee xcode xdf diff --git a/.github/actions/spelling/line_forbidden.patterns b/.github/actions/spelling/line_forbidden.patterns index 4ca15837cc..760ec9b6ff 100644 --- a/.github/actions/spelling/line_forbidden.patterns +++ b/.github/actions/spelling/line_forbidden.patterns @@ -1,6 +1,11 @@ # reject `m_data` as there's a certain OS which has evil defines that break things if it's used elsewhere # \bm_data\b +# If you have a framework that uses `it()` for testing and `fit()` for debugging a specific test, +# you might not want to check in code where you were debugging w/ `fit()`, in which case, you might want +# to use this: +#\bfit\( + # s.b. GitHub \bGithub\b @@ -19,6 +24,12 @@ # s.b. greater than \bgreater then\b +# s.b. into +#\sin to\s + +# s.b. opt-in +\sopt in\s + # s.b. less than \bless then\b @@ -30,10 +41,22 @@ \b[Nn]o[nt][- ]existent\b # s.b. preexisting -[Pp]re-existing +[Pp]re[- ]existing + +# s.b. preempt +[Pp]re[- ]empt\b # s.b. preemptively -[Pp]re-emptively +[Pp]re[- ]emptively + +# s.b. reentrancy +[Rr]e[- ]entrancy + +# s.b. reentrant +[Rr]e[- ]entrant + +# s.b. workaround(s) +\bwork[- ]arounds?\b # Reject duplicate words \s([A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})\s\g{-1}\s diff --git a/.github/actions/spelling/patterns.txt b/.github/actions/spelling/patterns.txt index 6241a7b50b..edd3969da1 100644 --- a/.github/actions/spelling/patterns.txt +++ b/.github/actions/spelling/patterns.txt @@ -1,5 +1,49 @@ # See https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples:-patterns +# hit-count: 106 file-count: 28 +# Compiler flags +(?:^|[\t ,"'`=(])-[DPWXYLlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,}) + +# hit-count: 48 file-count: 18 +# GitHub SHAs (markdown) +(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|) + +# hit-count: 29 file-count: 13 +# version suffix v# +(?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_])) + +# hit-count: 8 file-count: 3 +# Wikipedia +\ben\.wikipedia\.org/wiki/[-\w%.#]+ + +# hit-count: 5 file-count: 2 +# w3 +\bw3\.org/[-0-9a-zA-Z/#.]+ + +# hit-count: 3 file-count: 3 +# Contributor +\[[^\]]+\]\(https://github\.com/[^/\s"]+\) + +# hit-count: 3 file-count: 3 +# stackexchange -- https://stackexchange.com/feeds/sites +\b(?:askubuntu|serverfault|stack(?:exchange|overflow)|superuser).com/(?:questions/\w+/[-\w]+|a/) + +# hit-count: 2 file-count: 1 +# mailto urls +\[([-a-zA-Z=;:/?%&0-9+@.]{3,})]\(mailto:\g{-1}\) + +# hit-count: 2 file-count: 1 +# apple +\bdeveloper\.apple\.com/[-\w?=/]+ + +# hit-count: 2 file-count: 1 +# shields.io +\bshields\.io/[-\w/%?=&.:+;,]* + +# hit-count: 1 file-count: 1 +# hex runs +\b[0-9a-fA-F]{16,}\b + # data urls "data:[^"]*" 'data:[^']*' @@ -47,20 +91,33 @@ value="(?:[0-9a-f]{1,2} )*" # Ignore any text between inline back-ticks `(.*?)` -# Tar archive items +# Tar archive items \b(?:\\n|)tar(?:\s+-[a-zA-Z]+|\s[a-z]+)+ # slashes after spaces are not in paths LaTeX \\.* \\ +# Questionably acceptable forms of `in to` +# Personally, I prefer `log into`, but people object +# https://www.tprteaching.com/log-into-log-in-to-login/ +\b[Ll]og in to\b + # acceptable duplicates # ls directory listings -[-bcdlpsw](?:[-r][-w][-sx]){3}\s+\d+\s+(\S+)\s+\g{-1}\s+\d+\s+ -# C types -\s(expr|long|LONG|Time)(?:\s+\g{-1})+\s +[-bcdlpsw](?:[-r][-w][-Ssx]){3}\s+\d+\s+\S+\s+\S+\s+\d+\s+ +# C types and repeated CSS values +\s(center|div|inherit|expr|long|LONG|none|normal|solid|Time|thin|transparent|very)(?: \g{-1})+\s +# go templates +\s(\w+)\s+\g{-1}\s+\`(?:graphql|json|yaml): # javadoc / .net (?:[\\@](?:groupname|page|param)|(?:public|private)(?:\s+static|\s+readonly)*)\s+(\w+)\s+\g{-1}\s +# Commit message -- Signed-off-by and friends +^\s*(?:(?:Based-on-patch|Co-authored|Helped|Mentored|Reported|Reviewed|Signed-off)-by|Thanks-to): (?:[^<]*<[^>]*>|[^<]*)\s*$ + +# Autogenerated revert commit message +^This reverts commit [0-9a-f]{40}\.$ + # Jenkins library GithubProjectProperty diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml index c31e5767e9..178a500a1e 100644 --- a/.github/workflows/spelling.yml +++ b/.github/workflows/spelling.yml @@ -1,4 +1,38 @@ name: Spell checking + +# Comment management is handled through a secondary job, for details see: +# https://github.com/check-spelling/check-spelling/wiki/Feature%3A-Restricted-Permissions +# +# `jobs.comment-push` runs when a push is made to a repository and the `jobs.spelling` job needs to make a comment +# (in odd cases, it might actually run just to collapse a comment, but that's fairly rare) +# it needs `contents: write` in order to add a comment. +# +# `jobs.comment-pr` runs when a pull_request is made to a repository and the `jobs.spelling` job needs to make a comment +# or collapse a comment (in the case where it had previously made a comment and now no longer needs to show a comment) +# it needs `pull-requests: write` in order to manipulate those comments. + +# Updating pull request branches is managed via comment handling. +# For details, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-expect-list +# +# These elements work together to make it happen: +# +# `on.issue_comment` +# This event listens to comments by users asking to update the metadata. +# +# `jobs.update` +# This job runs in response to an issue_comment and will push a new commit +# to update the spelling metadata. +# +# `with.experimental_apply_changes_via_bot` +# Tells the action to support and generate messages that enable it +# to make a commit to update the spelling metadata. +# +# `with.ssh_key` +# In order to trigger workflows when the commit is made, you can provide a +# secret (typically, a write-enabled github deploy key). +# +# For background, see: https://github.com/check-spelling/check-spelling/wiki/Feature:-Update-with-deploy-key + on: push: branches: @@ -10,7 +44,10 @@ on: - "**" tags-ignore: - "**" - types: ['opened', 'reopened', 'synchronize'] + types: + - 'opened' + - 'reopened' + - 'synchronize' jobs: spelling: @@ -30,15 +67,26 @@ jobs: steps: - name: check-spelling id: spelling - uses: check-spelling/check-spelling@v0.0.20 + uses: check-spelling/check-spelling@v0.0.21 with: suppress_push_for_open_pull_request: 1 checkout: true + check_file_names: 1 + spell_check_this: check-spelling/spell-check-this@prerelease post_comment: 0 + use_magic_file: 1 + extra_dictionary_limit: 10 extra_dictionaries: cspell:filetypes/filetypes.txt - cspell:python/python.txt + cspell:python/src/python/python-lib.txt + cspell:python/src/python/python.txt + cspell:python/src/common/extra.txt + cspell:software-terms/src/software-terms.txt + cspell:node/node.txt + cspell:cpp/src/stdlib-c.txt + cspell:cpp/src/stdlib-cpp.txt cspell:django/django.txt cspell:html/html.txt cspell:fullstack/fullstack.txt + cspell:aws/aws.txt check_extra_dictionaries: '' diff --git a/Autocoders/Python/schema/default/interface_schema.rng b/Autocoders/Python/schema/default/interface_schema.rng index 4c9b42c1b4..87d9059ce9 100644 --- a/Autocoders/Python/schema/default/interface_schema.rng +++ b/Autocoders/Python/schema/default/interface_schema.rng @@ -4,7 +4,7 @@ xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes"> - + diff --git a/Autocoders/Python/schema/default/internal_interface_schema.rng b/Autocoders/Python/schema/default/internal_interface_schema.rng index 87f963dfd7..f29e24c3ee 100644 --- a/Autocoders/Python/schema/default/internal_interface_schema.rng +++ b/Autocoders/Python/schema/default/internal_interface_schema.rng @@ -4,7 +4,7 @@ xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes"> - + diff --git a/Autocoders/Python/src/fprime_ac/models/Arg.py b/Autocoders/Python/src/fprime_ac/models/Arg.py index 08447cf7e1..19f6efd9a9 100644 --- a/Autocoders/Python/src/fprime_ac/models/Arg.py +++ b/Autocoders/Python/src/fprime_ac/models/Arg.py @@ -45,7 +45,7 @@ class Arg: @param type: Type of arg (must have supporting include xml) @param modifier: Modification of the argument (i.e. pointer or reference) @param size: size of array of type (string or buffer) - @param comment: A single or multline comment + @param comment: A single or multiline comment """ self.__name = name self.__type = atype diff --git a/Autocoders/Python/src/fprime_ac/parsers/XmlComponentParser.py b/Autocoders/Python/src/fprime_ac/parsers/XmlComponentParser.py index fca03ad593..66fcb1215e 100644 --- a/Autocoders/Python/src/fprime_ac/parsers/XmlComponentParser.py +++ b/Autocoders/Python/src/fprime_ac/parsers/XmlComponentParser.py @@ -1383,8 +1383,8 @@ class Port: @param name: Name of port (each instance must be unique). @param direction: Direction of data flow (must be input or output) @param type: Type of port (must have supporting include xml) - @param sync: Kind of port (must be one of: asynch, synch, or guarded) - @param comment: A single or multline comment + @param sync: Kind of port (must be one of: async, sync, or guarded) + @param comment: A single or multiline comment """ # TODO: ADD NAMESPACE self.__name = name diff --git a/Autocoders/Python/src/fprime_ac/parsers/XmlPortsParser.py b/Autocoders/Python/src/fprime_ac/parsers/XmlPortsParser.py index 4db40f9e6a..8b09211425 100644 --- a/Autocoders/Python/src/fprime_ac/parsers/XmlPortsParser.py +++ b/Autocoders/Python/src/fprime_ac/parsers/XmlPortsParser.py @@ -304,7 +304,7 @@ class Arg: @param type: Type of arg (must have supporting include xml) @param modifier: Whether argument is passed by value, reference, or pointer @param size: size of array for string and buffer - @param comment: A single or multline comment + @param comment: A single or multiline comment """ self.__name = name self.__type = atype diff --git a/Autocoders/Python/templates/CMakeLists.txt b/Autocoders/Python/templates/CMakeLists.txt index f9524402d3..4fe4dd16ab 100644 --- a/Autocoders/Python/templates/CMakeLists.txt +++ b/Autocoders/Python/templates/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/CFDP/Checksum/CMakeLists.txt b/CFDP/Checksum/CMakeLists.txt index 0300646cc0..d6f3a11eaa 100644 --- a/CFDP/Checksum/CMakeLists.txt +++ b/CFDP/Checksum/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/CFDP/Checksum/GTest/CMakeLists.txt b/CFDP/Checksum/GTest/CMakeLists.txt index a778b60118..d2b937e70c 100644 --- a/CFDP/Checksum/GTest/CMakeLists.txt +++ b/CFDP/Checksum/GTest/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Drv/BlockDriver/CMakeLists.txt b/Drv/BlockDriver/CMakeLists.txt index 2789e64813..38bb8281f4 100644 --- a/Drv/BlockDriver/CMakeLists.txt +++ b/Drv/BlockDriver/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Drv/ByteStreamDriverModel/CMakeLists.txt b/Drv/ByteStreamDriverModel/CMakeLists.txt index deb8ca334c..cf19e49396 100644 --- a/Drv/ByteStreamDriverModel/CMakeLists.txt +++ b/Drv/ByteStreamDriverModel/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Drv/DataTypes/CMakeLists.txt b/Drv/DataTypes/CMakeLists.txt index 03786646a0..fc85603c27 100644 --- a/Drv/DataTypes/CMakeLists.txt +++ b/Drv/DataTypes/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Drv/GpioDriverPorts/CMakeLists.txt b/Drv/GpioDriverPorts/CMakeLists.txt index d0a12854be..8ed47ecc86 100644 --- a/Drv/GpioDriverPorts/CMakeLists.txt +++ b/Drv/GpioDriverPorts/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Drv/I2cDriverPorts/CMakeLists.txt b/Drv/I2cDriverPorts/CMakeLists.txt index 3ddc5212cb..c164cb9f43 100644 --- a/Drv/I2cDriverPorts/CMakeLists.txt +++ b/Drv/I2cDriverPorts/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Drv/Ip/CMakeLists.txt b/Drv/Ip/CMakeLists.txt index 39388ceb4e..0473c63867 100644 --- a/Drv/Ip/CMakeLists.txt +++ b/Drv/Ip/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Drv/LinuxGpioDriver/CMakeLists.txt b/Drv/LinuxGpioDriver/CMakeLists.txt index 8d2567ceae..b20d3ed98d 100644 --- a/Drv/LinuxGpioDriver/CMakeLists.txt +++ b/Drv/LinuxGpioDriver/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Drv/LinuxI2cDriver/CMakeLists.txt b/Drv/LinuxI2cDriver/CMakeLists.txt index 4e4deb9c40..eabb7ac694 100644 --- a/Drv/LinuxI2cDriver/CMakeLists.txt +++ b/Drv/LinuxI2cDriver/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Drv/LinuxSpiDriver/CMakeLists.txt b/Drv/LinuxSpiDriver/CMakeLists.txt index 4d9aa7ecdd..10419ba038 100644 --- a/Drv/LinuxSpiDriver/CMakeLists.txt +++ b/Drv/LinuxSpiDriver/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Drv/LinuxUartDriver/CMakeLists.txt b/Drv/LinuxUartDriver/CMakeLists.txt index 3d87a0e9b2..0bc47509cc 100644 --- a/Drv/LinuxUartDriver/CMakeLists.txt +++ b/Drv/LinuxUartDriver/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Drv/SpiDriverPorts/CMakeLists.txt b/Drv/SpiDriverPorts/CMakeLists.txt index 88d03f874a..1d6bd704f4 100644 --- a/Drv/SpiDriverPorts/CMakeLists.txt +++ b/Drv/SpiDriverPorts/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Drv/TcpClient/CMakeLists.txt b/Drv/TcpClient/CMakeLists.txt index fb2a04b56c..99ae5f1451 100644 --- a/Drv/TcpClient/CMakeLists.txt +++ b/Drv/TcpClient/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Drv/TcpServer/CMakeLists.txt b/Drv/TcpServer/CMakeLists.txt index 59b8e3e41e..80ac3fc867 100644 --- a/Drv/TcpServer/CMakeLists.txt +++ b/Drv/TcpServer/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Drv/Udp/CMakeLists.txt b/Drv/Udp/CMakeLists.txt index 699dbaab56..203b804904 100644 --- a/Drv/Udp/CMakeLists.txt +++ b/Drv/Udp/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/Buffer/CMakeLists.txt b/Fw/Buffer/CMakeLists.txt index 76ca5f548d..701e233186 100644 --- a/Fw/Buffer/CMakeLists.txt +++ b/Fw/Buffer/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/Cfg/CMakeLists.txt b/Fw/Cfg/CMakeLists.txt index ecb0c5a769..08c0c2f2b2 100644 --- a/Fw/Cfg/CMakeLists.txt +++ b/Fw/Cfg/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/Cmd/CMakeLists.txt b/Fw/Cmd/CMakeLists.txt index 5cba1e92e2..f87144d8cb 100644 --- a/Fw/Cmd/CMakeLists.txt +++ b/Fw/Cmd/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/Com/CMakeLists.txt b/Fw/Com/CMakeLists.txt index f8139ca4e9..8cfcff21d1 100644 --- a/Fw/Com/CMakeLists.txt +++ b/Fw/Com/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/Comp/CMakeLists.txt b/Fw/Comp/CMakeLists.txt index ba18f8b557..6865bdd831 100644 --- a/Fw/Comp/CMakeLists.txt +++ b/Fw/Comp/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/FilePacket/CMakeLists.txt b/Fw/FilePacket/CMakeLists.txt index c92c708c73..c7a1914c2c 100644 --- a/Fw/FilePacket/CMakeLists.txt +++ b/Fw/FilePacket/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/FilePacket/GTest/CMakeLists.txt b/Fw/FilePacket/GTest/CMakeLists.txt index 6c5b7d3e8d..e9b17fb627 100644 --- a/Fw/FilePacket/GTest/CMakeLists.txt +++ b/Fw/FilePacket/GTest/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Fw/Log/CMakeLists.txt b/Fw/Log/CMakeLists.txt index ce323f496b..dcd364dd95 100644 --- a/Fw/Log/CMakeLists.txt +++ b/Fw/Log/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/Logger/CMakeLists.txt b/Fw/Logger/CMakeLists.txt index 844a9b8d5d..90c41d82a8 100644 --- a/Fw/Logger/CMakeLists.txt +++ b/Fw/Logger/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/Logger/test/ut/Main.cpp b/Fw/Logger/test/ut/Main.cpp index 7449fcd892..14d52daaf9 100644 --- a/Fw/Logger/test/ut/Main.cpp +++ b/Fw/Logger/test/ut/Main.cpp @@ -49,7 +49,7 @@ TEST(LoggerTests, RandomLoggerTests) { /** * Test that the most basic logging function works. */ -TEST(LoggerTests, BassicGoodLogger) { +TEST(LoggerTests, BasicGoodLogger) { // Setup and register logger MockLogging::FakeLogger logger; Fw::Logger::registerLogger(&logger); @@ -61,7 +61,7 @@ TEST(LoggerTests, BassicGoodLogger) { /** * Test that null-logging function works. */ -TEST(LoggerTests, BassicBadLogger) { +TEST(LoggerTests, BasicBadLogger) { // Basic discard logging MockLogging::FakeLogger logger; Fw::Logger::registerLogger(nullptr); @@ -73,7 +73,7 @@ TEST(LoggerTests, BassicBadLogger) { /** * Test that registration works. Multiple times, as contains randomness. */ -TEST(LoggerTests, BassicRegLogger) { +TEST(LoggerTests, BasicRegLogger) { // Basic discard logging MockLogging::FakeLogger logger; LoggerRules::Register reg("Register"); diff --git a/Fw/Obj/CMakeLists.txt b/Fw/Obj/CMakeLists.txt index 25d6965e80..80a3210321 100644 --- a/Fw/Obj/CMakeLists.txt +++ b/Fw/Obj/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/Port/CMakeLists.txt b/Fw/Port/CMakeLists.txt index 1308860feb..3747db3fca 100644 --- a/Fw/Port/CMakeLists.txt +++ b/Fw/Port/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/Prm/CMakeLists.txt b/Fw/Prm/CMakeLists.txt index 0aeb62de0a..a468b38f91 100644 --- a/Fw/Prm/CMakeLists.txt +++ b/Fw/Prm/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/SerializableFile/CMakeLists.txt b/Fw/SerializableFile/CMakeLists.txt index 1b06bb627e..e040d1acba 100644 --- a/Fw/SerializableFile/CMakeLists.txt +++ b/Fw/SerializableFile/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/SerializableFile/test/TestSerializable/CMakeLists.txt b/Fw/SerializableFile/test/TestSerializable/CMakeLists.txt index eab663392b..681efdcf53 100644 --- a/Fw/SerializableFile/test/TestSerializable/CMakeLists.txt +++ b/Fw/SerializableFile/test/TestSerializable/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/Test/CMakeLists.txt b/Fw/Test/CMakeLists.txt index f18d8ec8a0..dff1941472 100644 --- a/Fw/Test/CMakeLists.txt +++ b/Fw/Test/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/Time/CMakeLists.txt b/Fw/Time/CMakeLists.txt index 996a2917fe..fa739f5ad6 100644 --- a/Fw/Time/CMakeLists.txt +++ b/Fw/Time/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/Tlm/CMakeLists.txt b/Fw/Tlm/CMakeLists.txt index 5d29e9c576..c05d3a179d 100644 --- a/Fw/Tlm/CMakeLists.txt +++ b/Fw/Tlm/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Fw/Types/CMakeLists.txt b/Fw/Types/CMakeLists.txt index f784ab85d1..b9105f640c 100644 --- a/Fw/Types/CMakeLists.txt +++ b/Fw/Types/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Fw/Types/GTest/CMakeLists.txt b/Fw/Types/GTest/CMakeLists.txt index 8e864435f6..5b8dfb8ba2 100644 --- a/Fw/Types/GTest/CMakeLists.txt +++ b/Fw/Types/GTest/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Os/Baremetal/TaskRunner/BareTaskHandle.hpp b/Os/Baremetal/TaskRunner/BareTaskHandle.hpp index 5b69ef22e6..dbcdea7a44 100644 --- a/Os/Baremetal/TaskRunner/BareTaskHandle.hpp +++ b/Os/Baremetal/TaskRunner/BareTaskHandle.hpp @@ -19,7 +19,7 @@ class BareTaskHandle { bool m_enabled; //!< Save the priority NATIVE_INT_TYPE m_priority; - //!< Function passed in to the task + //!< Function passed into the task Task::taskRoutine m_routine; //!< Argument input pointer void* m_argument; diff --git a/Os/Baremetal/TaskRunner/CMakeLists.txt b/Os/Baremetal/TaskRunner/CMakeLists.txt index e570279c4f..26ab1a5774 100644 --- a/Os/Baremetal/TaskRunner/CMakeLists.txt +++ b/Os/Baremetal/TaskRunner/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Os/CMakeLists.txt b/Os/CMakeLists.txt index 12bde1fcf1..2d5fa8bb3a 100644 --- a/Os/CMakeLists.txt +++ b/Os/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Os/Stubs/CMakeLists.txt b/Os/Stubs/CMakeLists.txt index a1c4cd3686..2a3ff41f98 100644 --- a/Os/Stubs/CMakeLists.txt +++ b/Os/Stubs/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/RPI/RpiDemo/CMakeLists.txt b/RPI/RpiDemo/CMakeLists.txt index 6b66fbe00d..ecfb698cf6 100644 --- a/RPI/RpiDemo/CMakeLists.txt +++ b/RPI/RpiDemo/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/RPI/Top/CMakeLists.txt b/RPI/Top/CMakeLists.txt index 598fbfd9ef..8b504f2f06 100644 --- a/RPI/Top/CMakeLists.txt +++ b/RPI/Top/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Ref/PingReceiver/CMakeLists.txt b/Ref/PingReceiver/CMakeLists.txt index 20be4c249d..16c15bd70f 100644 --- a/Ref/PingReceiver/CMakeLists.txt +++ b/Ref/PingReceiver/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Ref/RecvBuffApp/CMakeLists.txt b/Ref/RecvBuffApp/CMakeLists.txt index af7f7b9f71..d02e6346c1 100644 --- a/Ref/RecvBuffApp/CMakeLists.txt +++ b/Ref/RecvBuffApp/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Ref/SendBuffApp/CMakeLists.txt b/Ref/SendBuffApp/CMakeLists.txt index beadc881f1..c05f766586 100644 --- a/Ref/SendBuffApp/CMakeLists.txt +++ b/Ref/SendBuffApp/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Ref/SignalGen/CMakeLists.txt b/Ref/SignalGen/CMakeLists.txt index 64eea103d9..b382b9477c 100644 --- a/Ref/SignalGen/CMakeLists.txt +++ b/Ref/SignalGen/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Ref/Top/CMakeLists.txt b/Ref/Top/CMakeLists.txt index 9de37fec1a..fce5416991 100644 --- a/Ref/Top/CMakeLists.txt +++ b/Ref/Top/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies #### diff --git a/Svc/ActiveLogger/CMakeLists.txt b/Svc/ActiveLogger/CMakeLists.txt index 0521ef4012..b31e2a3103 100644 --- a/Svc/ActiveLogger/CMakeLists.txt +++ b/Svc/ActiveLogger/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/ActiveRateGroup/CMakeLists.txt b/Svc/ActiveRateGroup/CMakeLists.txt index ee845c6c64..012ddbb4cb 100644 --- a/Svc/ActiveRateGroup/CMakeLists.txt +++ b/Svc/ActiveRateGroup/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/ActiveTextLogger/CMakeLists.txt b/Svc/ActiveTextLogger/CMakeLists.txt index 9408619bb5..c9fecef4e5 100644 --- a/Svc/ActiveTextLogger/CMakeLists.txt +++ b/Svc/ActiveTextLogger/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/AssertFatalAdapter/CMakeLists.txt b/Svc/AssertFatalAdapter/CMakeLists.txt index a811de6118..03fd069f3e 100644 --- a/Svc/AssertFatalAdapter/CMakeLists.txt +++ b/Svc/AssertFatalAdapter/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/BufferLogger/CMakeLists.txt b/Svc/BufferLogger/CMakeLists.txt index 87f203baa6..4be8388af7 100644 --- a/Svc/BufferLogger/CMakeLists.txt +++ b/Svc/BufferLogger/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/BufferManager/CMakeLists.txt b/Svc/BufferManager/CMakeLists.txt index b14acdc062..24d060a050 100644 --- a/Svc/BufferManager/CMakeLists.txt +++ b/Svc/BufferManager/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/CmdDispatcher/CMakeLists.txt b/Svc/CmdDispatcher/CMakeLists.txt index bb7efe2fca..6820e752a5 100644 --- a/Svc/CmdDispatcher/CMakeLists.txt +++ b/Svc/CmdDispatcher/CMakeLists.txt @@ -2,7 +2,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/CmdSequencer/CMakeLists.txt b/Svc/CmdSequencer/CMakeLists.txt index 697a30b516..24d803b86a 100644 --- a/Svc/CmdSequencer/CMakeLists.txt +++ b/Svc/CmdSequencer/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/CmdSequencer/docs/sdd.md b/Svc/CmdSequencer/docs/sdd.md index ef85342ddf..b7262b74e6 100644 --- a/Svc/CmdSequencer/docs/sdd.md +++ b/Svc/CmdSequencer/docs/sdd.md @@ -43,7 +43,7 @@ pingIn|Svc::Ping|async input|Input ping call pingOut|Svc::Ping|output|Reply for ping schedIn|Svc::Sched|async input|Scheduler input - timed commands will be checked comCmdOut|Fw::Com|output|Sends command buffers for each command in sequence -cmdResponseIn|Fw::CmdResponse|asyc input|Received status of last dispatched command +cmdResponseIn|Fw::CmdResponse|async input|Received status of last dispatched command seqRunIn|Svc::CmdSeqIn|async input|Receives requests for running sequences from other components seqDone|Fw::CmdResponse|output|outputs status of sequence run; meant to be used with `seqRunIn` diff --git a/Svc/CmdSequencer/test/ut/SequenceFiles/File.hpp b/Svc/CmdSequencer/test/ut/SequenceFiles/File.hpp index 9d3c9bc365..63b1ddb52e 100644 --- a/Svc/CmdSequencer/test/ut/SequenceFiles/File.hpp +++ b/Svc/CmdSequencer/test/ut/SequenceFiles/File.hpp @@ -75,7 +75,7 @@ namespace Svc { //! Open errors Open open; - //! Heade read errors + //! Header read errors HeaderRead headerRead; //! Data read errors diff --git a/Svc/ComLogger/CMakeLists.txt b/Svc/ComLogger/CMakeLists.txt index f4b10998e1..7bc4413faa 100644 --- a/Svc/ComLogger/CMakeLists.txt +++ b/Svc/ComLogger/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/ComSplitter/CMakeLists.txt b/Svc/ComSplitter/CMakeLists.txt index 0e9d006698..6602453c53 100644 --- a/Svc/ComSplitter/CMakeLists.txt +++ b/Svc/ComSplitter/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/Cycle/CMakeLists.txt b/Svc/Cycle/CMakeLists.txt index 0f62a6a329..32dcbfa8c6 100644 --- a/Svc/Cycle/CMakeLists.txt +++ b/Svc/Cycle/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/Deframer/CMakeLists.txt b/Svc/Deframer/CMakeLists.txt index f9fd350047..c90079e115 100644 --- a/Svc/Deframer/CMakeLists.txt +++ b/Svc/Deframer/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/Fatal/CMakeLists.txt b/Svc/Fatal/CMakeLists.txt index 5eaf08a575..53c0e656f1 100644 --- a/Svc/Fatal/CMakeLists.txt +++ b/Svc/Fatal/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/FatalHandler/CMakeLists.txt b/Svc/FatalHandler/CMakeLists.txt index 27ae77a898..6b82bb5bfa 100644 --- a/Svc/FatalHandler/CMakeLists.txt +++ b/Svc/FatalHandler/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/FileDownlink/CMakeLists.txt b/Svc/FileDownlink/CMakeLists.txt index 19497b0002..74e0fd9be6 100644 --- a/Svc/FileDownlink/CMakeLists.txt +++ b/Svc/FileDownlink/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/FileDownlinkPorts/CMakeLists.txt b/Svc/FileDownlinkPorts/CMakeLists.txt index 1cf27cdfe7..c4216dd5ab 100644 --- a/Svc/FileDownlinkPorts/CMakeLists.txt +++ b/Svc/FileDownlinkPorts/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/FileManager/CMakeLists.txt b/Svc/FileManager/CMakeLists.txt index c50de22066..ef30c5d810 100644 --- a/Svc/FileManager/CMakeLists.txt +++ b/Svc/FileManager/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/FileUplink/CMakeLists.txt b/Svc/FileUplink/CMakeLists.txt index c8ef18f404..abcc81addc 100644 --- a/Svc/FileUplink/CMakeLists.txt +++ b/Svc/FileUplink/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/Framer/CMakeLists.txt b/Svc/Framer/CMakeLists.txt index c0b2c6c2a7..8de1326a00 100644 --- a/Svc/Framer/CMakeLists.txt +++ b/Svc/Framer/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/FramingProtocol/CMakeLists.txt b/Svc/FramingProtocol/CMakeLists.txt index 635f4c08e6..22bbe72408 100644 --- a/Svc/FramingProtocol/CMakeLists.txt +++ b/Svc/FramingProtocol/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/GenericHub/CMakeLists.txt b/Svc/GenericHub/CMakeLists.txt index a9d80fd76b..c540994354 100644 --- a/Svc/GenericHub/CMakeLists.txt +++ b/Svc/GenericHub/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Svc/GenericHub/docs/GenricHubExampleAppAi.xml b/Svc/GenericHub/docs/GenericHubExampleAppAi.xml similarity index 100% rename from Svc/GenericHub/docs/GenricHubExampleAppAi.xml rename to Svc/GenericHub/docs/GenericHubExampleAppAi.xml diff --git a/Svc/GenericRepeater/docs/GenricRepeaterAppAi.xml b/Svc/GenericRepeater/docs/GenericRepeaterAppAi.xml similarity index 100% rename from Svc/GenericRepeater/docs/GenricRepeaterAppAi.xml rename to Svc/GenericRepeater/docs/GenericRepeaterAppAi.xml diff --git a/Svc/GroundInterface/CMakeLists.txt b/Svc/GroundInterface/CMakeLists.txt index 7a13de6dc7..9ac1f9d0c4 100644 --- a/Svc/GroundInterface/CMakeLists.txt +++ b/Svc/GroundInterface/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/Health/CMakeLists.txt b/Svc/Health/CMakeLists.txt index cb38505b8a..85bb36c76b 100644 --- a/Svc/Health/CMakeLists.txt +++ b/Svc/Health/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/LinuxTime/CMakeLists.txt b/Svc/LinuxTime/CMakeLists.txt index 8683ede979..e278ae6ff8 100644 --- a/Svc/LinuxTime/CMakeLists.txt +++ b/Svc/LinuxTime/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/LinuxTimer/CMakeLists.txt b/Svc/LinuxTimer/CMakeLists.txt index 0482ff7500..0b505cfaca 100644 --- a/Svc/LinuxTimer/CMakeLists.txt +++ b/Svc/LinuxTimer/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Svc/PassiveConsoleTextLogger/CMakeLists.txt b/Svc/PassiveConsoleTextLogger/CMakeLists.txt index 5a26b4ca69..34587220d7 100644 --- a/Svc/PassiveConsoleTextLogger/CMakeLists.txt +++ b/Svc/PassiveConsoleTextLogger/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/Ping/CMakeLists.txt b/Svc/Ping/CMakeLists.txt index f2dd7ceb39..04567a4eaa 100644 --- a/Svc/Ping/CMakeLists.txt +++ b/Svc/Ping/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/PolyDb/CMakeLists.txt b/Svc/PolyDb/CMakeLists.txt index 74fe77f9c6..baf5524e08 100644 --- a/Svc/PolyDb/CMakeLists.txt +++ b/Svc/PolyDb/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/PolyIf/CMakeLists.txt b/Svc/PolyIf/CMakeLists.txt index 3f80a337ef..aa3ea93781 100644 --- a/Svc/PolyIf/CMakeLists.txt +++ b/Svc/PolyIf/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/PrmDb/CMakeLists.txt b/Svc/PrmDb/CMakeLists.txt index 42c616cc3d..2aa37c969c 100644 --- a/Svc/PrmDb/CMakeLists.txt +++ b/Svc/PrmDb/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/RateGroupDriver/CMakeLists.txt b/Svc/RateGroupDriver/CMakeLists.txt index 16a0130e57..d3e4d2eecd 100644 --- a/Svc/RateGroupDriver/CMakeLists.txt +++ b/Svc/RateGroupDriver/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/Sched/CMakeLists.txt b/Svc/Sched/CMakeLists.txt index 04a573d268..ead9650f1d 100644 --- a/Svc/Sched/CMakeLists.txt +++ b/Svc/Sched/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/Seq/CMakeLists.txt b/Svc/Seq/CMakeLists.txt index 3ad1b159ef..f887794fc1 100644 --- a/Svc/Seq/CMakeLists.txt +++ b/Svc/Seq/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/StaticMemory/CMakeLists.txt b/Svc/StaticMemory/CMakeLists.txt index 0838dfbd76..8b80148bf3 100644 --- a/Svc/StaticMemory/CMakeLists.txt +++ b/Svc/StaticMemory/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/SystemResources/CMakeLists.txt b/Svc/SystemResources/CMakeLists.txt index f7b2e5a07b..f5d65b1c6e 100644 --- a/Svc/SystemResources/CMakeLists.txt +++ b/Svc/SystemResources/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/Time/CMakeLists.txt b/Svc/Time/CMakeLists.txt index f90de3eb46..0241f89c63 100644 --- a/Svc/Time/CMakeLists.txt +++ b/Svc/Time/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/TlmChan/CMakeLists.txt b/Svc/TlmChan/CMakeLists.txt index 09f6fc3bbe..c2c564bcd1 100644 --- a/Svc/TlmChan/CMakeLists.txt +++ b/Svc/TlmChan/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/TlmPacketizer/CMakeLists.txt b/Svc/TlmPacketizer/CMakeLists.txt index 722637c07e..b4162cebd2 100644 --- a/Svc/TlmPacketizer/CMakeLists.txt +++ b/Svc/TlmPacketizer/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Svc/WatchDog/CMakeLists.txt b/Svc/WatchDog/CMakeLists.txt index a5ba4d7ea5..b155117329 100644 --- a/Svc/WatchDog/CMakeLists.txt +++ b/Svc/WatchDog/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # # Note: using PROJECT_NAME as EXECUTABLE_NAME diff --git a/Utils/Hash/CMakeLists.txt b/Utils/Hash/CMakeLists.txt index e58862fa6c..c04cec2859 100644 --- a/Utils/Hash/CMakeLists.txt +++ b/Utils/Hash/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/Utils/Types/CMakeLists.txt b/Utils/Types/CMakeLists.txt index 66051527a8..5e098fb115 100644 --- a/Utils/Types/CMakeLists.txt +++ b/Utils/Types/CMakeLists.txt @@ -1,7 +1,7 @@ #### # F prime CMakeLists.txt: # -# SOURCE_FILES: combined list of source and autocoding diles +# SOURCE_FILES: combined list of source and autocoding files # MOD_DEPS: (optional) module dependencies # #### diff --git a/docs/UsersGuide/dev/testAPI/user_guide.md b/docs/UsersGuide/dev/testAPI/user_guide.md index bedc06666f..e000c3ff6e 100644 --- a/docs/UsersGuide/dev/testAPI/user_guide.md +++ b/docs/UsersGuide/dev/testAPI/user_guide.md @@ -719,7 +719,7 @@ I see two options to address this: ### The openpyxl library has thrown WorkbookAlreadySaved error -While running unit tests on the API, there was an error thrown by openpyxl that caused the log to close early. The behavior wasn't able to be recreated, but the [Test Logger](../../../../Gds/src/fprime_gds/common/logger/test_logger.py) was updated to [catch the exception](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/logger/test_logger.py#L124) to prevent tests from failing due to the logger. +While running unit tests on the API, there was an error thrown by openpyxl that caused the log to close early. The behavior wasn't able to be recreated, but the [Test Logger](../../../../Gds/src/fprime_gds/common/logger/test_logger.py) was updated to [catch the exception](https://github.com/nasa/fprime/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/logger/test_logger.py#L124) to prevent tests from failing due to the logger. ~~~~ ___________________________________ APITestCases.test_find_history_item _________________________________ @@ -790,11 +790,11 @@ To fully resolve this would require being able to reproduce the issue and explai Recommendation for adding a csv logger to the TestLogger class: -1. Set up the csv log file in the constructor [here](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/logger/test_logger.py#L49). -2. Add a `_log_csv_row()` helper along similar lines to the `_get_ws_row()` helper [here](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/logger/test_logger.py#L159) -3. Log the start time at the top of the file like the excel output does [here](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/logger/test_logger.py#L85). -4. Log the column headers to csv like the excel does [here](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/logger/test_logger.py#L88). -5. Log messages in the lock block [here](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/logger/test_logger.py#L119). +1. Set up the csv log file in the constructor [here](https://github.com/nasa/fprime/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/logger/test_logger.py#L49). +2. Add a `_log_csv_row()` helper along similar lines to the `_get_ws_row()` helper [here](https://github.com/nasa/fprime/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/logger/test_logger.py#L159) +3. Log the start time at the top of the file like the excel output does [here](https://github.com/nasa/fprime/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/logger/test_logger.py#L85). +4. Log the column headers to csv like the excel does [here](https://github.com/nasa/fprime/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/logger/test_logger.py#L88). +5. Log messages in the lock block [here](https://github.com/nasa/fprime/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/logger/test_logger.py#L119). ## Idiosyncrasies @@ -805,7 +805,7 @@ In this document, idiosyncrasies refer to needed-improvements and future feature ### Timeout implementation -Presently timeouts are using the signal library and throw an exception to end the search. This timeout behavior can be modified very easily by changing the [__search_test_history](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/6cd4c8007a7f562d5b0b616eb494270ac5c7b95d/Gds/src/fprime_gds/common/testing_fw/api.py#L911) method. All searches use this method to accomplish scoping, logging and history substitution. Changing the timeout to something like below would be better. +Presently timeouts are using the signal library and throw an exception to end the search. This timeout behavior can be modified very easily by changing the [__search_test_history](https://github.com/nasa/fprime/blob/6cd4c8007a7f562d5b0b616eb494270ac5c7b95d/Gds/src/fprime_gds/common/testing_fw/api.py#L911) method. All searches use this method to accomplish scoping, logging and history substitution. Changing the timeout to something like below would be better. ~~~~{.python} # in IntegrationTestAPI's __search_test_history method on ~line 912 of api.py @@ -833,13 +833,13 @@ return searcher.get_return_value() In order to properly support ERT ordering, I recommend: -1. Add a TimeType field to the [SysData](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/data_types/sys_data.py#L19) class and add an accessor for `get_ert_time()`. +1. Add a TimeType field to the [SysData](https://github.com/nasa/fprime/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/data_types/sys_data.py#L19) class and add an accessor for `get_ert_time()`. 2. Have the GDS record ERT at some point. -3. Preserve the use of the `fsw_order` argument in the test API's [constructor](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/testing_fw/api.py#L29) and [sub-history](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/testing_fw/api.py#L244) functions by passing the fsw_order argument to the chronological [history constructor](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/history/chrono.py#L23). +3. Preserve the use of the `fsw_order` argument in the test API's [constructor](https://github.com/nasa/fprime/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/testing_fw/api.py#L29) and [sub-history](https://github.com/nasa/fprime/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/testing_fw/api.py#L244) functions by passing the fsw_order argument to the chronological [history constructor](https://github.com/nasa/fprime/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/history/chrono.py#L23). 4. Modify chronological history to choose whether to use `get_time()` or `get_ert_time()` for its ordering/returning operations: - - [clearing history](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/history/chrono.py#L111) - - `__insert_chrono()` [helper](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/history/chrono.py#L165) - - `__get_index()` [helper](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/history/chrono.py#L206) + - [clearing history](https://github.com/nasa/fprime/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/history/chrono.py#L111) + - `__insert_chrono()` [helper](https://github.com/nasa/fprime/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/history/chrono.py#L165) + - `__get_index()` [helper](https://github.com/nasa/fprime/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/history/chrono.py#L206) #### Better History Markers @@ -847,11 +847,11 @@ As part of the work to add ERT and have chronological histories work for both ER ### Color-coding interlaced Events in the API Log -One feature that wasn't completed this summer was to color-code interlaced event logs based on severity. Presently, interlacing events are implemented by making the API a consumer of the event decoder in the GDS and then filtering events. Modifying the color of these log messages can be done [here](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/testing_fw/api.py#L1258). +One feature that wasn't completed this summer was to color-code interlaced event logs based on severity. Presently, interlacing events are implemented by making the API a consumer of the event decoder in the GDS and then filtering events. Modifying the color of these log messages can be done [here](https://github.com/nasa/fprime/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/testing_fw/api.py#L1258). ### Moving StandardPipeline to API constructor -Presently, a user of the integration test API needs to instantiate the GDS manually before instantiating the API. This code should really be moved to inside the API. To do this, the IntegrationTestAPI's [constructor](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/d0309a9e265b8650ca6be03b9132dfdc682e0622/Gds/src/fprime_gds/common/testing_fw/api.py#L27) should be modified to include the pipeline instantiation and the API's [teardown](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/d0309a9e265b8650ca6be03b9132dfdc682e0622/Gds/src/fprime_gds/common/testing_fw/api.py#L64) method should be modified to disconnect from the F Prime deployment. +Presently, a user of the integration test API needs to instantiate the GDS manually before instantiating the API. This code should really be moved to inside the API. To do this, the IntegrationTestAPI's [constructor](https://github.com/nasa/fprime/blob/d0309a9e265b8650ca6be03b9132dfdc682e0622/Gds/src/fprime_gds/common/testing_fw/api.py#L27) should be modified to include the pipeline instantiation and the API's [teardown](https://github.com/nasa/fprime/blob/d0309a9e265b8650ca6be03b9132dfdc682e0622/Gds/src/fprime_gds/common/testing_fw/api.py#L64) method should be modified to disconnect from the F Prime deployment. #### Modification to the Integration Test API @@ -912,7 +912,7 @@ Currently the StandardPipeline (GDS Helper layer) uses a path to a directory to ### Better test identifiers using decorators -When a new test case [is started](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/testing_fw/api.py#L85), the API user can specify a `case_id` that will be used in the logs to identify the current test case without scrolling to the test case header. Future uses of the API should investigate using decorators to specify an ID to put in this column. Present tests just use a counter and assign a number to each test case. +When a new test case [is started](https://github.com/nasa/fprime/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/testing_fw/api.py#L85), the API user can specify a `case_id` that will be used in the logs to identify the current test case without scrolling to the test case header. Future uses of the API should investigate using decorators to specify an ID to put in this column. Present tests just use a counter and assign a number to each test case. ### GDS command arguments should allow non-string types