You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,10 +20,10 @@ Contents:
20
20
-[Features](#features)
21
21
-[Build Instructions](#build-instructions)
22
22
-[Codebase Organization](#codebase-organization)
23
-
-[Design and Architecture](doc/design.md)
24
-
-[Subsystems and System Calls](doc/syscalls.md)
25
-
-[Vision and Motivation](doc/vision.md)
26
-
-[Planning and Evolution](doc/planning.md)
23
+
-[Design and Architecture](docs/design.md)
24
+
-[Subsystems and System Calls](docs/syscalls.md)
25
+
-[Vision and Motivation](docs/vision.md)
26
+
-[Planning and Evolution](docs/planning.md)
27
27
28
28
If you think that UVM is cool, you can support my work via [GitHub Sponsors](https://github.com/sponsors/maximecb):heart:
29
29
@@ -123,18 +123,18 @@ The repository is organized into a 3 different subprojects, each of which is a R
123
123
-`/ncc`: An implementation of a toy C compiler that outputs UVM assembly
124
124
-[`/ncc/README.md`](ncc/README.md): documentation for the NCC compiler.
125
125
-[`/ncc/examples/*`](ncc/examples): Example C source files that can be compiled by NCC
126
-
-`/api`: A system to document and automatically export bindings for UVM system calls and constants.
127
-
-`/api/syscalls.json`: Declarative list of system calls exposed by UVM.
128
-
-`/doc`: Markdown documentation for UVM
129
-
-[`/doc/syscalls.json`](doc/syscalls.md): List of system calls and constants accessible to UVM programs
126
+
-`/spec`: A system to document and automatically export bindings for UVM system calls and constants.
127
+
-`/spec/syscalls.json`: Declarative list of system calls exposed by UVM.
128
+
-`/docs`: Markdown documentation for UVM
129
+
-[`/docs/syscalls.json`](docs/syscalls.md): List of system calls and constants accessible to UVM programs
130
130
131
131
The `ncc` compiler is, at the time of this writing, incomplete in that it lacks some C features and the error messages need improvement. This compiler
132
132
was implemented to serve as an example of how to write a compiler that targets UVM, and to write some library code to be used by other programs. Over
133
133
time, the `ncc` compiler will be improved. Despite its limitations, it is still usable to write small programs. Contributions to it are welcome.
134
134
135
-
The `api` directory contains JSON files that represent a declarative list of system calls, constants and the permission system that UVM exposes
135
+
The `spec` directory contains JSON files that represent a declarative list of system calls, constants and the permission system that UVM exposes
136
136
to programs running on it. This is helpful for documentation purposes, or if you want to build a compiler that targets UVM. The directory also contains
137
-
code that automatically generates [markdown documentation](doc/syscalls.md), Rust constants and [C definitions](ncc/include/uvm/syscalls.h) for system calls.
137
+
code that automatically generates [markdown documentation](docs/syscalls.md), Rust constants and [C definitions](ncc/include/uvm/syscalls.h) for system calls.
0 commit comments