From 30f17384cf4ff3cbc1a31c4ebcbabfd688cb2cee Mon Sep 17 00:00:00 2001 From: Rob Bocchino Date: Tue, 21 Jan 2025 18:00:30 -0800 Subject: [PATCH] Revise links to F Prime docs --- docs/fpp-users-guide.html | 55 ++++++++++--------- .../Analyzing-and-Translating-Models.adoc | 9 ++- .../Defining-Component-Instances.adoc | 4 +- docs/users-guide/Defining-Components.adoc | 36 ++++++------ docs/users-guide/Defining-State-Machines.adoc | 2 +- docs/users-guide/Introduction.adoc | 2 +- 6 files changed, 55 insertions(+), 53 deletions(-) diff --git a/docs/fpp-users-guide.html b/docs/fpp-users-guide.html index 719b10de0..7388c5b7a 100644 --- a/docs/fpp-users-guide.html +++ b/docs/fpp-users-guide.html @@ -753,7 +753,7 @@

1. Introduction

FPP is a modeling language for the F Prime flight software framework. For more detailed information about F Prime, see the -F Prime User Manual.

+F Prime User Manual.

The goals of FPP are as follows:

@@ -3632,7 +3632,7 @@

9.1. Writing of FPP state machines. For more details about the C++ code generation for state machines, see the -F +F Prime design documentation.

@@ -5791,7 +5791,7 @@

10.2.1. Basic P base class with a virtual handler function, and then override that virtual function in a derived class that you write. For further details about implementing F Prime components, see the -F Prime User Manual.

+F Prime User Manual.

Note on terminology: As explained above, there is a technical @@ -6086,7 +6086,7 @@

10.2.6. Serial This flexibility comes at the cost that you lose the type compile-time type checking provided by port connections with named types. For more information about serial ports and their use, see -the F Prime User Manual.

+the F Prime User Manual.

@@ -6225,7 +6225,7 @@

10.3.1. Comman

For further information about command registration, receipt, and response, and implementing command handlers, see the -F Prime User Manual.

+F Prime User Manual.

@@ -6306,7 +6306,7 @@

10.3.2. Event Po

For further information about events in F Prime, see the -F Prime User Manual.

+F Prime User Manual.

@@ -6355,7 +6355,7 @@

10.3.3. Tele

For further information about telemetry in F Prime, see the -F Prime User Manual.

+F Prime User Manual.

@@ -6440,7 +6440,7 @@

10.3.4. Para

For further information about parameters in F Prime, see the -F Prime User Manual.

+F Prime User Manual.

@@ -6490,7 +6490,7 @@

10.3.5. Time

For further information about time in F Prime, see the -F Prime User Manual.

+F Prime User Manual.

@@ -6613,7 +6613,7 @@

10.3.6. D

For further information about data products in F Prime, see the -F +F Prime design documentation.

@@ -6758,7 +6758,7 @@

10.5. Commands

For complete information about F Prime command dispatch and handling, see the -F Prime User Manual. +F Prime User Manual. Here we concentrate on how to specify commands in FPP.

@@ -7121,7 +7121,7 @@

10.6. Events

For complete information about F Prime event handling, see the -F Prime User Manual. +F Prime User Manual. Here we concentrate on how to specify events in FPP.

@@ -7420,7 +7420,7 @@

10.6.4. Throttling

emit the event until the throttling is canceled. Typically, the canceling happens via a FSW command. For details, see the -F Prime User Manual.

+F Prime User Manual.

@@ -7441,7 +7441,7 @@

10.7. Telemetry

For complete information about F Prime telemetry handling, see the -F Prime User Manual. +F Prime User Manual. Here we concentrate on how to specify telemetry channels in FPP.

@@ -7801,7 +7801,7 @@

10.8. Parameters

database component for storing parameters in a non-volatile manner (e.g., on a file system). For complete information about F Prime parameters, see the -F Prime User Manual. +F Prime User Manual. Here we concentrate on how to specify parameters in FPP.

@@ -8132,7 +8132,7 @@

10.9. Data Products

(2) writing data products to the file system; and (3) cataloging stored data products for downlink in priority order. For more information about these F Prime features, see the -F +F Prime design documentation.

@@ -8146,8 +8146,8 @@

10.9.1. Basic Dat representing a list of serialized records. A record is a unit of data. For a complete specification of the container format, see the -F -Prime design documentation.

+F Prime design +documentation.

In an F Prime component, you can specify one or more containers @@ -8212,7 +8212,7 @@

10.9.1. Basic Dat

The FPP back end uses this specification to generate code for requesting buffers to hold containers and for serializing records into containers. See the -F +F Prime design documentation for the details.

@@ -8453,7 +8453,7 @@

10.10. State Machine Instan machine definitions may be internal (specified in FPP) or external (specified by an external tool). For more details about the C++ code generation for instances of internal state machines, see the -F +F Prime design documentation.

@@ -8847,7 +8847,9 @@

F Prime +documentation.) We have given the component two telemetry channels: ImpulseTemp for reporting the temperature of the impulse engine, and WarpTemp for reporting the temperature of the warp core.

@@ -12985,13 +12987,13 @@

Once you generate C++ code for these definitions, you can use it to write a flight software implementation. -The F +The F User Manual explains how to do this.

For more information about the generated code for data products, for state machines, and for state machine instances, see the -F +F Prime design documentation.

@@ -13003,8 +13005,7 @@

F -Prime User Manual.

+the F Prime User Manual.

Generating implementation templates: @@ -13979,7 +13980,7 @@

14.8. G T TopologyDictionary.json. The dictionary is specified in JavaScript Object Notation (JSON) format. The JSON format is specified in the -F +F Prime design documentation.

@@ -14814,7 +14815,7 @@

-Last updated 2025-01-21 17:34:15 -0800 +Last updated 2025-01-21 17:59:02 -0800

diff --git a/docs/users-guide/Analyzing-and-Translating-Models.adoc b/docs/users-guide/Analyzing-and-Translating-Models.adoc index 08f33824c..6632bb283 100644 --- a/docs/users-guide/Analyzing-and-Translating-Models.adoc +++ b/docs/users-guide/Analyzing-and-Translating-Models.adoc @@ -566,12 +566,12 @@ uses the name `A_B_CComponentAc_HPP` in its include guard. Once you generate {cpp} code for these definitions, you can use it to write a flight software implementation. -The https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F +The https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F User Manual] explains how to do this. For more information about the generated code for data products, for state machines, and for state machine instances, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/state-machines/[F +https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/state-machines/[F Prime design documentation]. ==== Component Implementation and Unit Test Code @@ -581,8 +581,7 @@ or partial implementations and for generating unit test code. Here we cover the mechanics of using these options. For more information on implementing and testing components in F Prime, see -the https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F -Prime User Manual]. +the https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual]. *Generating implementation templates:* When you run `fpp-to-cpp` with option `-t` and without option `-u`, @@ -1361,7 +1360,7 @@ file _T_ `TopologyDictionary.json`. The dictionary is specified in JavaScript Object Notation (JSON) format. The JSON format is specified in the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/fpp-json-dict/[F +https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/fpp-json-dict/[F Prime design documentation]. Here is a common use case: diff --git a/docs/users-guide/Defining-Component-Instances.adoc b/docs/users-guide/Defining-Component-Instances.adoc index f7b8aa0cc..bc9f10b59 100644 --- a/docs/users-guide/Defining-Component-Instances.adoc +++ b/docs/users-guide/Defining-Component-Instances.adoc @@ -84,7 +84,9 @@ a schedule input port for driving the component periodically on a rate group, a time get port for getting the time, and a telemetry port for reporting telemetry. (For more information on rate groups and the use of `Svc.Sched` -ports, see the F Prime documentation.) +ports, see the +https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/rate-group/[F Prime +documentation].) We have given the component two telemetry channels: `ImpulseTemp` for reporting the temperature of the impulse engine, and `WarpTemp` for reporting the temperature of the warp core. diff --git a/docs/users-guide/Defining-Components.adoc b/docs/users-guide/Defining-Components.adoc index e0ccee9dd..1e791e7d6 100644 --- a/docs/users-guide/Defining-Components.adoc +++ b/docs/users-guide/Defining-Components.adoc @@ -142,7 +142,7 @@ For example, in the {cpp} implementation, you would generate a base class with a virtual handler function, and then override that virtual function in a derived class that you write. For further details about implementing F Prime components, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F Prime User Manual]. +https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual]. *Note on terminology:* As explained above, there is a technical distinction between a _port type_ (defined outside any component, and providing @@ -405,7 +405,7 @@ on that side. This flexibility comes at the cost that you lose the type compile-time type checking provided by port connections with named types. For more information about serial ports and their use, see -the https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F Prime User Manual]. +the https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual]. === Special Port Instances @@ -507,7 +507,7 @@ properly with F Prime {cpp} code generation. For further information about command registration, receipt, and response, and implementing command handlers, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F Prime User Manual]. +https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual]. ==== Event Ports @@ -566,7 +566,7 @@ module Fw { -------- For further information about events in F Prime, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F Prime User Manual]. +https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual]. ==== Telemetry Ports @@ -609,7 +609,7 @@ module Fw { -------- For further information about telemetry in F Prime, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F Prime User Manual]. +https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual]. ==== Parameter Ports @@ -671,7 +671,7 @@ module Fw { -------- For further information about parameters in F Prime, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F Prime User Manual]. +https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual]. ==== Time Get Ports @@ -715,7 +715,7 @@ module Fw { -------- For further information about time in F Prime, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F Prime User Manual]. +https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual]. ==== Data Product Ports @@ -811,7 +811,7 @@ module Fw { -------- For further information about data products in F Prime, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/data-products/[F +https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/data-products/[F Prime design documentation]. @@ -944,7 +944,7 @@ as part of the component implementation. For complete information about F Prime command dispatch and handling, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F Prime User Manual]. +https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual]. Here we concentrate on how to specify commands in FPP. ==== Basic Commands @@ -1271,7 +1271,7 @@ you can store in an on-board file system or send to the ground. For complete information about F Prime event handling, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F Prime User Manual]. +https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual]. Here we concentrate on how to specify events in FPP. ==== Basic Events @@ -1545,7 +1545,7 @@ Once an event is throttled, the component instance will no longer emit the event until the throttling is canceled. Typically, the canceling happens via a FSW command. For details, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F Prime User Manual]. +https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual]. === Telemetry @@ -1562,7 +1562,7 @@ or send them the ground. For complete information about F Prime telemetry handling, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F Prime User Manual]. +https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual]. Here we concentrate on how to specify telemetry channels in FPP. ==== Basic Telemetry @@ -1890,7 +1890,7 @@ F Prime has special support for parameters, including a parameter database component for storing parameters in a non-volatile manner (e.g., on a file system). For complete information about F Prime parameters, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F Prime User Manual]. +https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual]. Here we concentrate on how to specify parameters in FPP. ==== Basic Parameters @@ -2199,7 +2199,7 @@ for (1) managing buffers that can store data products in memory; (2) writing data products to the file system; and (3) cataloging stored data products for downlink in priority order. For more information about these F Prime features, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/data-products/[F +https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/data-products/[F Prime design documentation]. ==== Basic Data Products @@ -2212,8 +2212,8 @@ the container (e.g., the size of the data payload), and binary data representing a list of serialized *records*. A record is a unit of data. For a complete specification of the container format, see the -https://fprime.jpl.nasa.gov/devel/documentation/reference/sdd/Fw/Dp/docs/sdd/[F -Prime design documentation]. +https://fprime.jpl.nasa.gov/latest/Fw/Dp/docs/sdd/[F Prime design +documentation]. In an F Prime component, you can specify one or more containers and one or more records. @@ -2275,7 +2275,7 @@ passive component BasicDataProducts { The FPP back end uses this specification to generate code for requesting buffers to hold containers and for serializing records into containers. See the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/data-products/[F +https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/data-products/[F Prime design documentation] for the details. Note the following: @@ -2495,7 +2495,7 @@ As discussed machine definitions may be internal (specified in FPP) or external (specified by an external tool). For more details about the {cpp} code generation for instances of internal state machines, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/state-machines/[F +https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/state-machines/[F Prime design documentation]. === Constants, Types, Enums, and State Machines diff --git a/docs/users-guide/Defining-State-Machines.adoc b/docs/users-guide/Defining-State-Machines.adoc index c08202aa2..1110279bb 100644 --- a/docs/users-guide/Defining-State-Machines.adoc +++ b/docs/users-guide/Defining-State-Machines.adoc @@ -87,7 +87,7 @@ In this manual, we focus on the syntax and high-level behavior of FPP state machines. For more details about the {cpp} code generation for state machines, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/design/state-machines/[F +https://fprime.jpl.nasa.gov/latest/docs/user-manual/design/state-machines/[F Prime design documentation]. === States, Signals, and Transitions diff --git a/docs/users-guide/Introduction.adoc b/docs/users-guide/Introduction.adoc index ad8cce195..e8a099f50 100644 --- a/docs/users-guide/Introduction.adoc +++ b/docs/users-guide/Introduction.adoc @@ -4,7 +4,7 @@ This document describes **F Prime Prime**, also known as FPP or F Double Prime. FPP is a modeling language for the https://fprime.jpl.nasa.gov[F Prime flight software framework]. For more detailed information about F Prime, see the -https://fprime.jpl.nasa.gov/devel/documentation/user-manual/[F Prime User Manual]. +https://fprime.jpl.nasa.gov/latest/docs/user-manual/[F Prime User Manual]. The goals of FPP are as follows: