Skip to content

Addtional docs #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Addtional docs #177

wants to merge 2 commits into from

Conversation

peter-lawrey
Copy link
Member

@peter-lawrey peter-lawrey commented May 23, 2025

This documentation-centric pull request adds a formal requirements specification for Java Thread Affinity, dramatically expands the README into a full user guide, and refreshes JavaDocs.
There are no functional or behavioural changes to the library—only whitespace in one helper class.

Area File(s) Summary of changes
New spec affinity/src/main/adoc/requirements.adoc • 300-line AsciiDoc Requirements Document covering scope, functional & NFRs, architecture, APIs, native code, build & test strategy.
User guide README.adoc (+ ≈120 / -4 LOC) • Added Supported operating systems section.
• Detailed install instructions for JNA on Windows.
• Explained -Daffinity.reserved masks with worked examples.
• How to set isolcpus via GRUB & systemd-boot.
• Descriptions of AffinityStrategies, dumpLocks() output, lock-file directory, and AffinityThreadFactory.
JavaDocs ITicker.java • Re-written header explaining tick semantics and helper methods.
Cosmetics LinuxHelper.java • Re-indentation (tabs → spaces) of sched_setaffinity; no logic change.

Motivation

  • Provide newcomers with a single, authoritative requirements spec.
  • Make platform capabilities and configuration steps clear in the README.
  • Improve code readability via richer JavaDocs.

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