First version of the space systems software booklet#1327
Merged
Conversation
gusthoff
reviewed
Mar 20, 2026
content/booklets/adacore-technologies-for-space-systems-software/chapters/compliance-q80c.rst
Outdated
Show resolved
Hide resolved
gusthoff
reviewed
Mar 20, 2026
content/booklets/adacore-technologies-for-space-systems-software/chapters/compliance-q80c.rst
Outdated
Show resolved
Hide resolved
gusthoff
reviewed
Mar 20, 2026
content/booklets/adacore-technologies-for-space-systems-software/chapters/compliance-q80c.rst
Outdated
Show resolved
Hide resolved
gusthoff
reviewed
Mar 20, 2026
content/booklets/adacore-technologies-for-space-systems-software/chapters/introduction.rst
Outdated
Show resolved
Hide resolved
Collaborator
|
Hey @Fabien-Chouteau, it looks good in general. There are couple of minor things that look different from other books, so I'd suggest consulting the CONTRIBUTING.md file. |
gusthoff
force-pushed
the
space-software-booklet
branch
from
17bdebd to
2747cf5
Compare
Per CONTRIBUTING.md guidelines, directive options must use 4-space indentation. Fix all toctree, csv-table, and table options that were using 3-space indentation across index.rst, introduction.rst, tools.rst, compliance-e40c.rst, and compliance-q80c.rst. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Per CONTRIBUTING.md guidelines, directive content must use 4-space indentation. Normalize all code-block content in programming.rst to a 4-space minimum indent (some blocks had 2-space, others 3-space). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- "Analyszer" → "Analyzer" - "justfied" → "justified" - "checks,as" → "checks, as" (missing space after comma) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Two occurrences of "contact" used where "contract" was intended, in the section on contract-based programming. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Per CONTRIBUTING.md, directive content must use 4-character indentation. Fix toctree entries (index.rst) and table/csv-table bodies (introduction.rst, compliance-e40c.rst, compliance-q80c.rst) that were indented with 3 spaces instead of 4. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
In RST, a bullet item `* text` places the body text at column 2. Nested bullets must align exactly with that column-2 body start. Indenting sub-bullets to column 3 or beyond causes Sphinx to parse them as block quotes rather than as nested list items, producing visually distinct "quote" boxes in the HTML and PDF output instead of the intended bullet hierarchy. This commit normalises the indentation across all four chapters: - compliance-e40c.rst: 3-space sub-bullets corrected to 2-space; 5-space continuation lines corrected to 4-space; a 3-space directive (.. note::) corrected to 2-space. - compliance-q80c.rst: 36 × 3-space sub-bullets corrected to 2-space; 75 × 5-space continuation lines corrected to 4-space; one 3-space directive corrected to 2-space. - programming.rst: 40 × 4-space bullets that appeared directly under section paragraphs (not inside a parent list item) corrected to 0-space (top-level bullets); their 6-space continuation lines corrected to 2-space accordingly. - tools.rst: mixed correct (2→4→6) and incorrect (2→3→6) chains normalised; 3-space sub-bullets corrected to 2-space; 5-space continuation lines corrected to 4-space; 6-space sub-sub-bullets that were under 3-space parents moved to 4-space; a 9-space bullet (line 781) corrected to 6-space. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The "Verification Support" table in the Software code verification section used inline :superscript:`*`, :superscript:`**`, and :superscript:`***` roles as ad-hoc footnote markers, with matching :superscript: paragraphs below the table acting as footnote text. This is replaced with proper RST/docutils footnote syntax: - Table cells now use [#rtcheck]_, [#stcheck]_, and [#memleak]_ footnote references. - The footnote text is defined with .. [#rtcheck], .. [#stcheck], and .. [#memleak] directives immediately below the table. Docutils renders these as linked superscript numbers: clicking a marker in the table jumps to the footnote definition, and a backlink returns to the reference site. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Quotes should only be used when a term is referred to in the bibliography. Introduced technical terms, Ada/SPARK language concepts, and domain vocabulary should use italic markup instead. The following terms were converted from "term" to *term* across all four chapters: compliance-e40c.rst: stubs, bottom-up, version skew, sustained branch, false positives, elaboration time, access type. compliance-q80c.rst: sustained branch. tools.rst: V (diagram/chart), false alarms, Bare-Metal, known problems, sustained branch, tool tips, visible. programming.rst: programming in the large, child libraries, exception handling, tasking, IRTAW, information hiding, child units, instantiation, tagged type, finalization, task, protected object, raw bits, aspects, false negatives, false positives, false alarms, ghost, sweet spots, all or nothing. The following quoted terms were intentionally left unchanged: "Ada Restrictions", "Dangerous Software Errors", "CWE-Compatible", "Silver", "minimize the trusted computing base", the proper noun "Ada" in its historical naming sentence, and verbatim quotations from ECSS standards. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Two occurrences of :index:`Space_Systems_SW_GNATtest` and :index:`Space_Systems_SW_GNATfuzz` in the TGen section were using the index role instead of the ref role, causing the raw label names to appear as visible text in the generated HTML. Replaced with :ref:`GNATtest <Space_Systems_SW_GNATtest>` and :ref:`GNATfuzz <Space_Systems_SW_GNATfuzz>` respectively, which render as proper hyperlinks to the corresponding sections. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
gusthoff
approved these changes
Mar 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi @gusthoff ,
I tried as much as possible to match the changes that you've done to the other booklets.
Let me know if you need anything.