-
Notifications
You must be signed in to change notification settings - Fork 52
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOCSITE: Reorganise tutorials and add inline solutions #231
base: master
Are you sure you want to change the base?
Changes from 63 commits
502c045
3321716
ca73b83
cd889c4
0d7dc88
c6e88b0
85b9591
f918f4a
fa1c85d
a311549
cb2fc67
9007734
8f11ebd
a18f827
d63b96f
6e8dbed
e293afc
84168b0
c9aaf62
442aacb
ce25b3f
dae73c8
4bfd6d9
1769b62
98b162c
7071759
438d54a
5fbdc58
94045ff
5e86114
104f7d0
4758f09
c22a3e6
61f321c
cd34825
74e0413
f159026
afc4010
8af55ad
264bdc4
3ecb6fa
43542f4
94fe1fc
ba70bbe
d3ba4f8
0556ae4
d28d363
68c00ea
28d8d6d
51ad641
9b3284c
5e641fb
cd0344e
e8ff93d
42b9c6c
6502de9
c6d7a3a
3e2f994
aa1e4d1
127113e
a134caf
9dd38d1
0bb322a
6ff3c1a
eb0932b
da53f84
4655aad
4791ced
203a9f8
9eafb8a
aefbaab
4fd520d
02f9734
2debab4
fc11969
ce0ef6d
7a0599d
f635bf1
b787447
35dd737
9aa4207
a50cf29
1e2e4b1
09108e1
34f5313
48dbb59
99ae7a4
5578b97
c4e61e4
ba83f25
448e41c
1903f1c
04c005a
8a3bc44
5336a78
06e6c24
07952f1
ad85e98
6505987
fd00916
fa69841
6e5059f
7620007
bcbc394
238fb77
c6adfe6
6258219
e20dd47
a2a59cd
0bc8c02
5fc2d96
1eb12d5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,7 +29,7 @@ menuentry "Load seL4 VM" --class os { | |
insmod part_msdos | ||
insmod ext2 | ||
set root='(hd0,msdos2)' | ||
multiboot /boot/sel4kernel | ||
multiboot /boot/seL4 | ||
module /boot/sel4rootserver | ||
} | ||
``` | ||
|
@@ -59,13 +59,13 @@ install-mbr /dev/sdb | |
syslinux --install /dev/sdb1 | ||
mount /dev/sdb1 /mnt | ||
cp images/sel4test-driver-image-ia32-pc99 /mnt/rootserver | ||
cp images/kernel-ia32-pc99 /mnt/sel4kernel | ||
cp images/kernel-ia32-pc99 /mnt/seL4 | ||
cat > /mnt/syslinux.cfg <<EOF | ||
SERIAL 0 115200 | ||
DEFAULT seL4test | ||
LABEL seL4test | ||
kernel mboot.c32 | ||
append sel4kernel --- rootserver | ||
append seL4 --- rootserver | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. these two as well |
||
EOF | ||
cp /usr/lib/syslinux/modules/bios/mboot.c32 /mnt | ||
cp /usr/lib/syslinux/modules/bios/libcom32.c32 /mnt | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
# Copyright 2020 seL4 Project a Series of LF Projects, LLC. | ||
# SPDX-License-Identifier: BSD-2-Clause | ||
|
||
default: serve | ||
default: serve --trace | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is the makefile default target, not a shell command, so adding |
||
|
||
.PHONY: ruby_deps | ||
ruby_deps: Gemfile Gemfile.lock | ||
|
@@ -51,7 +51,7 @@ _repos/tutes: | |
_repos/tutes/%.md: _repos/sel4proj/sel4-tutorials/tutorials/% _repos/tutes | ||
PYTHONPATH=_repos/sel4/capdl/python-capdl-tool _repos/sel4proj/sel4-tutorials/template.py --docsite --out-dir _repos/tutes --tut-file $</$(@F) | ||
|
||
TUTORIALS:= $(filter-out index.md,$(notdir $(wildcard Tutorials/*.md))) | ||
TUTORIALS:= $(filter-out index.md get-the-tutorials.md how-to.md pathways.md sel4-overview.md setting-up.md,$(notdir $(wildcard Tutorials/*.md))) | ||
tutorials: ${TUTORIALS:%=_repos/tutes/%} | ||
|
||
_generate_api_pages: $(REPOSITORIES) | ||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -5,9 +5,9 @@ SPDX-License-Identifier: CC-BY-SA-4.0 | |||||
SPDX-FileCopyrightText: 2020 seL4 Project a Series of LF Projects, LLC. | ||||||
--- | ||||||
|
||||||
# Getting Started | ||||||
# Resources | ||||||
|
||||||
This page is a quick start for working with seL4 and its ecosystem. | ||||||
This page provides an overview on working with seL4 and its ecosystem. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
## Background and terminology | ||||||
|
||||||
|
@@ -168,7 +168,12 @@ You can find a long list of seL4 publications here: | |||||
- [seL4 is free: What does this mean for you? (2015)](https://www.youtube.com/watch?v=lRndE7rSXiI). | ||||||
- [From L3 to seL4: What have we learned in 20 years of L4 microkernels? (2014)](https://www.youtube.com/watch?v=RdoaFc5-1Rk). | ||||||
|
||||||
## Get Help | ||||||
## Contact | ||||||
|
||||||
### Forums | ||||||
|
||||||
- [Discourse forum](https://sel4.discourse.group/) | ||||||
- [Mattermost channel](https://mattermost.trustworthy.systems/sel4-external/) | ||||||
|
||||||
### Mailing lists | ||||||
|
||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,11 @@ title: Capabilities | |
tutorial: capabilities | ||
tutorial-order: mechanisms-1 | ||
description: an introduction to capabilities in the seL4 kernel API. | ||
layout: tutorial | ||
SPDX-License-Identifier: CC-BY-SA-4.0 | ||
SPDX-FileCopyrightText: 2020 seL4 Project a Series of LF Projects, LLC. | ||
SPDX-FileCopyrightText: 2024 seL4 Project a Series of LF Projects, LLC. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Legally speaking it is more important to document the oldest date than the newest. The oldest date makes it clear when your version of the text was first created, making it harder for others to claim their version of the text is the original one. The oldest date is only relevant for when the copyright expires, which is usually about 70 years after first publication. So my advice is to either update it to 2020-2024 or even better, just don't bother updating the year at all until around 2070 or so. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'll put a note in my calendar to make the change in 2070 :-D |
||
--- | ||
|
||
{% include tutorial.md %} | ||
|
||
Next tutorial: <a href="untyped">Untyped</a> |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,9 +3,13 @@ toc: true | |
title: Dynamic Libraries 1 | ||
tutorial: dynamic-1 | ||
tutorial-order: dynamic-1 | ||
layout: tutorial | ||
description: system initialisation & threading with seL4_libs. | ||
SPDX-License-Identifier: CC-BY-SA-4.0 | ||
SPDX-FileCopyrightText: 2020 seL4 Project a Series of LF Projects, LLC. | ||
--- | ||
{% include tutorial.md %} | ||
|
||
|
||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are these empty lines deliberate? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nope. D'oh. |
||
Next tutorial: <a href="dynamic-2">IPC</a> |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
toc: true | ||
title: Getting the tutorials | ||
layout: tutorial | ||
SPDX-License-Identifier: CC-BY-SA-4.0 | ||
SPDX-FileCopyrightText: 2024 seL4 Project a Series of LF Projects, LLC. | ||
--- | ||
|
||
# Getting the tutorials | ||
## Python Dependencies | ||
Additional python and CAmkES dependencies are required to build [tutorials](ReworkedTutorials). To install you can run: | ||
bbrcknl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
pip3 install --user aenum pyelftools camkes-deps | ||
bbrcknl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
*Hint:* This step only needs to be done once, i.e. before doing your first tutorial | ||
bbrcknl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Get the code | ||
All tutorials are in the <a href="https://github.com/seL4/sel4-tutorials-manifest">sel4-tutorials-manifest</a>. Get the code with: | ||
bbrcknl marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
mkdir sel4-tutorials-manifest | ||
cd sel4-tutorials-manifest | ||
repo init -u https://github.com/seL4/sel4-tutorials-manifest | ||
repo sync | ||
``` | ||
|
||
`repo sync` may take a few moments to run | ||
|
||
*Hint:* The **Get the code** step only needs to be done once, i.e. before doing your first tutorial. | ||
|
||
<p> | ||
Next: <a href="hello-world">Hello world</a> | ||
</p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this one looks like it got caught in a global search/replace. It should stay on
sel4kernel