Merge #32 #39 #41 #42 #44

32: add missing option to config.example.toml r=Dajamante a=tshepang



39: missing word r=Dajamante a=tshepang



41: simplify (Rust) language mention r=Dajamante a=tshepang



42: match other titles by not mentioning "Ferrocene" r=Dajamante a=tshepang



44: Automated pull from `rust-lang/libc` r=Dajamante 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#3378
* rust-lang/libc#3379


Co-authored-by: Tshepang Mbambo <tshepang.mbambo@ferrous-systems.com>
Co-authored-by: Yuki Okushi <jtitor@2k36.org>
Co-authored-by: bors <bors@rust-lang.org>
Co-authored-by: 袁浩 <yuanhao34@huawei.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

config.example.toml

@@ -882,3 +882,9 @@ change-id = 115898
 
 # Name of the AWS S3 bucket containing the document signatures file.
 #document-signatures-s3-bucket = "ferrocene-document-signatures"
+
+# The following serves two purposes when set to true:
+# - Avoids "Unsigned draft" warning in Qualification docs, when they are not signed
+# - Avoids an error that occurs if signatures are present,
+#   but you don't have access to the private signature files
+#ignore-document-signatures = false

ferrocene/doc/index/index.html

@@ -100,7 +100,7 @@ <h3>Document List</h3>
                         <p>The reference list of documents used for the qualification dossier</p>
                     </a>
                     <a href="qualification/internal-procedures/index.html">
-                        <h3>Ferrocene Internal Procedures</h3>
+                        <h3>Internal Procedures</h3>
                         <p>Engineering level procedures for installing the develoment environment, using the existing infrastructure, and working with the Ferrocene toolchain.</p>
                     </a>
                 </div>

ferrocene/doc/qualification-report/src/tests.rst

@@ -27,8 +27,8 @@ For this qualification, testing is restricted to the following environment:
 
 .. note::
 
-   For the Rust language, only the Rust standard as described in the
-   Ferrocene :doc:`Language Specification document <specification:index>`
+   Only the Rust language,
+   as described in the :doc:`specification:index`,
    is verified.
 
 Bare metal testing

ferrocene/doc/safety-manual/src/environment.rst

@@ -27,9 +27,11 @@ end-use code is outside the scope of the current Ferrocene qualification. It
 is the end-user responsibility to qualify these libraries if they are used in
 their code.
 
-.. Note::
-   For the Rust language, only the Rust standard as described in the
-   Ferrocene :doc:`Language Specification document <specification:index>`.
+.. note::
+
+   Only the Rust language,
+   as described in the :doc:`specification:index`,
+   is verified.
 
 The qualification scope is limited to the set of supported compilation options
 described in the :doc:`Tool Options <safety-manual:options>`.

ferrocene/doc/safety-manual/src/options.rst

@@ -39,6 +39,6 @@ defined and tested by the Ferrocene testsuite.
 
 If the end user requires CLI options other than those identified in this
 chapter, they must verify that the feature exists and is compatible with their
-target, that their safety context is compatible with the use of CLI option or
+target, that their safety context is compatible with the use of the CLI option or
 feature, and develop appropriate verification activities and tests to ensure
 the correct functionality of the generated code.

ferrocene/library/libc/.github/workflows/bors.yml

@@ -335,24 +335,6 @@ jobs:
       - name: Build with check-cfg
         run: LIBC_CI=1 LIBC_CHECK_CFG=1 cargo build -Z unstable-options -Z check-cfg=features,names,values,output
 
-  docs:
-    permissions:
-      actions: write # to cancel workflows (rust-lang/simpleinfra/github-actions/cancel-outdated-builds)
-      contents: read # to fetch code (actions/checkout)
-
-    name: Generate documentation
-    runs-on: ubuntu-22.04
-    needs: docker_linux_tier2
-    steps:
-      - uses: rust-lang/simpleinfra/github-actions/cancel-outdated-builds@HEAD
-        with:
-          github_token: "${{ secrets.GITHUB_TOKEN }}"
-      - uses: actions/checkout@v3
-      - name: Setup Rust toolchain
-        run: sh ./ci/install-rust.sh
-      - name: Generate documentation
-        run: LIBC_CI=1 sh ci/dox.sh
-
   # These jobs doesn't actually test anything, but they're only used to tell
   # bors the build completed, as there is no practical way to detect when a
   # workflow is successful listening to webhooks only.
@@ -374,7 +356,6 @@ jobs:
       build_channels_linux,
       build_channels_macos,
       build_channels_windows,
-      docs,
     ]
 
     steps:
@@ -396,7 +377,6 @@ jobs:
       build_channels_linux,
       build_channels_macos,
       build_channels_windows,
-      docs,
     ]
 
     steps:

ferrocene/library/libc/README.md

@@ -60,7 +60,7 @@ newer Rust features are only available on newer Rust toolchains:
 
 ## Platform support
 
-[Platform-specific documentation (HEAD)][docs.head].
+You can see the platform(target)-specific docs on [docs.rs], select a platform you want to see.
 
 See
 [`ci/build.sh`](https://github.com/rust-lang/libc/blob/HEAD/ci/build.sh)
@@ -107,4 +107,3 @@ dual licensed as above, without any additional terms or conditions.
 [Documentation]: https://docs.rs/libc/badge.svg
 [docs.rs]: https://docs.rs/libc
 [License]: https://img.shields.io/crates/l/libc.svg
-[docs.head]: https://rust-lang.github.io/libc/#platform-specific-documentation

ferrocene/library/libc/src/lib.rs

@@ -1,8 +1,4 @@
 //! libc - Raw FFI bindings to platforms' system libraries
-//!
-//! [Documentation for other platforms][pd].
-//!
-//! [pd]: https://rust-lang.github.io/libc/#platform-specific-documentation
 #![crate_name = "libc"]
 #![crate_type = "rlib"]
 #![allow(

ferrocene/library/libc/src/teeos/mod.rs

@@ -8,6 +8,8 @@
 // only supported on Rust > 1.59, so we can directly reexport c_void from core.
 pub use core::ffi::c_void;
 
+use Option;
+
 pub type c_schar = i8;
 
 pub type c_uchar = u8;