Skip to content

kuser_shared_data all fields documented#25

Merged
m417z merged 9 commits intom417z:mainfrom
gremlinbeet:kuser
Sep 29, 2025
Merged

kuser_shared_data all fields documented#25
m417z merged 9 commits intom417z:mainfrom
gremlinbeet:kuser

Conversation

@gremlinbeet
Copy link
Copy Markdown
Contributor

Documented all fields in KUSER_SHARED_DATA (properly, not the horrible Microsoft slop).

It's actually WIP, as there are some very important sections I want to add very soon (including sync mechanism, kuser in VTL, and links, such as good historical stuff on the subject by Geoff Chappell). But it's better to have bulk of the struct documentation available on NtDoc now.

Copy link
Copy Markdown
Owner

@m417z m417z left a comment

Choose a reason for hiding this comment

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

Thank you for the contribution, looks great! Please address the comments, and fix the typos which aren't false positives.

@m417z m417z merged commit 6af6ed4 into m417z:main Sep 29, 2025
@gremlinbeet
Copy link
Copy Markdown
Contributor Author

Omg, documentation is hard. You found more flaws than I expected there is 😽.

@m417z
Copy link
Copy Markdown
Owner

m417z commented Sep 29, 2025

Yep, but it was fairly minor stuff. It's live now 🎉

A note for future updates: To make it look better on the website, it'd be better to wrap the text (at least the multiline comments) to 106 characters or less.

@m417z
Copy link
Copy Markdown
Owner

m417z commented Sep 29, 2025

Perhaps it'd even be better to have it all as markdown text. Then it'd be more convenient to read, responsive to different resolutions, and with formatting. And after all, we have the phnt struct definition on the page with terse documentation already. WDYT?

@gremlinbeet
Copy link
Copy Markdown
Contributor Author

gremlinbeet commented Sep 29, 2025

Excellent! A little bit confusing though that there's a structure with wrong/outdated comments on the page; and then one gotta scroll to the middle of the page to basically the very same structure. That would probably work fine with 99% of structs coz they are usually not that large.

Line length of 106 for code blocks is a bit oppressive (imo). Perhaps if monitor horizontal resolution is higher than 800, it would be fine to increase the width of code blocks to accomodate a line length of 120?
(Line length of 120 is obviously the best! Just like the footwear size 38 is obviously the best, while 36 is quite oppressive and not recommended).

Regarding markdown... It's a bit complicated. To smuggerly avoid writing a wall of text (esp.since I partially agree), let's say it is easier to copypaste up-to-date, commented structure definition from my internal headers than to maintain additional version in markdown.
➡️ Ah, wait, I know! I can just commit commented struct to phnt, and after that we'll be able to remove the duplication from NtDoc (as you display the phnt info right away); yet for NtDoc I'll add additional sections in markdown about fields sync, VTL1 skuser, and a few other important kuser things. Perhaps I'll have time for that in a few weeks.

@m417z
Copy link
Copy Markdown
Owner

m417z commented Sep 29, 2025

A little bit confusing though that there's a structure with wrong/outdated comments on the page

The struct that's displayed by default is from phnt. If they have wrong comments, I'm sure they'll be glad to have them fixed.

I can just commit commented struct to phnt, and after that we'll be able to remove the duplication from NtDoc (as you display the phnt info right away); yet for NtDoc I'll add additional sections in markdown about fields sync, VTL1 skuser, and a few other important kuser things.

Sounds great!

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.

2 participants