diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/01_introduction.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/01_introduction.rst index bdd446b47..9531f852d 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/01_introduction.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/01_introduction.rst @@ -2,7 +2,7 @@ Introduction ************** -.. include:: ../../global.txt +.. include:: ../global.txt Ada is a general purpose, high-level programming language designed to support the construction of long-lived, highly-reliable applications. Like all diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/concurrency/con01_use_the_ravenscar_profile.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/concurrency/con01_use_the_ravenscar_profile.rst index 3745f9731..9bd897a99 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/concurrency/con01_use_the_ravenscar_profile.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/concurrency/con01_use_the_ravenscar_profile.rst @@ -2,7 +2,7 @@ Use the Ravenscar Profile (CON01) ----------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Advisory diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/concurrency/con02_use_the_jorvik_profile.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/concurrency/con02_use_the_jorvik_profile.rst index 30fc65a7f..dfa52ef86 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/concurrency/con02_use_the_jorvik_profile.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/concurrency/con02_use_the_jorvik_profile.rst @@ -2,7 +2,7 @@ Use the Jorvik Profile (CON02) -------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Advisory diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/concurrency/con03_avoid_shared_variables_for_inter-task_communication.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/concurrency/con03_avoid_shared_variables_for_inter-task_communication.rst index ee827e06a..12b74a143 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/concurrency/con03_avoid_shared_variables_for_inter-task_communication.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/concurrency/con03_avoid_shared_variables_for_inter-task_communication.rst @@ -2,7 +2,7 @@ Avoid Shared Variables for Inter-task Communication (CON03) ------------------------------------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Advisory diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/dynamic_storage_management.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/dynamic_storage_management.rst index 9fa4ec769..d43a760a6 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/dynamic_storage_management.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/dynamic_storage_management.rst @@ -2,7 +2,7 @@ Dynamic Storage Management (DYN) ================================== -.. include:: ../../../global.txt +.. include:: ../../global.txt *Goal* :Maintainability: :math:`\checkmark` diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage.rst index a4ffca044..8b6407175 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage.rst @@ -2,7 +2,7 @@ Exception Usage (EXU) ======================= -.. include:: ../../../global.txt +.. include:: ../../global.txt *Goal* :Maintainability: :math:`\checkmark` diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage/exu01_dont_raise_language-defined_exceptions.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage/exu01_dont_raise_language-defined_exceptions.rst index fafee446b..50f56e488 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage/exu01_dont_raise_language-defined_exceptions.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage/exu01_dont_raise_language-defined_exceptions.rst @@ -2,7 +2,7 @@ Don't Raise Language-Defined Exceptions (EXU01) ------------------------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Required diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage/exu02_no_unhandled_application-defined_exceptions.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage/exu02_no_unhandled_application-defined_exceptions.rst index b443384d5..ccea07c79 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage/exu02_no_unhandled_application-defined_exceptions.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage/exu02_no_unhandled_application-defined_exceptions.rst @@ -2,7 +2,7 @@ No Unhandled Application-Defined Exceptions (EXU02) ----------------------------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Required diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage/exu03_no_exception_propagation_beyond_name_visibility.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage/exu03_no_exception_propagation_beyond_name_visibility.rst index d5fb00407..cd5831d96 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage/exu03_no_exception_propagation_beyond_name_visibility.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/exception_usage/exu03_no_exception_propagation_beyond_name_visibility.rst @@ -2,7 +2,7 @@ No Exception Propagation Beyond Name Visibility (EXU03) --------------------------------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Required diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/object_oriented_programming/oop03_limit_inheritance_hierarchy_depth.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/object_oriented_programming/oop03_limit_inheritance_hierarchy_depth.rst index dac5f16f1..d05b72b3e 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/object_oriented_programming/oop03_limit_inheritance_hierarchy_depth.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/object_oriented_programming/oop03_limit_inheritance_hierarchy_depth.rst @@ -2,7 +2,7 @@ Limit Inheritance Hierarchy Depth (OOP03) ------------------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Advisory diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/object_oriented_programming/oop04_limit_statically-dispatched_calls_to_primitive_operations.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/object_oriented_programming/oop04_limit_statically-dispatched_calls_to_primitive_operations.rst index 4e4039c94..ec96f6b64 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/object_oriented_programming/oop04_limit_statically-dispatched_calls_to_primitive_operations.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/object_oriented_programming/oop04_limit_statically-dispatched_calls_to_primitive_operations.rst @@ -2,7 +2,7 @@ Limit Statically-Dispatched Calls To Primitive Operations (OOP04) ------------------------------------------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Advisory diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/object_oriented_programming/oop05_use_explicit_overriding_annotations.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/object_oriented_programming/oop05_use_explicit_overriding_annotations.rst index 8fff96696..7c4b76d7a 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/object_oriented_programming/oop05_use_explicit_overriding_annotations.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/object_oriented_programming/oop05_use_explicit_overriding_annotations.rst @@ -2,7 +2,7 @@ Use Explicit Overriding Annotations (OOP05) --------------------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Required diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp01_no_use_of_others_in_case_constructs.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp01_no_use_of_others_in_case_constructs.rst index 3b615d561..62b0c77bd 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp01_no_use_of_others_in_case_constructs.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp01_no_use_of_others_in_case_constructs.rst @@ -2,7 +2,7 @@ No Use of "others" in Case Constructs (RPP01) ----------------------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Required diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp02_no_enumeration_ranges_in_case_constructs.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp02_no_enumeration_ranges_in_case_constructs.rst index 8e4379598..19df43cef 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp02_no_enumeration_ranges_in_case_constructs.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp02_no_enumeration_ranges_in_case_constructs.rst @@ -2,7 +2,7 @@ No Enumeration Ranges in Case Constructs (RPP02) -------------------------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Required diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp03_limited_use_of_others_in_aggregates.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp03_limited_use_of_others_in_aggregates.rst index ef8f96614..c61407b3c 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp03_limited_use_of_others_in_aggregates.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp03_limited_use_of_others_in_aggregates.rst @@ -2,7 +2,7 @@ Limited Use of "others" In Aggregates (RPP03) ----------------------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Advisory diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp04_no_unassigned_mode-out_procedure_parameters.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp04_no_unassigned_mode-out_procedure_parameters.rst index ce37a3713..e53dc4cc6 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp04_no_unassigned_mode-out_procedure_parameters.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp04_no_unassigned_mode-out_procedure_parameters.rst @@ -2,7 +2,7 @@ No Unassigned Mode-Out Procedure Parameters (RPP04) ----------------------------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Required diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp05_no_use_of_others_in_exception_handlers.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp05_no_use_of_others_in_exception_handlers.rst index 2981e5272..d0bc4a5ff 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp05_no_use_of_others_in_exception_handlers.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp05_no_use_of_others_in_exception_handlers.rst @@ -2,7 +2,7 @@ No Use of "others" in Exception Handlers (RPP05) -------------------------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Required diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp07_functions_only_have_mode_in.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp07_functions_only_have_mode_in.rst index 3456a63bf..0ffa560f9 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp07_functions_only_have_mode_in.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp07_functions_only_have_mode_in.rst @@ -2,7 +2,7 @@ Functions Only Have Mode "in" (RPP07) --------------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Required diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp12_no_recursion.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp12_no_recursion.rst index ac04f78b4..06ce3c8ef 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp12_no_recursion.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/robust_programming_practice/rpp12_no_recursion.rst @@ -2,7 +2,7 @@ No Recursion (RPP12) ---------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Advisory diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/software_engineering/swe04_hide_implementation_artifacts.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/software_engineering/swe04_hide_implementation_artifacts.rst index 75fa3d204..c0b9c9712 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/software_engineering/swe04_hide_implementation_artifacts.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/chapters/guidelines/software_engineering/swe04_hide_implementation_artifacts.rst @@ -2,7 +2,7 @@ Hide Implementation Artifacts (SWE04) ---------------------------------------- -.. include:: ../../../../global.txt +.. include:: ../../../global.txt **Level** :math:`\rightarrow` Advisory diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/global.txt b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/global.txt new file mode 100644 index 000000000..8a1996194 --- /dev/null +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/global.txt @@ -0,0 +1,26 @@ +.. role:: ada(code) + :language: ada + :class: highlight + +.. role:: c(code) + :language: c + :class: highlight + +.. role:: cpp(code) + :language: c++ + :class: highlight + +.. role:: java(code) + :language: java + :class: highlight + +.. role:: assembly(code) + +.. role:: rule(code) + +.. role:: switch(code) + :language: console + +.. include:: + +.. include:: diff --git a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/index.rst b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/index.rst index de4435f2a..08467ac6b 100644 --- a/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/index.rst +++ b/content/courses/Guidelines_for_Safe_and_Secure_Ada_SPARK/index.rst @@ -4,7 +4,7 @@ Guidelines for Safe and Secure Ada/SPARK ========================================== -.. include:: ../global.txt +.. include:: global.txt .. only:: builder_epub