{"id":27894448,"url":"https://github.com/rust-lang/fls","last_synced_at":"2025-05-16T06:04:21.209Z","repository":{"id":49786112,"uuid":"491000927","full_name":"rust-lang/fls","owner":"rust-lang","description":"The FLS","archived":false,"fork":false,"pushed_at":"2025-05-11T23:48:20.000Z","size":4353,"stargazers_count":434,"open_issues_count":54,"forks_count":32,"subscribers_count":24,"default_branch":"main","last_synced_at":"2025-05-15T00:05:38.596Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://rust-lang.github.io/fls","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rust-lang.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSES/Apache-2.0.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-05-11T07:23:37.000Z","updated_at":"2025-05-11T23:48:22.000Z","dependencies_parsed_at":"2024-03-22T08:33:50.924Z","dependency_job_id":"36edeb01-d63b-4a0e-a70e-e98304b79a5a","html_url":"https://github.com/rust-lang/fls","commit_stats":null,"previous_names":["rust-lang/fls"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rust-lang%2Ffls","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rust-lang%2Ffls/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rust-lang%2Ffls/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rust-lang%2Ffls/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rust-lang","download_url":"https://codeload.github.com/rust-lang/fls/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254478186,"owners_count":22077675,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-05T14:40:59.540Z","updated_at":"2025-05-16T06:04:21.189Z","avatar_url":"https://github.com/rust-lang.png","language":"Python","funding_links":[],"categories":["reStructuredText"],"sub_categories":[],"readme":".. SPDX-License-Identifier: MIT OR Apache-2.0\n   SPDX-FileCopyrightText: The Ferrocene Developers\n\n================================\nFerrocene Language Specification\n================================\n\n.. raw:: html\n\n   \u003cp align=\"center\"\u003e\u003ca href=\"https://spec.ferrocene.dev\"\u003eRead the\n   specification \u0026raquo;\u003c/a\u003e\u003c/p\u003e\n\nThe Ferrocene Language Specification (FLS) is a document describing the Rust\nlanguage. It was created as one of the prerequisites for qualifying\n`Ferrocene`_, a Rust toolchain qualified for safety-critical environments. The\nFLS is compiled of existing Rust documentation, but presented with a rigorous\nstructure in order to meet the requirements of qualification.\n\nThe FLS is not intended to be used as the normative specification of the Rust\nlanguage, nor is it meant to replace the decision-making processes of the Rust\nproject. Any difference between the FLS and the behavior of the Rust compiler\nis considered an error on our part and the FLS will be updated accordingly.\n\nThe Ferrocene Language Specification text is licensed under either the ``MIT``\nor ``Apache-2.0`` licenses, at your option. Individual files might have\ndifferent licensing. Licensing metadata is present in each file, and the full\nlicenses text is present in the ``LICENSES/`` directory.\n\n.. _Ferrocene: https://ferrocene.dev\n\nBuilding the specification\n==========================\n\nFLS uses `Sphinx`_ to build a rendered version of the specification, and `uv`_ to install and manage\nPython dependencies (including Sphinx itself). To simplify building the rendered version, we created\na script called ``make.py`` that takes care of invoking Sphinx with the right flags.\n\nYou can build the rendered version by running::\n\n   ./make.py\n\nBy default, Sphinx uses incremental rebuilds to generate the content that\nchanged since the last invocation. If you notice a problem with incremental\nrebuilds, you can pass the ``-c`` flag to clear the existing artifacts before\nbuilding::\n\n   ./make.py -c\n\nThe rendered version will be available in ``build/html/``.\n\nYou can also start a local server on port 8000 with automatic rebuild and\nreload whenever you change a file by passing the ``-s`` flag::\n\n   ./make.py -s\n\nChecking links consistency\n==========================\n\nIt's possible to run Rust's linkchecker tool on the rendered documentation, to\nsee if there are broken links. To do so, pass the ``--check-links`` flag::\n\n   ./make.py --check-links\n\nThis will clone the source code of the tool, build it, and execute it on the\nrendered documentation.\n\n.. _Sphinx: https://www.sphinx-doc.org\n.. _uv: https://docs.astral.sh/uv/\n\nUpdating build dependencies\n===========================\n\nThe FLS uses ``uv`` to manage the Python dependencies used for builds. If you change the list of\ndependencies in ``pyproject.toml`` they will automatically be installed the next time you run\n``make.py``. If you want to update the packages in the lockfile, run::\n\n   uv lock --upgrade\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frust-lang%2Ffls","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frust-lang%2Ffls","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frust-lang%2Ffls/lists"}