Fix more dead links

nasa · Apr 8, 2024 · 65b1d91 · 65b1d91
1 parent 7fbc7c8
commit 65b1d91
Show file tree

Hide file tree

Showing 25 changed files with 46 additions and 97 deletions.
diff --git a/.github/actions/spelling/README.md b/.github/actions/spelling/README.md
@@ -5,7 +5,6 @@ File | Purpose | Format | Info
 [allow.txt](allow.txt) | Add words to the dictionary | one word per line (only letters and `'`s allowed) | [allow](https://github.com/check-spelling/check-spelling/wiki/Configuration#allow)
 [reject.txt](reject.txt) | Remove words from the dictionary (after allow) | grep pattern matching whole dictionary words | [reject](https://github.com/check-spelling/check-spelling/wiki/Configuration-Examples%3A-reject)
 [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)

diff --git a/.github/actions/spelling/advice.md b/.github/actions/spelling/advice.md
@@ -9,8 +9,7 @@ If items relate to a ...
   File paths are Perl 5 Regular Expressions - you can [test](
 https://www.regexplanet.com/advanced/perl/) yours before committing to verify it will match your files.
 
-  `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude [README.md](
-../tree/HEAD/README.md) (on whichever branch you're using).
+  `^` refers to the file's path from the root of the repository, so `^README\.md$` would exclude README.md (on whichever branch you're using).
 
 * well-formed pattern.
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -74,8 +74,7 @@ Contributors to the [fprime](https://github.com/nasa/fprime) repository should u
 F´ follows a standard git flow development model. Developers should start with a
 [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) of one of the F´ repositories and then develop
 according to [git flow](https://docs.github.com/en/get-started/quickstart/github-flow). Remember to add an
-[upstream remote](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork)
-to your fork such that you may fetch the latest changes.
+upstream remote to your fork such that you may fetch the latest changes.
 
 For each contribution, developers should first fetch the latest changes from upstream. Then create a new branch off
 `devel` and submit back to F´ using a pull request as described above.

diff --git a/Ref/PingReceiver/docs/sdd.md b/Ref/PingReceiver/docs/sdd.md
@@ -26,8 +26,6 @@ The `Ref::PingReceiver` component has the following component diagram:
 
 ## 4. Dictionaries
 
-Dictionaries: [HTML](PingReceiver.html) [MD](PingReceiver.md)
-
 ## 5. Module Checklists
 
 ## 6. Unit Testing

diff --git a/Ref/README.md b/Ref/README.md
@@ -63,7 +63,7 @@ cd fprime/Ref/build-artifacts/<platform>/bin/
 - The F´ utility's build command can build individual components too.
 - The 'generate' command can take a toolchain argument for quickly generating a cross-compile `fprime-util generate raspberrypi` for example.
 
-Further work with the F´ utility can be found in the [Getting Started](../docs/Tutorials/HelloWorld/Tutorial.md) tutorial. Other tutorials
+Further work with the F´ utility can be found in the [Getting Started](../docs/Tutorials/README.md) tutorial. Other tutorials
 for many aspects of F´ are available [here](../docs/Tutorials/README.md).
 
 
diff --git a/Ref/RecvBuffApp/docs/sdd.md b/Ref/RecvBuffApp/docs/sdd.md
@@ -26,8 +26,6 @@ The `Ref::RecvBuffApp` component has the following component diagram:
 
 ## 4. Dictionaries
 
-Dictionaries: [HTML](RecvBuff.html) [MD](RecvBuff.md)
-
 ## 5. Module Checklists
 
 ## 6. Unit Testing

diff --git a/Ref/SendBuffApp/docs/sdd.md b/Ref/SendBuffApp/docs/sdd.md
@@ -26,8 +26,6 @@ The `Ref::SendBuffApp` component has the following component diagram:
 
 ## 4. Dictionaries
 
-Dictionaries: [HTML](SendBuff.html) [MD](SendBuff.md)
-
 ## 5. Module Checklists
 
 ## 6. Unit Testing

diff --git a/Svc/ActiveRateGroup/docs/sdd.md b/Svc/ActiveRateGroup/docs/sdd.md
@@ -35,7 +35,7 @@ The `Svc::ActiveRateGroup` component uses the following port types:
 
 Port Data Type | Name | Direction | Kind | Usage
 -------------- | ---- | --------- | ---- | -----
-[`Svc::Cycle`](../../Cycle/docs/sdd.md) | CycleIn | Input | Asynchronous | Receive a call to run one cycle of the rate group
+[`Svc::Cycle`](../../Sched/docs/sdd.md) | CycleIn | Input | Asynchronous | Receive a call to run one cycle of the rate group
 [`Svc::Sched`](../../Sched/docs/sdd.md) | RateGroupMemberOut | Output | n/a | Rate group ports
 
 #### 3.2 Functional Description
@@ -98,7 +98,7 @@ Document | Link
 -------- | ----
 Design Checklist | [Link](Checklist_Design.xlsx)
 Code Checklist | [Link](Checklist_Code.xlsx)
-Unit Test Checklist | [Link](Checklist_Unit_Test.xlsx)
+Unit Test Checklist | [Link](Checklist_Unit_Test.xls)
 
 ## 6. Unit Testing
 

diff --git a/Svc/ActiveTextLogger/docs/sdd.md b/Svc/ActiveTextLogger/docs/sdd.md
@@ -27,7 +27,7 @@ ISF-ATL-006 | The `Svc::ActiveTextLogger` component shall attempt to create a ne
 
 The `Svc::ActiveTextLogger` component has the following component diagram:
 
-![`Svc::ActiveTextLogger` Diagram](img/ActiveTextLoggerBDD.jpg "Svc::ActiveTextLogger")
+> TODO
 
 #### 3.1.2 Ports
 
@@ -61,25 +61,11 @@ TODO
 
 ## 4. Dictionaries
 
-[Dictionaries](ActiveTextLogger.html)
-
 ## 5. Module Checklists
 
-Document | Link
--------- | ----
-Design Checklist | [Link](Checklist_Design.xlsx)
-Code Checklist | [Link](Checklist_Code.xlsx)
-Unit Test Checklist | [Link](Checklist_Unit_test.xlsx)
-
 ## 6. Unit Testing
 
-[Unit Test Output](../test/ut/output/test.txt)
-
-[Coverage Output - `ActiveTextLoggerImpl.cpp`](../test/ut/output/ActiveTextLoggerImpl.cpp.gcov)
-
-[Coverage Output - `ActiveTextLoggerComponentAc.cpp`](../test/ut/output/ActiveTextLoggerComponentAc.cpp.gcov)
-
-[Report](../test/ut/output/SvcActiveTextLogger_gcov.txt)
+To see unit test coverage run fprime-util check --coverage
 
 ## 7. Change Log
 

diff --git a/Svc/CmdDispatcher/docs/sdd.md b/Svc/CmdDispatcher/docs/sdd.md
@@ -99,10 +99,6 @@ sequenceDiagram
 
 `Svc::CmdDispatcher` has no significant algorithms.
 
-## 4. Dictionary
-
-Dictionaries: [HTML](CmdDispatcher.html)
-
 ## 4. Module Checklists
 
 Document | Link

diff --git a/Svc/CmdSequencer/docs/sdd.md b/Svc/CmdSequencer/docs/sdd.md
@@ -236,7 +236,7 @@ A utility is provided that will convert a text file listing of commands and thei
 
 It can be run by invoking:
 
-`Gse/bin/run_tinyseqgen.sh <input text file>`
+`fprime-seqgen --help`
 
 The syntax of the file is as follows:
 
@@ -296,7 +296,7 @@ where:
 
 Note that the time is encoded in UTC with an epoch of 1/1/1970.
 
-An example can be seen in [Gse/bin/simple_sequence.seq](../../../Gse/bin/simple_sequence.seq)
+An example can be seen in the F´ GDS repository under `examples/`: https://github.com/fprime-community/fprime-gds/tree/devel/examples
 
 ### 3.4 Component State
 

diff --git a/Svc/FatalHandler/docs/sdd.md b/Svc/FatalHandler/docs/sdd.md
@@ -23,15 +23,15 @@ FH-002 | The `Svc::FatalHandler` component shall suspend the thread calling FATA
 
 The `Svc::FatalHandler` component has the following component diagram:
 
-![`Svc::CmdDispatcher` Diagram](img/CommandDispatcherBDD.jpg "Svc::CmdDispatcher")
+> TODO
 
 #### 3.1.2 Ports
 
 The `Svc::FatalHandler` component uses the following port types:
 
 Port Data Type | Name | Direction | Kind | Usage
 -------------- | ---- | --------- | ---- | -----
-[`Svc::Fatal`](../Fatal/docs/sdd.md) | FatalReceive | Input | Synch | Receive FATAL notifications
+[`Svc::Fatal`](../../Fatal/docs/sdd.md) | FatalReceive | Input | Synch | Receive FATAL notifications
 
 ### 3.2 Functional Description
 
@@ -43,7 +43,7 @@ For Unix variants, it delays for one second before exiting with a segmentation f
 
 The `Svc::FatalHandler` handles FATAL notifications:
 
-![FATAL Notification](img/FatalNotification.jpg) 
+![FATAL Notification](../../Fatal/docs/img/FatalEvent.jpg) 
 
 ### 3.4 State
 
@@ -59,21 +59,9 @@ TBD
 
 ## 4. Module Checklists
 
-Document | Link
--------- | ----
-Design Checklist | [Link](Checklist_Design.xlsx)
-Code Checklist | [Link](Checklist_Code.xlsx)
-Unit Test Checklist | [Link](Checklist_Unit_Test.xls)
-
 ## 5. Unit Testing
 
-[Unit Test Output](../test/ut/output/test.txt)
-
-[Coverage Summary](../test/ut/output/SvcCmdDispatcher_gcov.txt)
-
-[Coverage Output - `CommandDispatcherImpl.cpp`](../test/ut/output/CommandDispatcherImpl.cpp.gcov)
-
-[Coverage Output - `CommandDispatcherComponentAc.cpp`](../test/ut/output/CommandDispatcherComponentAc.cpp.gcov)
+To see unit test coverage run fprime-util check --coverage
 
 ## 6. Change Log
 

diff --git a/Svc/Health/docs/sdd.md b/Svc/Health/docs/sdd.md
@@ -83,7 +83,7 @@ Document | Link
 -------- | ----
 Design Checklist | [Link](Checklist_Design.xlsx)
 Code Checklist | [Link](Checklist_Code.xlsx)
-Unit Test Checklist | [Link](Checklist_Unit_test.xls)
+Unit Test Checklist | [Link](Checklist_Unit_Test.xls)
 
 ## 6. Unit Testing
 The Health unit tests are designed to test interfaces and functionality with the available ports, command processing, telemetry output, EVR and data product generation.

diff --git a/Svc/PolyDb/docs/sdd.md b/Svc/PolyDb/docs/sdd.md
@@ -71,7 +71,7 @@ Document | Link
 -------- | ----
 Design Checklist | [Link](Checklist_Design.xlsx)
 Code Checklist | [Link](Checklist_Design.xlsx)
-Unit Test Checklist | [Link](Checklist_Unit_Test.xlsx)
+Unit Test Checklist | [Link](Checklist_Unit_Test.xls)
 
 ## 5. Unit Testing
 

diff --git a/Svc/PrmDb/docs/sdd.md b/Svc/PrmDb/docs/sdd.md
@@ -86,7 +86,7 @@ Document | Link
 -------- | ----
 Design Checklist | [Link](Checklist_Design.xlsx)
 Code Checklist | [Link](Checklist_Code.xlsx)
-Unit Test Checklist | [Link](Checklist_Unit_Test.xlsx)
+Unit Test Checklist | [Link](Checklist_Unit_Test.xls)
 
 ## 5. Dictionary
 

diff --git a/Svc/RateGroupDriver/docs/sdd.md b/Svc/RateGroupDriver/docs/sdd.md
@@ -32,8 +32,8 @@ The Svc::RateGroupDriver component uses the following port types:
 
 Port Data Type | Name | Direction | Kind | Usage
 -------------- | ---- | --------- | ---- | -----
-[`Svc::Cycle`](../Sched/docs/sdd.md) | CycleIn | Input | Synchronous | Receive the system tick
-[`Svc::Cycle`](../Sched/docs/sdd.md) | CycleOut| Output | n/a | Used to drive rate groups
+[`Svc::Cycle`](../../Sched/docs/sdd.md) | CycleIn | Input | Synchronous | Receive the system tick
+[`Svc::Cycle`](../../Sched/docs/sdd.md) | CycleOut| Output | n/a | Used to drive rate groups
 
 #### 3.2 Functional Description
 
@@ -86,7 +86,7 @@ Document | Link
 -------- | ----
 Design Checklist | [Link](Checklist_Design.xlsx)
 Code Review Checklist | [Link](Checklist_Code.xlsx)
-Unit Test Checklist | [Link](Checklist_Unit_Test.xlsx)
+Unit Test Checklist | [Link](Checklist_Unit_Test.xls)
 
 ## 6. Unit Testing
 

diff --git a/Svc/TlmChan/docs/sdd.md b/Svc/TlmChan/docs/sdd.md
@@ -81,7 +81,7 @@ Document | Link
 -------- | ----
 Design Checklist | [Link](Checklist_Design.xlsx)
 Code Checklist  | [Link](Checklist_Code.xlsx)
-Unit Test Checklist  | [Link](Checklist_Unit_Test.xlsx)
+Unit Test Checklist  | [Link](Checklist_Unit_Test.xls)
 
 ## 6. Unit Testing
 

diff --git a/Svc/TlmPacketizer/docs/sdd.md b/Svc/TlmPacketizer/docs/sdd.md
@@ -52,7 +52,7 @@ When a call to the `Run()` interface is called, the packet writes are locked and
 
 This diagram shows the scenario where telemetry channels are written to packets:
 
-![External User Scenario](img/ExternalUserScenario.jpg) 
+> TODO
 
 ### 3.4 State
 
@@ -65,23 +65,11 @@ A configuration value in `TlmPacketizerImplCfg.h` defines a set of hash buckets
 
 ## 4. Dictionaries
 
-Dictionaries: [HTML](TlmPacketizer.html) [MD](TlmPacketizer.md)
-
 ## 5. Module Checklists
 
-Document | Link
--------- | ----
-Design Checklist | [Link](Checklist_Design.xlsx)
-Code Checklist  | [Link](Checklist_Code.xlsx)
-Unit Test Checklist  | [Link](Checklist_Unit_Test.xlsx)
-
 ## 6. Unit Testing
 
-File | Contents
----- | --------
-Unit Test Output | [Link](../test/ut/output/output.txt)
-Coverage - TlmPacketizerComponentImpl.cpp | [Link](../test/ut/output/TlmChanImpl.cpp.gcov)
-Coverage - TlmPacketizerComponentAc.cpp | [Link](../test/ut/output/TlmPacketizerComponentAc.cpp.gcov)
+To see unit test coverage run fprime-util check --coverage
 
 ## 7. Change Log
 

diff --git a/docs/Tutorials/GpsTutorial/Tutorial.md b/docs/Tutorials/GpsTutorial/Tutorial.md
@@ -22,8 +22,8 @@ for use as a demo or to help debug issues that come up when going through the tu
 
 ## Prerequisites
 
-This tutorial assumes the user has gone through and understood [Getting Started Tutorial](../HelloWorld/Tutorial.md)
-and [MathComponent Tutorial](../MathComponent/Tutorial.md)
+This tutorial assumes the user has gone through and understood [HelloWorld Tutorial](../README.md)
+and [MathComponent Tutorial](../README.md)
 
 This tutorial requires the user to have some basic software skills and have installed F´. The prerequisite skills to
 understand this tutorial are as follows:
@@ -35,7 +35,7 @@ understand this tutorial are as follows:
 
 Installation can be done by following the installation guide found at: [INSTALL.md](../../INSTALL.md). This guide
 will walk the user through the installation process and verify the installation. In addition, users may wish to
-follow the [Getting Started Tutorial](../HelloWorld/Tutorial.md) in order to get a feel for the F´ environment and
+follow the [HelloWorld Tutorial](../README.md) in order to get a feel for the F´ environment and
 tools.
 
 ## Creating a Custom F´ Component
@@ -853,12 +853,12 @@ which represents our software.
 Sample versions of these files are provided below and are annotated with comments representing the changes
 made to support the Gps Application. **Note:** These files are available in a working repository at:
 [https://github.com/LeStarch/fprime/tree/gps-application](https://github.com/LeStarch/fprime/tree/gps-application)
-in case the user prefers a direct checkout of working code.  The files are linked below:
+in case the user prefers a direct checkout of working code.  The files are listed below:
 
-1. [Top/GpsAppTopologyAi.xml](GpsApp/Top/GpsAppTopologyAppAi.xml)
-2. [Top/Components.hpp](GpsApp/Top/Components.hpp)
-3. [Top/Topology.cpp](GpsApp/Top/Topology.cpp)
-4. [Top/Main.cpp](GpsApp/Top/Main.cpp)
+1. `GpsApp/Top/GpsAppTopologyAi.xml`
+2. `GpsApp/Top/Components.hpp`
+3. `GpsApp/Top/Topology.cpp`
+4. `GpsApp/Top/Main.cpp`
 
 
 We will also need to update the `CMakeLists.txt` in the `Top` directory to change the name of "RefTopologyAppAi.xml" to
@@ -902,7 +902,7 @@ If you see output similar to the following, when running with the USB GPS you ha
 development of our tutorial. We'll discuss how to cross compile for the Raspberry PI and run on the Raspberry pi next.
 
 Once the ground system loads in the user's browser, the user can start seeing what the software is doing. If it doesn't
-load, then the user should go navigate to: https://localhost:5000.
+load, then the user should go navigate to: `https://localhost:5000`.
 
 First, click on the "Channels" tab at the top. The user should at least see the "rateGroup1Comp.RgMaxTime" channel. If
 the GPS is working and has lock, then the user should see the GPS channels as well. This is seen below.  Later we will

diff --git a/docs/UsersGuide/dev/baremetal-multicore.md b/docs/UsersGuide/dev/baremetal-multicore.md
@@ -85,7 +85,7 @@ design active components. It is impractical to assume that all projects can, at
 use of the framework provided **Active Components**.  Thus F´ was augmented with the ability to virtualize threading, such
 that projects could use these components during development as they migrate to a fully passive-component system.
 
-To activate this feature see: [Configuring F´](../user/configuration.md). Continue reading for all the fancy details of
+To activate this feature see: [Configuring F´](../dev/configuring-fprime.md). Continue reading for all the fancy details of
 how this system is designed.  TODO: put a link to the thread scheduler API documentation.
 
 ### Defining Custom Tasks

diff --git a/docs/UsersGuide/dev/testAPI/markdown/histories.md b/docs/UsersGuide/dev/testAPI/markdown/histories.md
@@ -11,7 +11,7 @@ Presently there are several implementations of history within the GDS. They are
 
 # History (superclass)
 
-[history.py](../../../../../src/fprime_gds/common/history/history.py)
+[history.py](https://github.com/fprime-community/fprime-gds/blob/devel/src/fprime_gds/common/history/history.py)
 
 An ordered history that defines what interfaces a history should have within the GDS
 
@@ -85,7 +85,7 @@ Accessor for the number of objects in the history
 
 ChronologicalHistory is the primary history of the Test API.
 
-[chrono.py](../../../../../src/fprime_gds/common/history/chrono.py)
+[chrono.py](https://github.com/fprime-community/fprime-gds/blob/devel/src/fprime_gds/common/history/chrono.py)
 
 A chronologically-ordered history that relies on predicates to provide filtering, searching, and
 retrieval operations. This history will re-order itself based on FSW time.
@@ -234,7 +234,7 @@ Returns:
 
 Test History is an optional history for the IntegrationTestAPI. It supports predicate searching and maintains the object order it was enqueued with.
 
-[test.py](../../../../../src/fprime_gds/common/history/test.py)
+[test.py](https://github.com/fprime-community/fprime-gds/blob/devel/src/fprime_gds/common/history/test.py)
 
 A receive-ordered history that relies on predicates to provide filtering, searching, and
 retrieval operations
@@ -351,7 +351,7 @@ Returns:
 
 Ram history is used by the Standard Pipeline making it the default history for several GDS Tools.
 
-[ram.py](../../../../../src/fprime_gds/common/history/ram.py)
+[ram.py](https://github.com/fprime-community/fprime-gds/blob/devel/src/fprime_gds/common/history/ram.py)
 
 A simple implementation of a history that maintains items in RAM. This is used for simplicity, but isn’t exactly
 robust nor persistent. Given that it is in the RAM, it is driven from the decoders object, which should run off the
@@ -413,7 +413,7 @@ Returns:
 
 |Quick Links|
 |:----------|
-|[Integration Test API User Guide](../../../user_guide.md)|
+|[Integration Test API User Guide](../user_guide.md)|
 |[GDS Overview](../../../../../README.md)|
 |[Integration Test API](integration_test_api.md)|
 |[Histories](histories.md)|