mirror of https://github.com/seL4/docs.git
Avoid absolute paths
These break when site.base_url is non-empty. Signed-off-by: Gerwin Klein <gerwin.klein@proofcraft.systems>
This commit is contained in:
parent
369aa99280
commit
de0498b5f1
|
@ -57,12 +57,12 @@ resources for these topics include:
|
|||
Additional learning resources that may be helpful:
|
||||
|
||||
- The [seL4 manual](https://sel4.systems/Info/Docs/seL4-manual-latest.pdf)
|
||||
- The [seL4 API reference](/projects/sel4/api-doc.html)
|
||||
- The [seL4 API reference](../projects/sel4/api-doc.html)
|
||||
- The How-to pages for [seL4](how-to-seL4.html), [CAmkES](how-to-CAmkES.html),
|
||||
and [C libraries](how-to-libs.html) provide links to tutorial solutions as
|
||||
quick reference.
|
||||
- The [seL4 white paper](https://sel4.systems/About/seL4-whitepaper.pdf) for a
|
||||
high-level overview of what seL4 is and what it can do.
|
||||
- [FAQs](https://sel4.systems/About/FAQ.html)
|
||||
- [Debugging guide](/projects/sel4-tutorials/debugging-guide.html)
|
||||
- [Debugging guide](../projects/sel4-tutorials/debugging-guide.html)
|
||||
- [Help & Support](https://sel4.systems/support.html)
|
||||
|
|
|
@ -10,7 +10,7 @@ Google's `repo` tool. To start with, get repo by following the
|
|||
instructions in the section “Install” on the [repo
|
||||
site](https://gerrit.googlesource.com/git-repo#install).
|
||||
|
||||
See the [repo cheatsheet](/projects/buildsystem/repo-cheatsheet.html) page for a quick explanation of
|
||||
See the [repo cheatsheet] page for a quick explanation of
|
||||
how we use repo.
|
||||
|
||||
## Docker or native
|
||||
|
@ -117,5 +117,6 @@ pip3 install --user setuptools sel4-deps
|
|||
{% include pip-instructions.md deps="sel4-deps" %}
|
||||
|
||||
[edit]: https://github.com/seL4/docs/edit/master/_includes/seL4-deps.md
|
||||
[repo-cheatsheet]: {{ '/projects/buildsystem/repo-cheatsheet.html' | relative_url }}
|
||||
[contributions]: {{ '/processes/docs-contributing.html' | relative_url }}
|
||||
[docker]: {{ '/projects/dockerfiles/' | relative_url }}
|
||||
|
|
|
@ -9,20 +9,19 @@ seL4: 3.1.0
|
|||
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
SPDX-FileCopyrightText: 2020 seL4 Project a Series of LF Projects, LLC.
|
||||
---
|
||||
# CAmkES 2.2.0 Release Notes
|
||||
|
||||
# CAmkES 2.2.0 Release Notes
|
||||
|
||||
## New Features
|
||||
|
||||
|
||||
* realtime extensions: CAmkES systems can now run on [realtime seL4](/sel4_release/seL4_1.0.0-rt-dev). It is possible to configure the realtime properties of systems built to run on realtime seL4.
|
||||
- For more details, see the
|
||||
[Realtime Extensions section of the CAmkES Manual](https://github.com/seL4/camkes-tool/blob/master/docs/index.md#realtime-extensions).
|
||||
- realtime extensions: CAmkES systems can now run on [realtime
|
||||
seL4](../sel4/1.0.0-rt-dev.html). It is possible to configure the realtime
|
||||
properties of systems built to run on realtime seL4.
|
||||
- For more details, see the [Realtime Extensions section of the CAmkES
|
||||
Manual](https://github.com/seL4/camkes-tool/blob/master/docs/index.md#realtime-extensions).
|
||||
|
||||
- support for seL4 3.1.0
|
||||
|
||||
## Documentation Additions
|
||||
|
||||
|
||||
- "Keywords" section in manual
|
||||
|
||||
|
|
|
@ -47,7 +47,7 @@ the main website.
|
|||
The Rust programming language is a great fit for writing applications on top of
|
||||
seL4. Check out:
|
||||
|
||||
- the [Rust support for seL4](/projects/rust/), and
|
||||
- the [Rust support for seL4](projects/rust/), and
|
||||
- examples tagged with Rust on the seL4 [examples page].
|
||||
|
||||
## Build instructions and tests
|
||||
|
@ -62,7 +62,7 @@ seL4's claim to fame is that it is formally verified. These formal proofs are
|
|||
available in the [l4v](https://github.com/seL4/l4v/) repository with their own
|
||||
setup and build instructions. See the [verification pages] on the main website
|
||||
for an overview of the proofs, and check the [Verified
|
||||
Configurations](/projects/sel4/verified-configurations.html) to know which
|
||||
Configurations](projects/sel4/verified-configurations.html) to know which
|
||||
architecture/platform/configuration combinations of seL4 have verified
|
||||
properties.
|
||||
|
||||
|
|
|
@ -278,7 +278,7 @@ all the files in `helpers/`. Notable functions are:
|
|||
- `ApplyCommonReleaseVerificationSettings(release, verification)`: Sets flags
|
||||
for different combinations of 'release' (performance optimised builds) and
|
||||
'verification' (verification friendly features) builds. Please see [meta
|
||||
configuration options](using.html#Meta-configuration-options) for more detail
|
||||
configuration options](using.html#meta-configuration-options) for more detail
|
||||
on these options.
|
||||
|
||||
### Other provided helpers
|
||||
|
|
|
@ -8,7 +8,7 @@ SPDX-FileCopyrightText: 2020 seL4 Project a Series of LF Projects, LLC.
|
|||
|
||||
# Our old deprecated Build System
|
||||
|
||||
_For the new build system see [Building](/Developing/Building)._
|
||||
_For the new build system see the [build system overview](../)._
|
||||
|
||||
## Anatomy of the Build System
|
||||
The following files are the components
|
||||
|
|
|
@ -119,7 +119,7 @@ If attributes are ommitted, the values from the default element will be used ins
|
|||
</manifest>
|
||||
```
|
||||
|
||||
A pinned manifest uses pinned git revisions for all of its repositories. It is good practice to create a pinned manifest that refers to a working version of a project. For projects that we maintain, we provide at least two manifests: default.xml and master.xml See the [Releases](/releases.html) page for more information about what manifests we make available.
|
||||
A pinned manifest uses pinned git revisions for all of its repositories. It is good practice to create a pinned manifest that refers to a working version of a project. For projects that we maintain, we provide at least two manifests: default.xml and master.xml See the [Releases](../../releases.html) page for more information about what manifests we make available.
|
||||
|
||||
## Commands
|
||||
|
||||
|
@ -176,11 +176,7 @@ changed projects :
|
|||
[-] 121782a CMake add error condition
|
||||
|
||||
```
|
||||
<!--
|
||||
## Repo mirroring
|
||||
|
||||
TODO: Add details about repo mirroring
|
||||
-->
|
||||
## FAQ
|
||||
|
||||
### How do I check out a released version of a project such as seL4test?
|
||||
|
|
|
@ -10,7 +10,7 @@ SPDX-FileCopyrightText: 2020 seL4 Project a Series of LF Projects, LLC.
|
|||
|
||||
This page contains documentation for how to interact with and build a project
|
||||
that is using this build system. For new project development, see [incorporating
|
||||
the build system](/projects/buildsystem/incorporating.html).
|
||||
the build system](incorporating.html).
|
||||
|
||||
## Basic build initialisation
|
||||
|
||||
|
@ -175,13 +175,13 @@ across projects, have standardised behaviour. These options are as follows:
|
|||
- `-DSIMULATION`: Set to `0` or `1`: This produces a build of the project which
|
||||
is suited for running in an emulator such as QEMU.
|
||||
|
||||
Both the [seL4test](/projects/sel4test/) and [seL4bench](/projects/sel4bench/) projects follow this form.
|
||||
Both the [seL4test](../sel4test/) and [seL4bench](../sel4bench/) projects follow this form.
|
||||
|
||||
### sel4test example
|
||||
|
||||
For more information on configuring, building and running the [sel4test
|
||||
suite](https://github.com/seL4/sel4test), please see the [main page on
|
||||
seL4test](/projects/sel4test/).
|
||||
seL4test](../sel4test/).
|
||||
|
||||
## Cross compiling
|
||||
|
||||
|
|
|
@ -19,7 +19,7 @@ SPDX-FileCopyrightText: 2020 seL4 Project a Series of LF Projects, LLC.
|
|||
### Prerequisites
|
||||
|
||||
- Get the dependencies for building CAmkES by following [the setup instructions]
|
||||
(/projects/camkes/setting-up.html)
|
||||
(../camkes/setting-up.html)
|
||||
- Your host machine has to have a CPU that supports Vt-x virtualization
|
||||
(for Intel CPUs), or AMD-V (for AMD CPUs, but that wasn't tested). Any
|
||||
newer i7 core should have Vt-x. Note that you might have to enable it
|
||||
|
|
|
@ -11,7 +11,7 @@ SPDX-FileCopyrightText: 2025 Proofcraft Pty Ltd
|
|||
## Example Applications
|
||||
|
||||
Most of these examples can be found on the [examples & demos
|
||||
page](/examples.html).
|
||||
page](../../examples.html).
|
||||
|
||||
{% include component_list.md project='camkes' type='camkes-application' %}
|
||||
|
||||
|
|
|
@ -2,6 +2,7 @@
|
|||
parent: /projects/camkes/
|
||||
redirect_from:
|
||||
- /CAmkESDifferences
|
||||
archive: true
|
||||
SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
SPDX-FileCopyrightText: 2020 seL4 Project a Series of LF Projects, LLC.
|
||||
---
|
||||
|
|
|
@ -5,4 +5,4 @@ SPDX-FileCopyrightText: 2025 Proofcraft Pty Ltd
|
|||
# Supported platforms
|
||||
|
||||
The CAmkES component platform is supported by all [seL4-supported
|
||||
platforms](/Hardware/index.html).
|
||||
platforms](../../Hardware/index.html).
|
|
@ -45,7 +45,7 @@ The following additional resources are available:
|
|||
## Get CAmkES
|
||||
|
||||
- Make sure that you already have the tools to [build seL4 and
|
||||
CAmkES](/projects/buildsystem/host-dependencies.html).
|
||||
CAmkES](../buildsystem/host-dependencies.html).
|
||||
- Download CAmkES:
|
||||
|
||||
```sh
|
||||
|
|
|
@ -19,12 +19,10 @@ latest release is {{site.camkes}}.
|
|||
|
||||
Github: <https://github.com/seL4/camkes-tool/tree/next>
|
||||
|
||||
Main CAmkES page: [CAmkES](/CAmkES)
|
||||
Main CAmkES page: [CAmkES](./)
|
||||
|
||||
Summary of differences between CAmkES next and CAmkES master:
|
||||
[differences](/projects/camkes/differences.html)
|
||||
|
||||
VisualCAmkes, a GUI tool to view a CAmkES system: [VisualCAmkES](/VisualCAmkES/)
|
||||
[differences](differences.html)
|
||||
|
||||
## Setting up your machine
|
||||
|
||||
|
|
|
@ -71,7 +71,7 @@ See also the separate [capDL loader page](c-loader-app.html).
|
|||
This library is useful for building up a representation of a capDL state
|
||||
programmatically in memory and then writing that as a specification to disk. It
|
||||
allows the programmer to incrementally add information about kernel objects and
|
||||
capability distribution. The library is used by [CAmkES](/CAmkES/) to build up a
|
||||
capability distribution. The library is used by [CAmkES](../camkes/) to build up a
|
||||
spec describing the entire system, covering all components and connections.
|
||||
|
||||
See the repository [README]({{page.repo_link}}/python-capdl-tool/README.md)
|
||||
|
|
|
@ -39,4 +39,4 @@ A few machines already have a base-management-controller; if they have
|
|||
it we use it.
|
||||
|
||||
One machine, the CMA34D, needed some extras; they are documented on
|
||||
[CMA34DBMC](/CMA34DBMC).
|
||||
[CMA34DBMC](../../CMA34DBMC/).
|
||||
|
|
|
@ -6,7 +6,7 @@ SPDX-FileCopyrightText: 2025 Proofcraft Pty Ltd
|
|||
|
||||
# Microkit releases
|
||||
|
||||
This page documents tagged releases of the seL4 [Microkit](/projects/microkit/) and their
|
||||
This page documents tagged releases of the seL4 [Microkit](../projects/microkit/) and their
|
||||
corresponding SDK downloads and GPG signatures.
|
||||
|
||||
The downloads are signed by Ivan Velickovic <i.velickovic@unsw.edu.au> with the
|
||||
|
|
|
@ -6,8 +6,8 @@ SPDX-FileCopyrightText: 2020 seL4 Project a Series of LF Projects, LLC.
|
|||
# Contributing to kernel code
|
||||
|
||||
If the platform, architecture, feature that you are after is not listed on the
|
||||
[Supported Platforms page](/Hardware/), and if, from your available
|
||||
[options](/Hardware/index.html#not-in-the-lists-above), you choose to contribute
|
||||
[Supported Platforms page](../../Hardware/), and if, from your available
|
||||
[options](../../Hardware/index.html#not-in-the-lists-above), you choose to contribute
|
||||
the port or feature yourself, here are the guidelines for it.
|
||||
|
||||
There four classes of kernel contributions:
|
||||
|
|
|
@ -8,7 +8,7 @@ SPDX-FileCopyrightText: 2020 seL4 Project a Series of LF Projects, LLC.
|
|||
# Porting seL4 to a new platform
|
||||
|
||||
This section covers porting seL4 to a new ARM or RISC-V platform if it is not
|
||||
already covered in the list of [supported seL4 platforms](/Hardware/).
|
||||
already covered in the list of [supported seL4 platforms](../../Hardware/).
|
||||
|
||||
## Setup
|
||||
|
||||
|
@ -150,7 +150,7 @@ It is best to base the contents of this file off of other platforms of the same
|
|||
|
||||
When you contribute your port to seL4, sel4test must execute successfully and so the next
|
||||
step to check that your port works would be to get
|
||||
[the seL4test project](/projects/sel4test/) working.
|
||||
[the seL4test project](../sel4test/) working.
|
||||
|
||||
### ELF-loader
|
||||
|
||||
|
@ -158,7 +158,7 @@ Before we can run sel4test, we need to have seL4 booting first.
|
|||
|
||||
Although we use U-Boot as a bootloader, there are additional steps needed to initialise the
|
||||
hardware and setup system images before we can boot seL4. This is the purpose of the
|
||||
[ELF-loader](/projects/elfloader/).
|
||||
[ELF-loader](../elfloader/).
|
||||
|
||||
The code for the ELF-loader can be found in the `elfloader-tool` directory at the root of
|
||||
the [seL4_tools](https://github.com/seL4/seL4_tools) repository.
|
||||
|
|
|
@ -18,12 +18,12 @@ on the main seL4 website. For other previous features, see the release notes
|
|||
below.
|
||||
|
||||
For the verification status of all platforms, see [Verified
|
||||
Configurations](/projects/sel4/verified-configurations.html).
|
||||
Configurations](../projects/sel4/verified-configurations.html).
|
||||
|
||||
| Feature | Hardware | Available From |
|
||||
| - | - | - |
|
||||
| AARCH64 RPI3 | [RPI3](/Hardware/Rpi3.md) | [10.1.0](sel4/10.1.0.html) |
|
||||
| TX2 support (Aarch64 only) | [TX2](/Hardware/JetsonTX2.md) | [10.1.0](sel4/10.1.0.html) |
|
||||
| AARCH64 RPI3 | [RPI3](../Hardware/Rpi3.html) | [10.1.0](sel4/10.1.0.html) |
|
||||
| TX2 support (Aarch64 only) | [TX2](../Hardware/JetsonTX2.html) | [10.1.0](sel4/10.1.0.html) |
|
||||
| Support for more than 1 VM | ARM | [10.1.0](sel4/10.1.0.html) |
|
||||
| 32-bit RISC-V architecture support | RISC-V (Spike simulation target) | [10.0.0](sel4/10.0.0.html) |
|
||||
| 64-bit RISC-V architecture support | RISC-V (Spike simulation target) | [9.0.1](sel4/9.0.1.html) |
|
||||
|
@ -32,14 +32,14 @@ Configurations](/projects/sel4/verified-configurations.html).
|
|||
| Zynq UltraScale+ MPSoC | Xilinx ZCU102, ARMv8a, Cortex A53 | [8.0.0](sel4/8.0.0.html) |
|
||||
| Multiboot2 support | x86 | [8.0.0](sel4/8.0.0.html) |
|
||||
| CMake based build system | all | [7.0.0](sel4/7.0.0.html) |
|
||||
| ARM 32-bit SMP | [Sabre](/Hardware/sabreLite.md) | [6.0.0](sel4/6.0.0.html) |
|
||||
| ARM 32-bit SMP | [Sabre](../Hardware/sabreLite.html) | [6.0.0](sel4/6.0.0.html) |
|
||||
| ARMv7 32-bit FPU support | ARM | [6.0.0](sel4/6.0.0.html) |
|
||||
| ARM 64-bit support | Aarch64 | [5.0.0](sel4/5.0.0.html) |
|
||||
| 64-bit x86 support | x86\_64 | [4.0.0](sel4/4.0.0.html) |
|
||||
| Raspberry Pi 3 support | [RPI3](/Hardware/Rpi3.md) | [4.0.0](sel4/4.0.0.html) |
|
||||
| Raspberry Pi 3 support | [RPI3](../Hardware/Rpi3.html) | [4.0.0](sel4/4.0.0.html) |
|
||||
| ARM Hypervisor initial support | ARM | [3.2.0](sel4/3.2.0.html) |
|
||||
| First ARMv8 support | [HiKey](/Hardware/HiKey/) | [3.1.0](sel4/3.1.0.html) |
|
||||
| NVIDIA Tegra K1 support | [TK1](/Hardware/jetsontk1.md) | [3.0.1](sel4/3.0.1.html) |
|
||||
| First ARMv8 support | [HiKey](../Hardware/HiKey/) | [3.1.0](sel4/3.1.0.html) |
|
||||
| NVIDIA Tegra K1 support | [TK1](../Hardware/jetsontk1.html) | [3.0.1](sel4/3.0.1.html) |
|
||||
| Notification binding | all | [2.0.0](sel4/2.0.0.html) |
|
||||
|
||||
## Main releases
|
||||
|
|
|
@ -55,7 +55,7 @@ Notably ``kernel.elf`` is the kernel binary, and ``kernel_all_pp.c`` is
|
|||
the kernel source code after preprocessing, which is used as the basis
|
||||
for verification efforts.
|
||||
|
||||
Also see [standalone seL4 builds](/projects/buildsystem/standalone.md) for
|
||||
Also see [standalone seL4 builds](../buildsystem/standalone.md) for
|
||||
general guidelines on generating an seL4 binary and build system information
|
||||
from an existing configuration.
|
||||
|
||||
|
|
|
@ -58,7 +58,7 @@ version numbers, see the [release page](../../releases.html) and the list of
|
|||
|
||||
The CMake build environment supports a number of platforms. For information on
|
||||
which ones these are and their corresponding CMake configuration arguments, see
|
||||
the [Supported Platforms](/Hardware) page.
|
||||
the [Supported Platforms](../../Hardware) page.
|
||||
|
||||
For the available meta configuration options, see [below](#configuration-options).
|
||||
|
||||
|
|
|
@ -60,7 +60,7 @@ the list of [seL4 releases](../../releases/seL4.html).
|
|||
|
||||
The CMake build environment supports a number of platforms. For information on
|
||||
which ones these are and their corresponding CMake configuration arguments, see
|
||||
the [Supported Platforms](/Hardware) page.
|
||||
the [Supported Platforms](../../Hardware) page.
|
||||
|
||||
To start a build with a specific configuration we can create a new subdirectory
|
||||
from the project root and initialise it with `init-build`:
|
||||
|
@ -188,7 +188,7 @@ below.
|
|||
For an overview of the CMake build system and further configuration options for
|
||||
the kernel, including configuring for cross compilation (e.g., targeting Arm or
|
||||
RISC-V on an x86 build machine), see the page on seL4's [CMake Build
|
||||
System](/projects/buildsystem/using.html).
|
||||
System](../buildsystem/using.html).
|
||||
|
||||
## Implementation
|
||||
|
||||
|
|
Loading…
Reference in New Issue