Skip to content
This repository was archived by the owner on Jan 27, 2025. It is now read-only.

Pull changes from the Ferrocene monorepo #15

Merged
merged 46 commits into from
Mar 22, 2023
Merged

Conversation

pietroalbini
Copy link
Contributor

This PR pulls the latest changes we made to the shared resources in the Ferrocene monorepo. It also:

  • Changes the license of the ferrocene_qualification extension to be MIT OR Apache-2.0
  • Changes the CI baseline to Python 3.9
  • Fixes some linter errors

pietroalbini and others added 30 commits October 27, 2022 11:33
602: Fix upper cased tests and directories to use upper-x prefix r=Veykril a=kirtchev-adacore

This PR renames all directories and tests that check upper cased compiler arguments to use prefix `upper-x` instead of `X`.

Co-authored-by: Hristian Kirtchev <[email protected]>
503: Add tests for compiler argument -L r=pietroalbini a=kirtchev-adacore



Co-authored-by: Hristian Kirtchev <[email protected]>
Co-authored-by: Pietro Albini <[email protected]>
732: Automated pull from `ferrocene/sphinx-shared-resources` r=pietroalbini a=github-actions[bot]

This PR pulls the following changes from the [`ferrocene/sphinx-shared-resources`](https://github.com/ferrocene/sphinx-shared-resources) repository:

* #14


Co-authored-by: Pietro Albini <[email protected]>
Co-authored-by: Lukas Wirth <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This commit adds a new extension, ferrocene_qualification, to the shared
Sphinx resources. This extension will contain all code shared between
all qualification documents.

In the initial iteration, the extension is responsible for:

- Generating a "Document ID" that only changes when the actual content
  included in the documentation changes, so we can have a stable ID for
  documents sent to TUV.

- Provide a central place to define substitutions shared between all
  documents (ferrocene/doc/sphinx-substitutions.toml), plus some default
  substitutions calculated by the extension.
735: Add `ferrocene_qualification` extension with documentation IDs and substitutions r=Veykril a=pietroalbini

This PR adds a new extension, `ferrocene_qualification`, to the shared Sphinx resources. This extension will contain all code shared between all qualification documents.

In the initial iteration, the extension is responsible for:

- Generating a "Document ID" that only changes when the actual content included in the documentation changes, so we can have a stable ID for documents sent to TUV.

- Provide a central place to define substitutions shared between all documents (ferrocene/doc/sphinx-substitutions.toml), plus some default substitutions calculated by the extension.

Co-authored-by: Pietro Albini <[email protected]>
737: Remove `getrandom-0.1` subtree r=Veykril a=pietroalbini

The subtree is not needed anymore, as upstream removed the dependency from std.

739: Implement linking in qualification documents r=Veykril a=pietroalbini

This PR adds support for cross-linking IDs to the `ferrocene_qualification` extension.

An ID can be defined with:

```rst
.. id:: TEST01
```

...and referenced everywhere else in the document with:

```rst
:id:`TEST01`
```

Outside of tables, defining an ID will automatically add the "**Identifier:**" prefix.

Co-authored-by: Pietro Albini <[email protected]>
This will avoid the sidebar from scrolling when reaching the end of the
content, which wasn't that pretty and complicates future changes.
747: Improvements to the documentation styling r=Veykril a=pietroalbini

This PR makes multiple changes to the documentation styling:

* Removes the commit SHA from the built documentation, to avoid the qualification documents from changing between builds if no actual content changed.
* Implements horrible CSS hackery to collapse the margin when multiple headings are one after another.
* Adds styling for table captions.
* Changes the background color for inline code to be less grey.

| Before | After |
| --- | --- |
| ![Before](https://user-images.githubusercontent.com/2299951/213684174-4eb71f55-9aab-4688-8aae-6b928b531ca2.png) | ![After](https://user-images.githubusercontent.com/2299951/213684216-e73acc4e-0e95-4646-9566-a0553171c4d7.png) |


748: Automated pull from `rust-lang/libc` r=pietroalbini a=github-actions[bot]

This PR pulls the following changes from the [`rust-lang/libc`](https://github.com/rust-lang/libc) repository:

* rust-lang/libc#3069
* rust-lang/libc#3065
* rust-lang/libc#3071


749: Improve objects.inv gathering reliability r=Veykril a=pietroalbini

This PR improves the reliability of objects.inv gathering. More detailed explanations of the changes are in the commit messages.

Co-authored-by: Pietro Albini <[email protected]>
Co-authored-by: Andrei Odintsov <[email protected]>
Co-authored-by: David Carlier <[email protected]>
Co-authored-by: bors <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This will allow other tooling to identify the Document ID of built
documentation without having to parse the rendered HTML.
pietroalbini and others added 16 commits February 15, 2023 12:39
791: Ensure we generate reproducible documentation r=Veykril a=pietroalbini

Before this PR, we had two sources of non-reproducibility in the rendered Sphinx documentation:

* We passed absolute paths to the `sphinx-build` command, resulting in those paths being injected into the configuration and hashed as part of the `.buildinfo` output file. The first commit changes the build system to pass all relative paths.
* The document ID hashing included the `source` attribute of the `<document>` root rST node, which includes the absolute path to the document. The document ID hasher has been changed to exclude that attribute during hashing.

With this PR merged, hopefully we will be able to have consistent document IDs for document signing.

794: Disable warnings during InterSphinx gathering r=Veykril a=pietroalbini

Before this PR, a lot of warnings appeared when building a document, caused by InterSphinx references not being available when gathering InterSphinx references (due to cyclical dependencies). These warnings are expected and not actionable, so showing them only causes confusion.

This PR disables warnings when gathering InterSphinx references.

Co-authored-by: Pietro Albini <[email protected]>
805: Show signature information in the rendered documentation r=kirtchev-adacore a=pietroalbini

This PR adds digital signature information to the rendered documentation:

* For documents that are not signed, an orange warning will appear in the top right corner of the page:

  ![image](https://user-images.githubusercontent.com/2299951/220881540-b8cc5714-b512-4163-9887-2ee6a616c938.png)

* For documents that are digitally signed, a message will appear in the top right corner of the page:

  ![image](https://user-images.githubusercontent.com/2299951/220881797-41fdb7a5-f661-41f1-be8a-2ae84b497350.png)

  ...and clicking on the link gets you to a page containing the signature details:

  ![image](https://user-images.githubusercontent.com/2299951/220882133-9a0ac2c2-0a7b-4429-9b97-53a208330c6b.png)

This PR is best reviewed commit-by-commit.

806: Update cosign to 2.0.0-rc.3 and add more platforms r=kirtchev-adacore a=pietroalbini



807: Update index description of the Evaluation Plan r=kirtchev-adacore a=nava-j

Update for the description text in the Index for the Evaluation Plan

Co-authored-by: Pietro Albini <[email protected]>
Co-authored-by: Josue NAVA BELLO <[email protected]>
Generated with:

rg "Critical Section GmbH" -l | xargs -n 1 sed -i '/trademark/!  s/Critical Section GmbH/Ferrous Systems and AdaCore/g'
@pietroalbini pietroalbini merged commit 114f55e into main Mar 22, 2023
@pietroalbini pietroalbini deleted the pa-pull-from-ferrocene branch March 22, 2023 14:12
bors-ferrocene bot added a commit to ferrocene/ferrocene that referenced this pull request Oct 18, 2023
55: Automated pull from `ferrocene/sphinx-shared-resources` r=Veykril a=github-actions[bot]

This PR pulls the following changes from the [`ferrocene/sphinx-shared-resources`](https://github.com/ferrocene/sphinx-shared-resources) repository:

* ferrocene/sphinx-shared-resources#15
* ferrocene/sphinx-shared-resources#16
* ferrocene/sphinx-shared-resources#17
* ferrocene/sphinx-shared-resources#18
* ferrocene/sphinx-shared-resources#19
* ferrocene/sphinx-shared-resources#23
* ferrocene/sphinx-shared-resources#27
* ferrocene/sphinx-shared-resources#28
* ferrocene/sphinx-shared-resources#25
* ferrocene/sphinx-shared-resources#29
* ferrocene/sphinx-shared-resources#30
* ferrocene/sphinx-shared-resources#32
* ferrocene/sphinx-shared-resources#31
* ferrocene/sphinx-shared-resources#33


56: Automated pull from `rust-lang/libc` r=Veykril a=github-actions[bot]

This PR pulls the following changes from the [`rust-lang/libc`](https://github.com/rust-lang/libc) repository:

* rust-lang/libc#3034
* rust-lang/libc#3290
* rust-lang/libc#3389


Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Pietro Albini <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: David Carlier <[email protected]>
Co-authored-by: bors <[email protected]>
Co-authored-by: Samuel Thibault <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants