pikers
/
piker
4
1
Fork 0
Code Issues 10 Pull Requests 14 Packages Projects Releases Wiki Activity
piker/docs/macos
History
wygud 3424c01798 macos: Fix shared memory compatibility and add documentation 
Implement workaround for macOS POSIX shm 31-character name limit by
hashing long keys. Add comprehensive documentation for macOS-specific
compatibility fixes.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
 		2025-10-05 13:42:45 -04:00
..
README.md macos: Fix shared memory compatibility and add documentation 2025-10-05 13:42:45 -04:00
compatibility-fixes.md macos: Fix shared memory compatibility and add documentation 2025-10-05 13:42:45 -04:00

README.md

macOS Documentation

This directory contains macOS-specific documentation for the piker project.

Contents

Quick Start

If you’re experiencing issues running piker on macOS, check the compatibility fixes guide:

cat docs/macos/compatibility-fixes.md

Key Issues Addressed

  1. Socket Credential Passing - macOS uses different socket options than Linux
  2. Shared Memory Name Limits - macOS limits shm names to 31 characters
  3. Cleanup Race Conditions - Handling concurrent shared memory cleanup
  4. Async Runtime Coordination - Proper trio/asyncio shutdown on macOS

Platform Information

  • Tested on: macOS 15.0+ (Darwin 25.0.0)
  • Python: 3.13+
  • Architecture: ARM64 (Apple Silicon) and x86_64 (Intel)

Related Projects

These fixes may also apply to: - tractor - The actor runtime used by piker - Other projects using tractor on macOS

Contributing

Found additional macOS issues? Please: 1. Document the error and its cause 2. Provide a solution with code examples 3. Test on multiple macOS versions 4. Submit a PR updating this documentation