From 1e393b765fe53b33212cfc2306d8c6ffead1eee2 Mon Sep 17 00:00:00 2001 From: antifallobst Date: Sun, 28 May 2023 20:01:03 +0200 Subject: [PATCH] added README.md and moved kernel docs into a seperate directory --- README.md | 3 +++ kernel/README.md | 11 ++++++++--- build-instructions.md => kernel/build-instructions.md | 0 roadmap.md => kernel/roadmap.md | 0 kernel/src/README.md | 4 ++++ kernel/{ => src}/boot/README.md | 0 kernel/{ => src}/boot/boot_info.h.md | 0 kernel/{ => src}/boot/limine.h.md | 0 kernel/{ => src}/drivers/README.md | 0 kernel/{ => src}/drivers/acpi/README.md | 0 kernel/{ => src}/drivers/acpi/acpi.h.md | 0 kernel/{ => src}/drivers/acpi/rsdp.h.md | 0 kernel/{ => src}/drivers/elf/README.md | 0 kernel/{ => src}/drivers/elf/elf.h.md | 0 kernel/{ => src}/drivers/elf/header.h.md | 0 kernel/{ => src}/drivers/elf/mapping.h.md | 0 kernel/{ => src}/drivers/elf/section.h.md | 0 kernel/{ => src}/drivers/elf/segment.h.md | 0 kernel/{ => src}/drivers/elf/symbol.h.md | 0 kernel/{ => src}/drivers/fs/README.md | 0 kernel/{ => src}/drivers/fs/ramfs.h.md | 0 kernel/{ => src}/drivers/fs/ustar.h.md | 0 kernel/{ => src}/drivers/fs/vfs.h.md | 0 kernel/{ => src}/drivers/graphics/README.md | 0 kernel/{ => src}/drivers/graphics/color.h.md | 0 kernel/{ => src}/drivers/graphics/font.h.md | 0 kernel/{ => src}/drivers/graphics/framebuffer.h.md | 0 kernel/{ => src}/drivers/graphics/renderer.h.md | 0 kernel/{ => src}/drivers/pci.h.md | 0 kernel/{ => src}/drivers/ps2/README.md | 0 kernel/{ => src}/drivers/ps2/controller.h.md | 0 kernel/{ => src}/drivers/ps2/keyboard.h.md | 0 kernel/{ => src}/drivers/ps2/scancodes.h.md | 0 kernel/{ => src}/drivers/time/README.md | 0 kernel/{ => src}/drivers/time/pit.h.md | 0 kernel/{ => src}/drivers/tty.h.md | 0 kernel/{ => src}/mm/README.md | 0 kernel/{ => src}/mm/heap.h.md | 0 kernel/{ => src}/mm/memory_map.h.md | 0 kernel/{ => src}/mm/page_frame.h.md | 0 kernel/{ => src}/mm/page_map.h.md | 0 kernel/{ => src}/mm/region.h.md | 0 kernel/{ => src}/mm/stack.h.md | 0 kernel/{ => src}/platform/README.md | 0 kernel/{ => src}/platform/cpu.h.md | 0 kernel/{ => src}/platform/exceptions.h.md | 0 kernel/{ => src}/platform/gdt.h.md | 0 kernel/{ => src}/platform/interrupts.h.md | 0 kernel/{ => src}/proc/README.md | 0 kernel/{ => src}/proc/file_descriptor.h.md | 0 kernel/{ => src}/proc/pipe.h.md | 0 kernel/{ => src}/proc/process.h.md | 0 kernel/{ => src}/proc/scheduler.h.md | 0 kernel/{ => src}/proc/thread.h.md | 0 kernel/{ => src}/utils/README.md | 0 kernel/{ => src}/utils/bitmap.h.md | 0 kernel/{ => src}/utils/core.h.md | 0 kernel/{ => src}/utils/io.h.md | 0 kernel/{ => src}/utils/logger.h.md | 0 kernel/{ => src}/utils/math.h.md | 0 kernel/{ => src}/utils/memory.h.md | 0 kernel/{ => src}/utils/panic.h.md | 0 kernel/{ => src}/utils/stdtypes.h.md | 0 kernel/{ => src}/utils/stream.h.md | 0 kernel/{ => src}/utils/string.h.md | 0 kernel/{ => src}/utils/symbol.h.md | 0 sysabi.md => kernel/sysabi.md | 0 67 files changed, 15 insertions(+), 3 deletions(-) rename build-instructions.md => kernel/build-instructions.md (100%) rename roadmap.md => kernel/roadmap.md (100%) create mode 100644 kernel/src/README.md rename kernel/{ => src}/boot/README.md (100%) rename kernel/{ => src}/boot/boot_info.h.md (100%) rename kernel/{ => src}/boot/limine.h.md (100%) rename kernel/{ => src}/drivers/README.md (100%) rename kernel/{ => src}/drivers/acpi/README.md (100%) rename kernel/{ => src}/drivers/acpi/acpi.h.md (100%) rename kernel/{ => src}/drivers/acpi/rsdp.h.md (100%) rename kernel/{ => src}/drivers/elf/README.md (100%) rename kernel/{ => src}/drivers/elf/elf.h.md (100%) rename kernel/{ => src}/drivers/elf/header.h.md (100%) rename kernel/{ => src}/drivers/elf/mapping.h.md (100%) rename kernel/{ => src}/drivers/elf/section.h.md (100%) rename kernel/{ => src}/drivers/elf/segment.h.md (100%) rename kernel/{ => src}/drivers/elf/symbol.h.md (100%) rename kernel/{ => src}/drivers/fs/README.md (100%) rename kernel/{ => src}/drivers/fs/ramfs.h.md (100%) rename kernel/{ => src}/drivers/fs/ustar.h.md (100%) rename kernel/{ => src}/drivers/fs/vfs.h.md (100%) rename kernel/{ => src}/drivers/graphics/README.md (100%) rename kernel/{ => src}/drivers/graphics/color.h.md (100%) rename kernel/{ => src}/drivers/graphics/font.h.md (100%) rename kernel/{ => src}/drivers/graphics/framebuffer.h.md (100%) rename kernel/{ => src}/drivers/graphics/renderer.h.md (100%) rename kernel/{ => src}/drivers/pci.h.md (100%) rename kernel/{ => src}/drivers/ps2/README.md (100%) rename kernel/{ => src}/drivers/ps2/controller.h.md (100%) rename kernel/{ => src}/drivers/ps2/keyboard.h.md (100%) rename kernel/{ => src}/drivers/ps2/scancodes.h.md (100%) rename kernel/{ => src}/drivers/time/README.md (100%) rename kernel/{ => src}/drivers/time/pit.h.md (100%) rename kernel/{ => src}/drivers/tty.h.md (100%) rename kernel/{ => src}/mm/README.md (100%) rename kernel/{ => src}/mm/heap.h.md (100%) rename kernel/{ => src}/mm/memory_map.h.md (100%) rename kernel/{ => src}/mm/page_frame.h.md (100%) rename kernel/{ => src}/mm/page_map.h.md (100%) rename kernel/{ => src}/mm/region.h.md (100%) rename kernel/{ => src}/mm/stack.h.md (100%) rename kernel/{ => src}/platform/README.md (100%) rename kernel/{ => src}/platform/cpu.h.md (100%) rename kernel/{ => src}/platform/exceptions.h.md (100%) rename kernel/{ => src}/platform/gdt.h.md (100%) rename kernel/{ => src}/platform/interrupts.h.md (100%) rename kernel/{ => src}/proc/README.md (100%) rename kernel/{ => src}/proc/file_descriptor.h.md (100%) rename kernel/{ => src}/proc/pipe.h.md (100%) rename kernel/{ => src}/proc/process.h.md (100%) rename kernel/{ => src}/proc/scheduler.h.md (100%) rename kernel/{ => src}/proc/thread.h.md (100%) rename kernel/{ => src}/utils/README.md (100%) rename kernel/{ => src}/utils/bitmap.h.md (100%) rename kernel/{ => src}/utils/core.h.md (100%) rename kernel/{ => src}/utils/io.h.md (100%) rename kernel/{ => src}/utils/logger.h.md (100%) rename kernel/{ => src}/utils/math.h.md (100%) rename kernel/{ => src}/utils/memory.h.md (100%) rename kernel/{ => src}/utils/panic.h.md (100%) rename kernel/{ => src}/utils/stdtypes.h.md (100%) rename kernel/{ => src}/utils/stream.h.md (100%) rename kernel/{ => src}/utils/string.h.md (100%) rename kernel/{ => src}/utils/symbol.h.md (100%) rename sysabi.md => kernel/sysabi.md (100%) diff --git a/README.md b/README.md index 7038489..8de36ba 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,5 @@ # documentation +The kernel documentation (source, sysabi, etc.) can be found in the `kernel` directory. + +Read `commit-format.md` and `codestyle.md` before contributing to anything! \ No newline at end of file diff --git a/kernel/README.md b/kernel/README.md index 92a257d..a6e32b7 100644 --- a/kernel/README.md +++ b/kernel/README.md @@ -1,4 +1,9 @@ -# Codebase +# kernel + +The documentation of the noxos kernel. + +- The source code is documented in the `src` directory. +- Build instructions can be found in `build-instructions.md`. +- A roadmap of what has to be done can be found in `roadmap.md`. +- The kernels' sysabi (syscalls, etc.) can be found in `sysabi.md`. -Every header in the codebase has its own page. -The structure is identically to the codebase directory structure. diff --git a/build-instructions.md b/kernel/build-instructions.md similarity index 100% rename from build-instructions.md rename to kernel/build-instructions.md diff --git a/roadmap.md b/kernel/roadmap.md similarity index 100% rename from roadmap.md rename to kernel/roadmap.md diff --git a/kernel/src/README.md b/kernel/src/README.md new file mode 100644 index 0000000..222c94f --- /dev/null +++ b/kernel/src/README.md @@ -0,0 +1,4 @@ +# kernel source + +Every header in the codebase has its own page. +The structure is identically to the codebase directory structure. diff --git a/kernel/boot/README.md b/kernel/src/boot/README.md similarity index 100% rename from kernel/boot/README.md rename to kernel/src/boot/README.md diff --git a/kernel/boot/boot_info.h.md b/kernel/src/boot/boot_info.h.md similarity index 100% rename from kernel/boot/boot_info.h.md rename to kernel/src/boot/boot_info.h.md diff --git a/kernel/boot/limine.h.md b/kernel/src/boot/limine.h.md similarity index 100% rename from kernel/boot/limine.h.md rename to kernel/src/boot/limine.h.md diff --git a/kernel/drivers/README.md b/kernel/src/drivers/README.md similarity index 100% rename from kernel/drivers/README.md rename to kernel/src/drivers/README.md diff --git a/kernel/drivers/acpi/README.md b/kernel/src/drivers/acpi/README.md similarity index 100% rename from kernel/drivers/acpi/README.md rename to kernel/src/drivers/acpi/README.md diff --git a/kernel/drivers/acpi/acpi.h.md b/kernel/src/drivers/acpi/acpi.h.md similarity index 100% rename from kernel/drivers/acpi/acpi.h.md rename to kernel/src/drivers/acpi/acpi.h.md diff --git a/kernel/drivers/acpi/rsdp.h.md b/kernel/src/drivers/acpi/rsdp.h.md similarity index 100% rename from kernel/drivers/acpi/rsdp.h.md rename to kernel/src/drivers/acpi/rsdp.h.md diff --git a/kernel/drivers/elf/README.md b/kernel/src/drivers/elf/README.md similarity index 100% rename from kernel/drivers/elf/README.md rename to kernel/src/drivers/elf/README.md diff --git a/kernel/drivers/elf/elf.h.md b/kernel/src/drivers/elf/elf.h.md similarity index 100% rename from kernel/drivers/elf/elf.h.md rename to kernel/src/drivers/elf/elf.h.md diff --git a/kernel/drivers/elf/header.h.md b/kernel/src/drivers/elf/header.h.md similarity index 100% rename from kernel/drivers/elf/header.h.md rename to kernel/src/drivers/elf/header.h.md diff --git a/kernel/drivers/elf/mapping.h.md b/kernel/src/drivers/elf/mapping.h.md similarity index 100% rename from kernel/drivers/elf/mapping.h.md rename to kernel/src/drivers/elf/mapping.h.md diff --git a/kernel/drivers/elf/section.h.md b/kernel/src/drivers/elf/section.h.md similarity index 100% rename from kernel/drivers/elf/section.h.md rename to kernel/src/drivers/elf/section.h.md diff --git a/kernel/drivers/elf/segment.h.md b/kernel/src/drivers/elf/segment.h.md similarity index 100% rename from kernel/drivers/elf/segment.h.md rename to kernel/src/drivers/elf/segment.h.md diff --git a/kernel/drivers/elf/symbol.h.md b/kernel/src/drivers/elf/symbol.h.md similarity index 100% rename from kernel/drivers/elf/symbol.h.md rename to kernel/src/drivers/elf/symbol.h.md diff --git a/kernel/drivers/fs/README.md b/kernel/src/drivers/fs/README.md similarity index 100% rename from kernel/drivers/fs/README.md rename to kernel/src/drivers/fs/README.md diff --git a/kernel/drivers/fs/ramfs.h.md b/kernel/src/drivers/fs/ramfs.h.md similarity index 100% rename from kernel/drivers/fs/ramfs.h.md rename to kernel/src/drivers/fs/ramfs.h.md diff --git a/kernel/drivers/fs/ustar.h.md b/kernel/src/drivers/fs/ustar.h.md similarity index 100% rename from kernel/drivers/fs/ustar.h.md rename to kernel/src/drivers/fs/ustar.h.md diff --git a/kernel/drivers/fs/vfs.h.md b/kernel/src/drivers/fs/vfs.h.md similarity index 100% rename from kernel/drivers/fs/vfs.h.md rename to kernel/src/drivers/fs/vfs.h.md diff --git a/kernel/drivers/graphics/README.md b/kernel/src/drivers/graphics/README.md similarity index 100% rename from kernel/drivers/graphics/README.md rename to kernel/src/drivers/graphics/README.md diff --git a/kernel/drivers/graphics/color.h.md b/kernel/src/drivers/graphics/color.h.md similarity index 100% rename from kernel/drivers/graphics/color.h.md rename to kernel/src/drivers/graphics/color.h.md diff --git a/kernel/drivers/graphics/font.h.md b/kernel/src/drivers/graphics/font.h.md similarity index 100% rename from kernel/drivers/graphics/font.h.md rename to kernel/src/drivers/graphics/font.h.md diff --git a/kernel/drivers/graphics/framebuffer.h.md b/kernel/src/drivers/graphics/framebuffer.h.md similarity index 100% rename from kernel/drivers/graphics/framebuffer.h.md rename to kernel/src/drivers/graphics/framebuffer.h.md diff --git a/kernel/drivers/graphics/renderer.h.md b/kernel/src/drivers/graphics/renderer.h.md similarity index 100% rename from kernel/drivers/graphics/renderer.h.md rename to kernel/src/drivers/graphics/renderer.h.md diff --git a/kernel/drivers/pci.h.md b/kernel/src/drivers/pci.h.md similarity index 100% rename from kernel/drivers/pci.h.md rename to kernel/src/drivers/pci.h.md diff --git a/kernel/drivers/ps2/README.md b/kernel/src/drivers/ps2/README.md similarity index 100% rename from kernel/drivers/ps2/README.md rename to kernel/src/drivers/ps2/README.md diff --git a/kernel/drivers/ps2/controller.h.md b/kernel/src/drivers/ps2/controller.h.md similarity index 100% rename from kernel/drivers/ps2/controller.h.md rename to kernel/src/drivers/ps2/controller.h.md diff --git a/kernel/drivers/ps2/keyboard.h.md b/kernel/src/drivers/ps2/keyboard.h.md similarity index 100% rename from kernel/drivers/ps2/keyboard.h.md rename to kernel/src/drivers/ps2/keyboard.h.md diff --git a/kernel/drivers/ps2/scancodes.h.md b/kernel/src/drivers/ps2/scancodes.h.md similarity index 100% rename from kernel/drivers/ps2/scancodes.h.md rename to kernel/src/drivers/ps2/scancodes.h.md diff --git a/kernel/drivers/time/README.md b/kernel/src/drivers/time/README.md similarity index 100% rename from kernel/drivers/time/README.md rename to kernel/src/drivers/time/README.md diff --git a/kernel/drivers/time/pit.h.md b/kernel/src/drivers/time/pit.h.md similarity index 100% rename from kernel/drivers/time/pit.h.md rename to kernel/src/drivers/time/pit.h.md diff --git a/kernel/drivers/tty.h.md b/kernel/src/drivers/tty.h.md similarity index 100% rename from kernel/drivers/tty.h.md rename to kernel/src/drivers/tty.h.md diff --git a/kernel/mm/README.md b/kernel/src/mm/README.md similarity index 100% rename from kernel/mm/README.md rename to kernel/src/mm/README.md diff --git a/kernel/mm/heap.h.md b/kernel/src/mm/heap.h.md similarity index 100% rename from kernel/mm/heap.h.md rename to kernel/src/mm/heap.h.md diff --git a/kernel/mm/memory_map.h.md b/kernel/src/mm/memory_map.h.md similarity index 100% rename from kernel/mm/memory_map.h.md rename to kernel/src/mm/memory_map.h.md diff --git a/kernel/mm/page_frame.h.md b/kernel/src/mm/page_frame.h.md similarity index 100% rename from kernel/mm/page_frame.h.md rename to kernel/src/mm/page_frame.h.md diff --git a/kernel/mm/page_map.h.md b/kernel/src/mm/page_map.h.md similarity index 100% rename from kernel/mm/page_map.h.md rename to kernel/src/mm/page_map.h.md diff --git a/kernel/mm/region.h.md b/kernel/src/mm/region.h.md similarity index 100% rename from kernel/mm/region.h.md rename to kernel/src/mm/region.h.md diff --git a/kernel/mm/stack.h.md b/kernel/src/mm/stack.h.md similarity index 100% rename from kernel/mm/stack.h.md rename to kernel/src/mm/stack.h.md diff --git a/kernel/platform/README.md b/kernel/src/platform/README.md similarity index 100% rename from kernel/platform/README.md rename to kernel/src/platform/README.md diff --git a/kernel/platform/cpu.h.md b/kernel/src/platform/cpu.h.md similarity index 100% rename from kernel/platform/cpu.h.md rename to kernel/src/platform/cpu.h.md diff --git a/kernel/platform/exceptions.h.md b/kernel/src/platform/exceptions.h.md similarity index 100% rename from kernel/platform/exceptions.h.md rename to kernel/src/platform/exceptions.h.md diff --git a/kernel/platform/gdt.h.md b/kernel/src/platform/gdt.h.md similarity index 100% rename from kernel/platform/gdt.h.md rename to kernel/src/platform/gdt.h.md diff --git a/kernel/platform/interrupts.h.md b/kernel/src/platform/interrupts.h.md similarity index 100% rename from kernel/platform/interrupts.h.md rename to kernel/src/platform/interrupts.h.md diff --git a/kernel/proc/README.md b/kernel/src/proc/README.md similarity index 100% rename from kernel/proc/README.md rename to kernel/src/proc/README.md diff --git a/kernel/proc/file_descriptor.h.md b/kernel/src/proc/file_descriptor.h.md similarity index 100% rename from kernel/proc/file_descriptor.h.md rename to kernel/src/proc/file_descriptor.h.md diff --git a/kernel/proc/pipe.h.md b/kernel/src/proc/pipe.h.md similarity index 100% rename from kernel/proc/pipe.h.md rename to kernel/src/proc/pipe.h.md diff --git a/kernel/proc/process.h.md b/kernel/src/proc/process.h.md similarity index 100% rename from kernel/proc/process.h.md rename to kernel/src/proc/process.h.md diff --git a/kernel/proc/scheduler.h.md b/kernel/src/proc/scheduler.h.md similarity index 100% rename from kernel/proc/scheduler.h.md rename to kernel/src/proc/scheduler.h.md diff --git a/kernel/proc/thread.h.md b/kernel/src/proc/thread.h.md similarity index 100% rename from kernel/proc/thread.h.md rename to kernel/src/proc/thread.h.md diff --git a/kernel/utils/README.md b/kernel/src/utils/README.md similarity index 100% rename from kernel/utils/README.md rename to kernel/src/utils/README.md diff --git a/kernel/utils/bitmap.h.md b/kernel/src/utils/bitmap.h.md similarity index 100% rename from kernel/utils/bitmap.h.md rename to kernel/src/utils/bitmap.h.md diff --git a/kernel/utils/core.h.md b/kernel/src/utils/core.h.md similarity index 100% rename from kernel/utils/core.h.md rename to kernel/src/utils/core.h.md diff --git a/kernel/utils/io.h.md b/kernel/src/utils/io.h.md similarity index 100% rename from kernel/utils/io.h.md rename to kernel/src/utils/io.h.md diff --git a/kernel/utils/logger.h.md b/kernel/src/utils/logger.h.md similarity index 100% rename from kernel/utils/logger.h.md rename to kernel/src/utils/logger.h.md diff --git a/kernel/utils/math.h.md b/kernel/src/utils/math.h.md similarity index 100% rename from kernel/utils/math.h.md rename to kernel/src/utils/math.h.md diff --git a/kernel/utils/memory.h.md b/kernel/src/utils/memory.h.md similarity index 100% rename from kernel/utils/memory.h.md rename to kernel/src/utils/memory.h.md diff --git a/kernel/utils/panic.h.md b/kernel/src/utils/panic.h.md similarity index 100% rename from kernel/utils/panic.h.md rename to kernel/src/utils/panic.h.md diff --git a/kernel/utils/stdtypes.h.md b/kernel/src/utils/stdtypes.h.md similarity index 100% rename from kernel/utils/stdtypes.h.md rename to kernel/src/utils/stdtypes.h.md diff --git a/kernel/utils/stream.h.md b/kernel/src/utils/stream.h.md similarity index 100% rename from kernel/utils/stream.h.md rename to kernel/src/utils/stream.h.md diff --git a/kernel/utils/string.h.md b/kernel/src/utils/string.h.md similarity index 100% rename from kernel/utils/string.h.md rename to kernel/src/utils/string.h.md diff --git a/kernel/utils/symbol.h.md b/kernel/src/utils/symbol.h.md similarity index 100% rename from kernel/utils/symbol.h.md rename to kernel/src/utils/symbol.h.md diff --git a/sysabi.md b/kernel/sysabi.md similarity index 100% rename from sysabi.md rename to kernel/sysabi.md