Skip to content

Add a basic README + geteuid_grate example for documentation#3

Merged
rennergade merged 5 commits intoLind-Project:mainfrom
stupendoussuperpowers:update-readme.md
Dec 31, 2025
Merged

Add a basic README + geteuid_grate example for documentation#3
rennergade merged 5 commits intoLind-Project:mainfrom
stupendoussuperpowers:update-readme.md

Conversation

@stupendoussuperpowers
Copy link
Copy Markdown
Contributor

@stupendoussuperpowers stupendoussuperpowers commented Sep 20, 2025

Add a top-level readme for the example grates repo. Closes #1

The README consists of:

  • Description of the top level structure of the repo, including the structure of individual examples.
  • Guide to writing a custom grate
  • Guide to compiling and running these grates

Along with the README, it also adds the geteuid_grate example so that this can be referenced when reading the guide to writing a grate.

* Refactor grate execution flow and add tests

* cargo fmt

* Remove obsolete folder

* Update src/threei/src/threei.rs

Co-authored-by: Justin Cappos <justincappos@gmail.com>

* Refactor execution path

* Revise comments

* fmt

* Implement thread-safety

* Revise naming

* Rename register_handler arg

* Rename

* Update comments

* fmt

---------

Co-authored-by: Justin Cappos <justincappos@gmail.com>
* refactor glibc 3i/legacy syscall path

* fmt

* Remove unused files

* Fix typo

* Refine naming

* Revise naming

* Remove used code
@stupendoussuperpowers stupendoussuperpowers changed the title Add a basic README Add a basic README + geteuid_grate example for documentation Dec 28, 2025
Comment thread examples/geteuid-grate/src/geteuid_grate.c
Comment thread examples/geteuid-grate/build.conf
Comment thread README.md
Comment thread examples/geteuid-grate/src/geteuid_grate.c
Copy link
Copy Markdown
Contributor

@rennergade rennergade left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, lefft a few minor comments

Copy link
Copy Markdown
Contributor

@rennergade rennergade left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Think this looks great now. Going to merge and can update as we go from there.

@rennergade rennergade merged commit 6bb38ae into Lind-Project:main Dec 31, 2025
@stupendoussuperpowers stupendoussuperpowers deleted the update-readme.md branch March 1, 2026 02:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create README

3 participants