Update documentation
All checks were successful
Continuous Integration / Check (push) Successful in 1m19s
Continuous Integration / Clippy (push) Successful in 1m14s

This commit is contained in:
August 2025-11-07 00:23:59 -05:00
parent 7002d2feab
commit 20df4eb072
Signed by: shibedrill
GPG Key ID: 5FE0CB25945EFAA2
4 changed files with 66 additions and 2 deletions

54
docs/CONTRIBUTING.md Normal file
View File

@ -0,0 +1,54 @@
# Contribution Policy
Contributions to the Gila project are subject to the following terms:
## Issue Policy
Do not file issues for:
- Features marked as "Not Planned".
- Anything with a filed issue already open.
- AI generated/discovered issues, improvements, bugs, or security problems.
- Any kind of non-critical device driver or protocol stack.
- Support for specific devices/boards/SoCs, unless it is a feature-flagged fix
for a CPU hardware bug for an architecture that is already supported.
- Changing documentation or graphics.
Do please file issues for:
- Feature regressions.
- Legitimate security issues or concerns.
- Improvements or optimizations to isolation or speed.
- Questions about intended behavior.
- Features or tweaks that align with Gila's [design](DESIGN.md) and
[security](SECURITY.md) philosophies.
Security issues can be filed as regular issues for the time being.
## Behavior Policy
Pull requests, merge requests, and issues should not contain any content that
is crass, rude, disrespectful, irrelevant to the project, or otherwise could be
reasonably seen as offensive by other developers.
## Code Quality Policy
Pull requests should:
- Build properly without modifications once rebased.
- Provide a completed feature, or a completed bug fix.
- Only provide features listed as in-progress or planned on the issue tracker.
- Contain clear and concise commit messages.
- Describe clearly what they add or fix.
- Conform to Gila's [design](DESIGN.md) and [security](SECURITY.md)
philosophies and guidelines.
- Contain **no AI generated code**. The only exception here is if the
contributor clearly fully understands the nature of the changes they are
requesting to be pulled.
- Not remove, disable, break, or otherwise interfere with any existing code not
related to the feature/fix provided, without a very good reason.
- Not be purely cosmetic (updating README files or Cargo formatting).
## Development Resources
Developer resources can be found in [DEVELOPMENT.md](DEVELOPMENT.md).

View File

@ -162,3 +162,7 @@ your programs for the same architecture as Gila itself, bare metal. Userspace
programs must not use any privileged instructions that would cause an
exception if running in Ring 3 or any other least-privileged mode of a
processor.
## Contributing
Contribution policies are outlined in [CONTRIBUTING.md](CONTRIBUTING.md).

View File

@ -1,5 +1,11 @@
# Security
## Reporting
Since Gila is new and not used in any critical settings, vulnerabilities may
be filed as regular issues for the time being. Please ensure to specify that
the issue is a security issue when submitting.
## Foreward
Part of what inspires my design philosophy for Gila is the idea of creating a

View File

@ -25,8 +25,8 @@ pub fn switch_ptable() {
.allocate(PageLayout::from_size_align(PAGE_SIZE, PAGE_SIZE).unwrap())
.expect("Could not allocate pages for new page table!");
log_info!("Got region for new PML4: 0x{:x}", allocated_region.start());
let pml4_start_vaddr = allocated_region.start() + HHDM_RESPONSE.offset() as usize;
let pml4_ptr = pml4_start_vaddr as *mut PageTable;
//let pml4_start_vaddr = allocated_region.start() + HHDM_RESPONSE.offset() as usize;
//let pml4_ptr = pml4_start_vaddr as *mut PageTable;
/*
Dropping this PML4 causes a deadlock. Here is why: