From aece1fa5cdb3b504791812aba00cc7e8ca00eb02 Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Thu, 1 Jan 2026 13:42:25 +0100 Subject: chore: rename docs folders to doc. Signed-off-by: Amlal El Mahrouss --- src/libDDK/doc/SPECIFICATION_DDK.md | 18 ++++++++++++++++++ src/libDDK/docs/SPECIFICATION_DDK.md | 18 ------------------ src/libSystem/doc/SPECIFICATION_LIBSYSTEM.md | 1 + src/libSystem/doc/SPECIFICATION_SYSCALLS.md | 25 +++++++++++++++++++++++++ src/libSystem/docs/SPECIFICATION_SYSCALLS.md | 25 ------------------------- 5 files changed, 44 insertions(+), 43 deletions(-) create mode 100644 src/libDDK/doc/SPECIFICATION_DDK.md delete mode 100644 src/libDDK/docs/SPECIFICATION_DDK.md create mode 120000 src/libSystem/doc/SPECIFICATION_LIBSYSTEM.md create mode 100644 src/libSystem/doc/SPECIFICATION_SYSCALLS.md delete mode 100644 src/libSystem/docs/SPECIFICATION_SYSCALLS.md diff --git a/src/libDDK/doc/SPECIFICATION_DDK.md b/src/libDDK/doc/SPECIFICATION_DDK.md new file mode 100644 index 00000000..d59b6e77 --- /dev/null +++ b/src/libDDK/doc/SPECIFICATION_DDK.md @@ -0,0 +1,18 @@ +=================================== + +# 0: General Information + +=================================== + +- Programming Language: C/C++ +- Build System: Make/NeBuild +- Purpose: Driver Tool Kit, which you link against libDDK.dll + +=================================== + +# 1: How It works + +=================================== + +- Driver shall directly call the kernel at specific ports. (Or a kernel call) +- Kernel must respond according to kernel call, otherwise a panic will occur. \ No newline at end of file diff --git a/src/libDDK/docs/SPECIFICATION_DDK.md b/src/libDDK/docs/SPECIFICATION_DDK.md deleted file mode 100644 index d59b6e77..00000000 --- a/src/libDDK/docs/SPECIFICATION_DDK.md +++ /dev/null @@ -1,18 +0,0 @@ -=================================== - -# 0: General Information - -=================================== - -- Programming Language: C/C++ -- Build System: Make/NeBuild -- Purpose: Driver Tool Kit, which you link against libDDK.dll - -=================================== - -# 1: How It works - -=================================== - -- Driver shall directly call the kernel at specific ports. (Or a kernel call) -- Kernel must respond according to kernel call, otherwise a panic will occur. \ No newline at end of file diff --git a/src/libSystem/doc/SPECIFICATION_LIBSYSTEM.md b/src/libSystem/doc/SPECIFICATION_LIBSYSTEM.md new file mode 120000 index 00000000..6ad2bf3a --- /dev/null +++ b/src/libSystem/doc/SPECIFICATION_LIBSYSTEM.md @@ -0,0 +1 @@ +SPECIFICATION_SYSCALLS.md \ No newline at end of file diff --git a/src/libSystem/doc/SPECIFICATION_SYSCALLS.md b/src/libSystem/doc/SPECIFICATION_SYSCALLS.md new file mode 100644 index 00000000..89f61498 --- /dev/null +++ b/src/libSystem/doc/SPECIFICATION_SYSCALLS.md @@ -0,0 +1,25 @@ +=================================== +# 0: General Information +=================================== + +- **Programming Language**: C / C++ +- **Build System**: Make / NeBuild +- **Purpose**: System Call Interface (SCI) for NeKernel + +=================================== +# 1: How It Works +=================================== + +- This header provides the raw API surface for accessing NeKernel's system calls. + +- It is **not** directly used by applications. + - Instead, it is abstracted by the **SystemSDK**, which presents a stable, high-level interface. + +- At runtime: + - System calls are routed from user-space code to the **kernel syscall manager**. + - The syscall manager executes the requested operation and returns control to `libSystem`. + - Finally, the result is delivered back to the originating process. + +- This separation ensures that: + - The SCI remains low-level and close to the ABI. + - `SystemSDK` provides portability and shielding from changes in syscall internals. \ No newline at end of file diff --git a/src/libSystem/docs/SPECIFICATION_SYSCALLS.md b/src/libSystem/docs/SPECIFICATION_SYSCALLS.md deleted file mode 100644 index 89f61498..00000000 --- a/src/libSystem/docs/SPECIFICATION_SYSCALLS.md +++ /dev/null @@ -1,25 +0,0 @@ -=================================== -# 0: General Information -=================================== - -- **Programming Language**: C / C++ -- **Build System**: Make / NeBuild -- **Purpose**: System Call Interface (SCI) for NeKernel - -=================================== -# 1: How It Works -=================================== - -- This header provides the raw API surface for accessing NeKernel's system calls. - -- It is **not** directly used by applications. - - Instead, it is abstracted by the **SystemSDK**, which presents a stable, high-level interface. - -- At runtime: - - System calls are routed from user-space code to the **kernel syscall manager**. - - The syscall manager executes the requested operation and returns control to `libSystem`. - - Finally, the result is delivered back to the originating process. - -- This separation ensures that: - - The SCI remains low-level and close to the ABI. - - `SystemSDK` provides portability and shielding from changes in syscall internals. \ No newline at end of file -- cgit v1.2.3