docs

Documentation

This is a reference of all Onramp documentation.

Onramp documentation (including this README.md) is written in [GitHub-Flavored Markdown][gfm]. Onramp is heavily documented; specifications are written for all of Onramp's tools and languages.

Project Organization

• core/ - The platform-independent parts of Onramp. Contains the compiler, linker, driver, libc, etc.
• platform/ - Implementations of the platform-specific components of Onramp for various platforms.
• extra/ - Additional tools beyond the core bootstrap.
• scripts/ - Scripts for building and installing Onramp on various platforms.
• docs/ - Specifications of Onramp's languages and other documentation. Defines the Onramp subsets of C, Onramp Assembly, etc.
• test/ - Test cases and scripts for testing the various Onramp components.

Index

The following documentation pages are available:

• Main Page
• Guides
  • Setup Guide
  • Usage Guide
• Specifications
  • Onramp Hexadecimal
  • Onramp Virtual Machine
  • Onramp Object Code
  • Onramp Assembly
  • Onramp Intermediate Representation
  • Onramp Minimal C
  • Onramp Practical C
  • Onramp Shell
  • Onramp Debug Info
• Miscellaneous
  • Implementation Status
  • Bootstrap Path
  • Testing Onramp
  • Coding Without Labels
  • Inspiration
• Tools
  • core: Core Tools
    • ar: Archiver
      • ar/0-cat: Primitive Archiver
      • ar/1-unix: Final Archiver
    • as: Assembler
      • as/0-basic: Primitive Assembler
      • as/1-compound: Compound Assembler
      • as/2-full: Final Assembler
    • cc: Driver
    • cci: Compiler
      • cci/0-omc: omC Compiler
      • cci/1-opc: opC Compiler
      • cci/2-full: Final Compiler
    • cg: Code Generator
      • cg/0-asm: Assembly Code Generator
      • cg/1-full: Final (IR) Code Generator
    • cpp: Preprocessor
      • cpp/0-strip: Directive Stripper
      • cpp/1-omc: omC Preprocessor
      • cpp/2-full: Final Preprocessor
    • hex: Hex Tool
      • hex/0-onramp: Bytecode Hex Tool
      • hex/1-c89: Final (C89) Hex Tool
    • ld: Linker
      • ld/0-global: Primitive Linker
      • ld/1-omc: omC Linker
      • ld/2-full: Final Linker
    • libc: Standard Library
      • libc/0-oo: Object Code libc
      • libc/1-omc: omC libc
      • libc/2-opc: opC libc
      • libc/3-full: Final libc
    • os: Operating System
      • os/0-minfs: Minimal Filesystem OS
      • os/1-full: Final OS
    • sh: Shell
  • extra: Extra Tools
    • disas: Disassembler
    • strace: Syscall Tracer
    • vminfo: VMInfo tool
  • platform: Platform-specific Tools
    • cc: Platform-specific Driver Extensions
    • hex: Platform-specific Hex Tools
    • vm: Virtual Machines

File Types

Extension	Description
.ohx	[Onramp Hexadecimal][dochex], plain-text hexadecimal with comments
.oe	[Onramp Executable][docvm], an Onramp bytecode program in binary
.oo	[Onramp Object File][docobj], plain-text bytecode with labels
.oa	[Onramp Archive][docobj], a static library of .oo files
.os	[Onramp Assembly][docasm], our custom assembly language
.oir	[Onramp Intermediate Representation][docir], our compiler IR
.i	Preprocessed C source code (no comments, no preprocessor directives)
.c	C source code, an Onramp Subset ([omC] or [opC]) or a standard version
.sh	[Onramp Shell][docsh], our subset of POSIX shell
.od	[Onramp Debug Info][docdebug], the debug symbols for an Onramp executable