Skip to content

Commit 6b06ce4

Browse files
committed
Initial Commit - Publish initial public versions of doc files
0 parents  commit 6b06ce4

7 files changed

+7542
-0
lines changed

LICENSE

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
MIT License
2+
3+
Copyright (c) 2020 DropDemBits
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6+
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8+
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
10+

README.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Turing Low-level Documentation
2+
This repository contains files describing some low-level aspects of the Turing
3+
interpreter (also know as TProlog) used by Turing and OpenTuring.
4+
5+
All information was gathered from the [OpenTuring](https://github.com/Open-Turing-Project/OpenTuring) repository.
6+
7+
## File overview
8+
The following files are included in this repository:
9+
10+
- `turing_abort_codes.txt`: Internal abort code numbers and their translations
11+
- `bytecode_header.c`: Format of the bytecode files packed inside compiled
12+
& exported Turing programs
13+
- `UninitPattern.md`: Document describing uninitialization patterns used
14+
by the UNINIT and NEW\* family of opcodes
15+
- `TuringOpcodeRef.md`: Reference for all of the valid opcodes used by the
16+
TProlog bytecode interpreter.
17+
- `RefTodo.txt`: Todo reference for `TuringOpcodeReference.md`
18+
(incomplete).
19+
20+
## License
21+
All files are licensed under the MIT License.

RefTodo.txt

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Need Documentation:
2+
3+
Documentation Notation:
4+
----------------------
5+
- Shorthands for types in opcode args
6+
- Migrate old style opcode arg types to shorthand prefixes
7+
- Other
8+
9+
Desc: Needs general description (Description, Exceptions)
10+
SADesc: Needs stack argument description
11+
ADesc: Needs opcode argument description
12+
13+
Stream & IO Ops:
14+
----------------
15+
(Desc) TELL - Tell file offset
16+
(Desc) SEEK - Seek to
17+
(Desc) SEEKSTAR - Seek to End
18+
(ADesc) GET
19+
(SADesc) PUT
20+
(SADesc) READ
21+
(SADesc) WRITE
22+
23+
Concurrency & Monitors:
24+
-----------------------
25+
(SADesc) FORK

0 commit comments

Comments
 (0)