Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

writing out Codespell typo fixes #13

Merged
merged 9 commits into from
Dec 21, 2023
Merged
  •  
  •  
  •  
1 change: 0 additions & 1 deletion .github/workflows/style_all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ jobs:
run: cp config/adamant.configuration.yaml.original config/adamant.configuration.yaml
- name: Check all style
run: bash env/github_run.sh "redo style_all"
continue-on-error: true
- name: Archive logs for failed style checks
if: always() # Make sure this runs even if `redo style_all` fails
uses: actions/upload-artifact@v3
Expand Down
2 changes: 1 addition & 1 deletion config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can now modify the values in `adamant.configuration.yaml` to work for your p
version control system if you intend on merging changes from your Adamant repository back into
the framework root repository.

Version controlling the configuration file is usually desireable. To accomplish this, copy the
Version controlling the configuration file is usually desirable. To accomplish this, copy the
Adamant default configuration into your project specific repository:

```
Expand Down
4 changes: 2 additions & 2 deletions doc/QuickStartGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ In Adamant, anything constructed by the build system will always be put into a d
There are some basic `redo` commands available in Adamant that are almost always available, and can be particularly useful:

* `redo what` - The build system will explore the build path and print a list of the available outputs that can be built from the current directory. The list returned is not guaranteed to be complete, but this deficiency should not hinder anyone except for the most advanced Adamant users.
* `redo all` - The build system will try to generate every output available within a directory's `build/` directory. What `redo all` will construct can be visualized by using `redo what`. Note, running simply `redo` is assumed by `redo` to be equivelant to running `redo all`.
* `redo all` - The build system will try to generate every output available within a directory's `build/` directory. What `redo all` will construct can be visualized by using `redo what`. Note, running simply `redo` is assumed by `redo` to be equivalent to running `redo all`.
* `redo clean` - This removes any `build/` directories found recursively from where it is run.
* `redo test_all` - Recursively find any unit tests from where this command is run, compile them, and run them, outputing a simple pass/fail report to the terminal.
* `redo test_all` - Recursively find any unit tests from where this command is run, compile them, and run them, outputting a simple pass/fail report to the terminal.
* `redo publish` - Recursively "publish" any documentation found from this directory. For more detail on "publishing" documentation see the "Creating Component Documentation" section.
* `redo style` - Run style checks on all source files (Python, Ada, and YAML) found in this directory.
* `redo targets` - Show all available build targets, see the "Setting the Build Target" section.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ \section{Concepts}
\item \textbf{Encapsulation} - A component hides the details of its internal behavior and state and only allows other components to access its functionality through the interface it presents.
\item \textbf{Independence} - Components do not depend on other components, they depend only on their interfaces. This means that changes to one component are unlikely to ripple through the entire system.
\item \textbf{Reusability} - Some components may be designed for a project-specific task, however, many components can be designed in a generic way such that they can be reused in similar systems with no modification. In addition, a component can be placed in a variety of execution contexts and be still expected to function as designed.
\item \textbf{Replacability} - Because a component is simply represented by its interfaces, it can substituted for another component as long as it adheres to the same interface.
\item \textbf{Replaceability} - Because a component is simply represented by its interfaces, it can substituted for another component as long as it adheres to the same interface.
\end{itemize}

Components in Adamant communicate with one another through strongly typed \textit{connectors}. Components can have many connectors, of many different types, which can either send or receive data or both. Because connectors are exposed in the design, data flow within an Adamant architecture is not obscured, but rather can be easily inspected by a viewer of the design.
Expand Down Expand Up @@ -168,7 +168,7 @@ \subsubsection{Component Examples}
% parameters
\begin{figure}[H]
\includegraphics[width=1.0\textwidth,center]{../example_architecture/build/eps/example_parameters.eps}
\caption{\texttt{Example\_Parameters} component which takes requests for parameter values by identifier, and synchronously returns them to the requestor}
\caption{\texttt{Example\_Parameters} component which takes requests for parameter values by identifier, and synchronously returns them to the requester}
\end{figure}

The \texttt{Example\_Parameters} component's primary task is to push the current value of parameters to components throughout the system. To accomplish this, it has an arrayed \textit{provide} connector through which it sends parameter updates to destination components. The component also includes a connector which allows parameter values to be changed by command.
Expand Down
2 changes: 1 addition & 1 deletion doc/example_architecture/array_register_set/main.adb
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ begin

-- Read and write registers but only access certain components. The
-- compiler will ensure that the ENTIRE register is read/written
-- during the folling operations.
-- during the following operations.
if Registers (1).Hw_1_Enabled = Enable and then
Registers (4).Hw_2_Enabled = Enable
then
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
execution: passive
description: This is the command component, which executes commands.
connectors:
- description: This is the command recieve connector.
- description: This is the command receive connector.
type: Command.T
kind: recv_sync
- description: This connector is used to register the components commands at initialization, and send command responses after execution.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ package body Component.Command_Component.Implementation is
---------------------------------------
-- Invokee connector primitives:
---------------------------------------
-- This is the command recieve connector.
-- This is the command receive connector.
overriding procedure Command_T_Recv_Sync (Self : in out Instance; Arg : in Command.T) is
-- Execute the command:
Stat : constant Command_Response_Status.E := Self.Execute_Command (Arg);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ private
---------------------------------------
-- Invokee connector primitives:
---------------------------------------
-- This is the command recieve connector.
-- This is the command receive connector.
overriding procedure Command_T_Recv_Sync (Self : in out Instance; Arg : in Command.T);

---------------------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ filters:
# Required - The filter type. Filter types available are:
# component_name - filter by component names
# component_type - filter by component types
# component_execution - filter by component exucution types (active or passive)
# component_execution - filter by component execution types (active or passive)
# component_context - filter by component and all it's immediate connections
# connector_name - filter by connector_names
# connecter_type - filter by connector type
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ private
-----------------------------------------------
-- Description:
-- A set of data dependencies for the Data Dependency Component.
-- Function which retreives a data dependency.
-- Function which retrieves a data dependency.
-- The default implementation is to simply call the Data_Product_Fetch_T_Request connector. Change the implementation if this component
-- needs to do something different.
overriding function Get_Data_Dependency (Self : in out Instance; Id : in Data_Product_Types.Data_Product_Id) return Data_Product_Return.T is (Self.Data_Product_Fetch_T_Request ((Id => Id)));
Expand Down
2 changes: 1 addition & 1 deletion doc/example_architecture/enum_py/test.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python3

# Build our dependencies using the build system.
# This is necessary because some of the depdencies we
# This is necessary because some of the dependencies we
# have are autogenerated.
from util import pydep

Expand Down
4 changes: 2 additions & 2 deletions doc/example_architecture/example_register.record.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
description: This is an example packed register.
preamble: |
type Enable_Disable_Type is (Disabl, Enable);
for Enable_Disable_Type use (Disabl => 0, Enable => 1);
type Enable_Disable_Type is (Disable, Enable);
for Enable_Disable_Type use (Disable => 0, Enable => 1);
type Fourteen_Bit_Uint is mod 2**14;
# List the record fields. The whole register must be 32-bits in size.
fields:
Expand Down
2 changes: 1 addition & 1 deletion doc/example_architecture/example_time.component.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: This component provides system time to components in the assembly.
execution: passive
preamble: |
type Time_Source_Type is (Sofware, Hardware);
type Time_Source_Type is (Software, Hardware);
discriminant:
description: The discriminant is used to specify the time source.
parameters:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ faults:
# Required - the name of the fault
- name: Discontinuous_Time_Fault
# Optional - a description of the fault
description: A discontinous time was detected by the component.
description: A discontinuous time was detected by the component.
# Optional - the parameter type to include with the fault
param_type: Packed_U32.T
# Optional - a statically defined ID for the fault
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ package body Component.Fault_Component.Implementation.Tester is
-----------------------------------------------
-- Description:
-- A set of faults for the Fault Component.
-- A discontinous time was detected by the component.
-- A discontinuous time was detected by the component.
overriding procedure Discontinuous_Time_Fault (Self : in out Instance; Arg : in Packed_U32.T) is
begin
-- Push the argument onto the test history for looking at later:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ package Component.Fault_Component.Implementation.Tester is
-----------------------------------------------
-- Description:
-- A set of faults for the Fault Component.
-- A discontinous time was detected by the component.
-- A discontinuous time was detected by the component.
overriding procedure Discontinuous_Time_Fault (Self : in out Instance; Arg : in Packed_U32.T);
-- A time restart at zero seconds epoc was detected by the component.
overriding procedure Zero_Time_Fault (Self : in out Instance);
Expand Down
2 changes: 1 addition & 1 deletion doc/example_architecture/last_chance_handler.adb
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
-- Use the low level GNAT.IO package since the sytem is in a precarious state.
-- Use the low level GNAT.IO package since the system is in a precarious state.
with GNAT.IO;
with System.Storage_Elements;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ package Oo_Package.Tester is
-- internal private variables during testing, even though you don't want this
-- feature during the deployment of your software.
--
-- This function retreives the private value of "n" from within the object's
-- This function retrieves the private value of "n" from within the object's
-- record and returns it.
function Get_N (Self : in Instance) return Integer;

Expand Down
4 changes: 2 additions & 2 deletions doc/example_architecture/record_py/test.py
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
#!/usr/bin/env python3

# Build our dependencies using the build system.
# This is necessary because some of the depdencies we
# This is necessary because some of the dependencies we
# have are autogenerated.
from util import pydep

pydep.build_py_deps()

# Noe that the autocode has been built, import
# Now that the autocode has been built, import
# the autocoded module.
from example_record import Example_Record

Expand Down
2 changes: 1 addition & 1 deletion doc/example_architecture/record_register/main.adb
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ begin

-- Read and write register but only access certain components. The
-- compiler will ensure that the ENTIRE register is read/written
-- during the folling operations.
-- during the following operations.
if Reg.Hw_1_Enabled = Enable and then Reg.Hw_2_Enabled = Enable then
Reg.Threshold := 22;
end if;
Expand Down
2 changes: 1 addition & 1 deletion doc/example_architecture/record_register_set/main.adb
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ begin

-- Read and write registers but only access certain components. The
-- compiler will ensure that the ENTIRE register is read/written
-- during the folling operations.
-- during the following operations.
if Registers.Reg_2.Hw_1_Enabled = Enable and then
Registers.Reg_3.Hw_2_Enabled = Enable
then
Expand Down
4 changes: 2 additions & 2 deletions doc/example_architecture/science_assembly.assembly.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ components:
# Optional - declare the base id for an ided entity
# suite. If not declared, or a parameter is omitted,
# then Adamant will automatically figure out the base
# id to use, selectin the lowest remaining ID
# avaialable.
# id to use, selecting the lowest remaining ID
# available.
set_id_bases:
- "data_Product_Id_Base => 100"
# Required (only for components that have a data_dependencies
Expand Down
Loading
Loading