Skip to content

Commit

Permalink
Remove trailing spaces
Browse files Browse the repository at this point in the history
  • Loading branch information
bocchino committed Nov 15, 2024
1 parent e6d0c56 commit a27a152
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 35 deletions.
2 changes: 1 addition & 1 deletion docs/fpp-spec.html
Original file line number Diff line number Diff line change
Expand Up @@ -10580,7 +10580,7 @@ <h3 id="Analysis-and-Translation_Translation-Tools">22.4. Translation Tools</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-11-11 18:02:32 -0800
Last updated 2024-11-14 17:33:23 -0800
</div>
</div>
<script src="code-prettify/run_prettify.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion docs/fpp-users-guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -14657,7 +14657,7 @@ <h4 id="Writing-C-Plus-Plus-Implementations_Implementing-Deployments_Public-Symb
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-11-11 18:02:39 -0800
Last updated 2024-11-14 17:33:30 -0800
</div>
</div>
<script src="code-prettify/run_prettify.js"></script>
Expand Down
18 changes: 9 additions & 9 deletions docs/users-guide/Analyzing-and-Translating-Models.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -549,7 +549,7 @@ to _file_.
This is similar to the `-n` option for
<<Analyzing-and-Translating-Models_Generating-XML, `fpp-to-xml`>>.

* `-s` _size_ : Specify a default string size.
* `-s` _size_ : Specify a default string size.
This is similar to the `-s` option for
<<Analyzing-and-Translating-Models_Generating-XML, `fpp-to-xml`>>.

Expand All @@ -559,7 +559,7 @@ To generate code for type, port, state machine, and component definitions, you
run `fpp-to-cpp` in the same way as for
<<Analyzing-and-Translating-Models_Generating-C-Plus-Plus_Constant-Definitions,
constant definitions>>, with one exception:
the translator ignores the `-g` option, because the include guard comes from
the translator ignores the `-g` option, because the include guard comes from
the qualified name of the definition.
For example, a component whose qualified name in FPP is `A.B.C`
uses the name `A_B_CComponentAc_HPP` in its include guard.
Expand All @@ -570,8 +570,8 @@ The https://github.com/nasa/fprime/blob/master/docs/UsersGuide/guide.md[F
Prime User's Guide] 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://github.com/nasa/fprime/blob/devel/docs/Design/general.md[F Prime design
for state machines, and for state machine instances, see the
https://github.com/nasa/fprime/blob/devel/docs/Design/general.md[F Prime design
documentation].

==== Component Implementation and Unit Test Code
Expand Down Expand Up @@ -648,7 +648,7 @@ is not generated.

The `-a` option supports a feature of the F Prime CMake build system called
`UT_AUTO_HELPERS`. With this feature enabled, you don't have to manage the
file _C_ `TesterHelpers.cpp` as part of your unit test source files; the
file _C_ `TesterHelpers.cpp` as part of your unit test source files; the
build system does it for you.

==== Topology Definitions
Expand Down Expand Up @@ -1287,7 +1287,7 @@ uses the ground dictionary to provide the operational
interface to the application.
The interface typically includes real-time commanding;
real-time display of events and telemetry; logging of
commands, events, and telemetry; uplink and downlink of files, including data
commands, events, and telemetry; uplink and downlink of files, including data
products; and decoding of data products.
This section explains how to generate ground dictionaries from
FPP models.
Expand Down Expand Up @@ -1316,7 +1316,7 @@ For each topology _T_ defined in the input files _F_, `fpp-to-dict` writes a fil
_T_ `TopologyDictionary.json`.
The dictionary is specified in JavaScript Object Notation (JSON) format.
The JSON format is specified in the
https://github.com/nasa/fprime/blob/devel/docs/Design/fpp-json-dict.md[F Prime
https://github.com/nasa/fprime/blob/devel/docs/Design/fpp-json-dict.md[F Prime
dictionary documentation].

Here is a common use case:
Expand Down Expand Up @@ -1399,7 +1399,7 @@ https://github.com/nasa/fpp/wiki/Analysis-Data-Structure[FPP wiki].
*JSON format:*
To understand this subsection, you need to know a little
bit about case classes in Scala.
For a primer, see
For a primer, see
https://github.com/nasa/fpp/wiki/Pure-Functional-Programming-in-Scala#use-case-classes-for-pattern-matching[this wiki page].

The JSON translation uses a Scala library called
Expand Down Expand Up @@ -1433,7 +1433,7 @@ There are a few exceptions, either because the standard translation
does not work, or because we need special behavior for important
cases:

* We streamline the translation of the Scala Option type, translating
* We streamline the translation of the Scala Option type, translating
`Some(v)` as `{ "Some" : v }` and `None` as `"None"`.

* In the AST, we translate
Expand Down
48 changes: 24 additions & 24 deletions docs/users-guide/Defining-State-Machines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ In the following subsections, we explain how to define internal
state machines in FPP.
The behavior of these state machines closely follows the behavior
described for state machines in the
https://www.omg.org/spec/UML/2.5.1/PDF[Universal Modeling Language (UML)].
https://www.omg.org/spec/UML/2.5.1/PDF[Universal Modeling Language (UML)].
UML is a graphical language and FPP is a textual language,
but each of the concepts in the FPP language is motivated
by a corresponding UML concept.
Expand Down Expand Up @@ -150,7 +150,7 @@ There are two signals: `cmdOn` for turning the device
on and `cmdOff` for turning the device off.
There are two state transition specifiers:

* A specifier that says to enter state `OFF`
* A specifier that says to enter state `OFF`
on receiving the `cmdOff` signal in state `ON`.

* A specifier that says to enter state `ON`
Expand Down Expand Up @@ -313,7 +313,7 @@ state machine Device {
In this example there are four actions:
`initialAction1`, `initialAction2`, `offOnAction`, and `onOffAction`.
The behavior of each of these actions is specified in the {cpp}
implementation; for example, each could emit an
implementation; for example, each could emit an
<<Defining-Components_Events,F Prime event>>.
The state machine has the following behavior:

Expand Down Expand Up @@ -498,7 +498,7 @@ Here are the rules for writing typed signals and actions:

* When you do an action that has a type, a value
compatible with that type must be available.
For example, we can't do the `offOnAction` in the `cmdOff` transition shown
For example, we can't do the `offOnAction` in the `cmdOff` transition shown
above, because no `U32`
value is available there.
Similarly, no action done in a
Expand Down Expand Up @@ -667,7 +667,7 @@ In this case the following behavior occurs:
Note that on a self transition, the state machine exits and
reenters _S_.
This behavior is a special case of a more general behavior that we will
discuss
discuss
<<Defining-State-Machines_Hierarchy_Entry-and-Exit-Actions,below>>
in connection with state hierarchy.
<<Defining-State-Machines_Hierarchy_Directly-Related-States,Below>>
Expand Down Expand Up @@ -812,7 +812,7 @@ receives a `cmdReset` signal, it does the `reset` action and
performs no other behavior.

An internal transition may have a guard.
For example, we could define a guard `resetIsSafe` and
For example, we could define a guard `resetIsSafe` and
write the internal transition as follows:

[source,fpp]
Expand All @@ -837,7 +837,7 @@ The most basic choice definition consists of the following:
* A name. Like a state name, this name can be the target
of a transition.

* The name of a
* The name of a
<<Defining-State-Machines_More-on-State-Transitions_Guarded-Transitions,guard>>
_G_.
The evaluation of _G_ selects which branch of the choice to
Expand Down Expand Up @@ -984,7 +984,7 @@ machine can be complex and hard to understand.

*The type associated with a choice:*
Like initial transitions and state transitions, the
transitions out of a choice may
transitions out of a choice may
<<Defining-State-Machines_Actions_Typed-Signals-and-Actions,
carry a value>>.
To determine whether the transitions of a choice _C_ carry a value,
Expand All @@ -994,7 +994,7 @@ and if so what type that value has, we use the following rules:
then transitions out of _C_ carry no value.

. Otherwise if all of the transitions into _C_ carry
a value of the same type _T_, then each of the
a value of the same type _T_, then each of the
transitions out of _C_ carries a value of type _T_.

. Otherwise if the incoming types can be resolved to
Expand Down Expand Up @@ -1090,7 +1090,7 @@ when transitions cross state boundaries.

A state machine with hierarchy is called a
*hierarchical state machine*.
In the following subsections, we explain how to define
In the following subsections, we explain how to define
hierarchical state machines in FPP.

==== Substates
Expand Down Expand Up @@ -1138,7 +1138,7 @@ state machine Device {
initial enter SAFE
@ The state OFF.SAFE
@ In this state, it is safe to turn on the device
@ In this state, it is safe to turn on the device
state SAFE {
@ In the SAFE state, a cmdOff signal causes a transition to the ON state
Expand Down Expand Up @@ -1178,8 +1178,8 @@ way it works for <<Defining-Modules,module names>>.

An instance _m_ of this state machine has the following behavior:

. When _m_ starts up, it runs its initial transition specifier, just as for
<<Defining-State-Machines_States-Signals-and-Transitions, a state machine
. When _m_ starts up, it runs its initial transition specifier, just as for
<<Defining-State-Machines_States-Signals-and-Transitions, a state machine
without hierarchy>>.
The state machine enters state `OFF`.
`OFF` is a parent state, so it in turn has an initial transition
Expand Down Expand Up @@ -1311,7 +1311,7 @@ state machine Device {
initial enter SAFE
@ The state OFF.SAFE
@ In this state, it is safe to turn on the device
@ In this state, it is safe to turn on the device
state SAFE {
@ In the SAFE state, a cmdOff signal causes a transition to the ON state
Expand All @@ -1338,7 +1338,7 @@ state machine Device {
}
----

Here we have rewritten the
Here we have rewritten the
<<Defining-State-Machines_Hierarchy_Substates,
`Device` state machine from the previous section>>
so that all the states in that example are descendants of a single state
Expand All @@ -1364,7 +1364,7 @@ would cause an exit from and reentry to the state, which we may not want.

To remedy this situation, we use behavioral polymorphism.
In the state `DEVICE.OFF.UNSAFE`, we define an
<<Defining-State-Machines_More-on-State-Transitions_Internal-Transitions,internal
<<Defining-State-Machines_More-on-State-Transitions_Internal-Transitions,internal
transition>>
that has an empty list of actions and so does nothing.
This transition overrides the transition provided in the ancestor state,
Expand Down Expand Up @@ -1485,15 +1485,15 @@ https://github.com/nasa/fpp/wiki/Compute-Flattened-State-Transition-Map[FPP wiki

*The special case of no hierarchy:*
The general behavior described above agrees with the special-case
behavior that we described in the section on
behavior that we described in the section on
<<Defining-State-Machines_Actions_Entry-and-Exit-Actions,
entry and exit actions for state machines without hierarchy>>.
When a state machine _M_ has no hierarchy, a every state transition _T_
is a flattened transition that goes from a leaf state _L_ to a leaf
state _S_, both of which are children of _M_ in the hierarchy tree.
So we always exit _L_, do the actions of _T_, and enter _S_.

In particular,
In particular,
the general behavior agrees with the behavior that we previously
described for
<<Defining-State-Machines_More-on-State-Transitions_Self-Transitions,
Expand Down Expand Up @@ -1542,7 +1542,7 @@ a flattened transition to the ancestor _A_.
Otherwise it represents one flattened transition
to the ancestor _A_ for each descendant of _S_ that
is a leaf state.
Because of
Because of
<<Defining-State-Machines_Hierarchy_Inherited-Transitions,
behavioral polymorphism>>, any of the flattened transitions may
be overridden.
Expand All @@ -1551,7 +1551,7 @@ be overridden.
A *flattened transition to self* is a transition
from a leaf state _L_ to itself.
This is what we previously called a
<<Defining-State-Machines_More-on-State-Transitions_Self-Transitions,self
<<Defining-State-Machines_More-on-State-Transitions_Self-Transitions,self
transition>>.

*Syntactic transitions to self:*
Expand All @@ -1568,7 +1568,7 @@ to one or more transitions from leaf states _L_ that are
descendants of _S_.
Each of these transitions is a flattened transition
to the ancestor _S_.
Because of
Because of
<<Defining-State-Machines_Hierarchy_Inherited-Transitions,
behavioral polymorphism>>, any of the flattened transitions may
be overridden.
Expand All @@ -1587,7 +1587,7 @@ Consider a state transition _T_ of the form
where _D_ is a descendant of _S_.
We call this kind of state transition a
*syntactic transition to a descendant*.
By symmetry with syntactic transitions to ancestors,
By symmetry with syntactic transitions to ancestors,
you might expect that the first behavior when
making such a transition is to exit and reenter _S_.
However, this is not what happens.
Expand All @@ -1604,7 +1604,7 @@ is a flattened transition to self, and (b) the
flattened transitions out of the descendants of _D_
are flattened transitions to the ancestor _D_.

In either case, because of
In either case, because of
<<Defining-State-Machines_Hierarchy_Inherited-Transitions,
behavioral polymorphism>>, any of the flattened transitions may
be overridden.
Expand Down Expand Up @@ -1636,7 +1636,7 @@ The dots represent omitted text needed to make the state machine valid.
In this example, the qualified name of the choice is `S.C`.
Inside state `S`, you can refer to the choice as `S.C` or `C`.
Outside state `S`, you must refer to it as `S.C`.

*Initial transitions to choices:*
When an initial transition _I_ goes to a choice _C_,
_C_ and _I_ must have the same parent _P_ in the
Expand Down

0 comments on commit a27a152

Please sign in to comment.