189 lines
5.3 KiB
Plaintext
189 lines
5.3 KiB
Plaintext
Format: 1.52
|
|
|
|
|
|
Title: StupidOS
|
|
SubTitle: 32-bit Operating System written in x86 assembly.
|
|
|
|
Footer: Copyright (C) 2024 d0p1
|
|
Timestamp: Updated yyyy/mm/dd
|
|
# m - One or two digit month. January is "1"
|
|
# mm - Always two digit month. January is "01"
|
|
# mon - Short month word. January is "Jan"
|
|
# month - Long month word. January is "January"
|
|
# d - One or two digit day. 1 is "1"
|
|
# dd - Always two digit day. 1 is "01"
|
|
# day - Day with letter extension. 1 is "1st"
|
|
# yy - Two digit year. 2006 is "06"
|
|
# yyyy - Four digit year. 2006 is "2006"
|
|
# year - Four digit year. 2006 is "2006"
|
|
|
|
# These are indexes you deleted, so Natural Docs will not add them again
|
|
# unless you remove them from this line.
|
|
|
|
Don't Index: Classes, Macros, Variables
|
|
|
|
|
|
# --------------------------------------------------------------------------
|
|
#
|
|
# Cut and paste the lines below to change the order in which your files
|
|
# appear on the menu. Don't worry about adding or removing files, Natural
|
|
# Docs will take care of that.
|
|
#
|
|
# You can further organize the menu by grouping the entries. Add a
|
|
# "Group: [name] {" line to start a group, and add a "}" to end it.
|
|
#
|
|
# You can add text and web links to the menu by adding "Text: [text]" and
|
|
# "Link: [name] ([URL])" lines, respectively.
|
|
#
|
|
# The formatting and comments are auto-generated, so don't worry about
|
|
# neatness when editing the file. Natural Docs will clean it up the next
|
|
# time it is run. When working with groups, just deal with the braces and
|
|
# forget about the indentation and comments.
|
|
#
|
|
# --------------------------------------------------------------------------
|
|
|
|
|
|
File: Introduction (docs/intro.txt)
|
|
Link: Source Code (https://git.cute.engineering/d0p1/StupidOS)
|
|
File: Coding Style (docs/coding-style.txt)
|
|
File: FAQ (docs/faq.txt)
|
|
Link: StupidFS (https://stupidfs.d0p1.eu/)
|
|
File: Common Object File Format &lparen;COFF&rparen; (docs/COFF.txt)
|
|
|
|
Group: BootLoader {
|
|
|
|
File: Introduction (boot/intro.txt)
|
|
|
|
Group: BootSector {
|
|
|
|
File: floppy.asm (boot/bootsect/floppy.asm)
|
|
File: hdd.asm (boot/bootsect/hdd.asm)
|
|
} # Group: BootSector
|
|
|
|
Group: Loader {
|
|
|
|
File: a20.inc (boot/loader/a20.inc)
|
|
File: loader.asm (boot/loader/loader.asm)
|
|
File: logger.inc (boot/loader/logger.inc)
|
|
File: memory.inc (boot/loader/memory.inc)
|
|
File: video.inc (boot/loader/video.inc)
|
|
} # Group: Loader
|
|
|
|
Group: Common {
|
|
|
|
File: bios.inc (boot/common/bios.inc)
|
|
File: bootinfo.inc (boot/common/bootinfo.inc)
|
|
File: fat12.inc (boot/common/fat12.inc)
|
|
File: macro.inc (boot/common/macro.inc)
|
|
File: mbr.inc (boot/common/mbr.inc)
|
|
} # Group: Common
|
|
|
|
Group: EFI {
|
|
|
|
File: bootia32.asm (boot/efi/bootia32.asm)
|
|
File: uefi.inc (boot/efi/uefi.inc)
|
|
} # Group: EFI
|
|
|
|
} # Group: BootLoader
|
|
|
|
Group: Kernel {
|
|
|
|
File: Introduction (kernel/intro.txt)
|
|
File: gdt.inc (kernel/gdt.inc)
|
|
File: heap.inc (kernel/heap.inc)
|
|
File: idt.inc (kernel/idt.inc)
|
|
File: isr.inc (kernel/isr.inc)
|
|
File: kernel.asm (kernel/kernel.asm)
|
|
File: klog.inc (kernel/klog.inc)
|
|
|
|
Group: Devices {
|
|
|
|
Group: At {
|
|
|
|
File: IBM PC/AT (kernel/dev/at/intro.txt)
|
|
File: cga.inc (kernel/dev/at/cga.inc)
|
|
File: cmos.inc (kernel/dev/at/cmos.inc)
|
|
File: com.inc (kernel/dev/at/com.inc)
|
|
File: floppy.inc (kernel/dev/at/floppy.inc)
|
|
File: ide.inc (kernel/dev/at/ide.inc)
|
|
File: kbd.inc (kernel/dev/at/kbd.inc)
|
|
File: ne2k.inc (kernel/dev/at/ne2k.inc)
|
|
File: pit.inc (kernel/dev/at/pit.inc)
|
|
} # Group: At
|
|
|
|
File: console.inc (kernel/dev/console.inc)
|
|
File: dev.inc (kernel/dev/dev.inc)
|
|
} # Group: Devices
|
|
|
|
Group: File Systems {
|
|
|
|
File: fat.inc (kernel/fs/fat.inc)
|
|
File: stpdfs.inc (kernel/fs/stpdfs.inc)
|
|
File: xv6fs.inc (kernel/fs/xv6fs.inc)
|
|
} # Group: File Systems
|
|
|
|
Group: System Includes {
|
|
|
|
File: bootinfo.inc (kernel/sys/bootinfo.inc)
|
|
File: coff.inc (kernel/sys/coff.inc)
|
|
File: cpu.inc (kernel/sys/cpu.inc)
|
|
File: mmu.inc (kernel/sys/mmu.inc)
|
|
File: registers.inc (kernel/sys/register.inc)
|
|
} # Group: System Includes
|
|
|
|
Group: Memory Manager {
|
|
|
|
File: mm.inc (kernel/mm/mm.inc)
|
|
File: pmm.inc (kernel/mm/pmm.inc)
|
|
} # Group: Memory Manager
|
|
|
|
File: lock.inc (kernel/lock.inc)
|
|
File: pic.inc (kernel/pic.inc)
|
|
File: vfs.inc (kernel/vfs.inc)
|
|
} # Group: Kernel
|
|
|
|
Group: Lib {
|
|
|
|
Group: LZP {
|
|
|
|
File: lzp.asm (lib/lzp/lzp.asm)
|
|
} # Group: LZP
|
|
|
|
Group: Crypto {
|
|
|
|
File: rc4.asm (no auto-title, lib/crypto/rc4/rc4.asm)
|
|
|
|
Group: chacha20 {
|
|
|
|
File: chacha20.asm (lib/crypto/chacha20/chacha20.asm)
|
|
} # Group: chacha20
|
|
|
|
Group: Dilithium {
|
|
|
|
File: ntt.asm (lib/crypto/dilithium/ntt.asm)
|
|
} # Group: Dilithium
|
|
|
|
Group: SHA2 {
|
|
|
|
File: sha256.asm (lib/crypto/sha2/sha256.asm)
|
|
} # Group: SHA2
|
|
|
|
} # Group: Crypto
|
|
|
|
File: ctype (no auto-title, lib/c/ctype.asm)
|
|
} # Group: Lib
|
|
|
|
File: Propaganda (docs/propaganda.txt)
|
|
File: Webring (docs/webring.txt)
|
|
|
|
Group: Index {
|
|
|
|
Index: Everything
|
|
Constant Index: Constants
|
|
File Index: Files
|
|
Function Index: Functions
|
|
Struct Index: Structs
|
|
Type Index: Types
|
|
} # Group: Index
|
|
|