Feat/v0.6.5 cthreads docs#9
Merged
Merged
Conversation
Programs that use this library on Unix-like systems must list cthreads as the
first unit in their uses clause, or creating the pool crashes at runtime with
an access violation (exit code 217) - a runtime failure, not a compile error.
This release documents the requirement everywhere a new user looks. No code or
API changes.
- README: prominent cthreads note at the top of Quick Start; add the
{$IFDEF UNIX}cthreads{$ENDIF} guard to every Quick Start and Installation
snippet; reminder in the compilation Tip.
- docs/ThreadPool.Simple-API.md, docs/ThreadPool.ProducerConsumer-API.md: add
a platform note at the top of each.
- docs/release-notes-v0.6.5.md: new release note.
- README "Planned/In Progress": drop adaptive thread adjustment (conflicts with
the fixed-count design); add richer error handling, planned for 0.7.0.
- Bump version to 0.6.5 (README badge, package .lpk).
ikelaiah
added
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Documents the
cthreadsrequirement for Linux/macOS so new users don't hit aruntime crash. On Unix-like systems, Free Pascal does not install a threading
manager by default — a program using this library must list
cthreadsas thefirst unit in its
usesclause, or creating the pool fails at runtime withan access violation (exit code 217). This is a runtime failure, not a compile
error, so the build succeeds and only crashes when run — exactly the kind of
gotcha that's painful to diagnose.
This is a documentation-only release (v0.6.5). No source code or public API
changes.
Changes:
cthreadsnote at the top of Quick Start (with a quotefrom the official FPC docs), the
{$IFDEF UNIX}cthreads{$ENDIF}guard addedto every Quick Start and Installation snippet, and a reminder in the
compilation Tip.
cthreadsdocumentationat the top of both
ThreadPool.Simple-API.mdandThreadPool.ProducerConsumer-API.md.(conflicts with the fixed-count, intentionally-simple design) and added
richer error handling, planned for 0.7.0.
docs/release-notes-v0.6.5.md..lpk),CHANGELOG.mdupdated.Related issue
N/A
Type of change
Checklist
lazbuild tests/TestRunner.lpithen runTestRunner) — no code changed; package builds clean and CI runs the full suiteCHANGELOG.mddocs/if behavior or API changed{$mode objfpc}{$H+}{$J-}and filenames match unit casing — N/A, no new units