endless-sky / endless-sky/docs

Add some text about locking and multithreading in the game

Open
#2 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
CSS
Stars
11
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Endless sky appears to use multi-threading and locking.

If developers inexperienced with the codebase (or inexperienced with threading) start making code-changes to structures shared between threads, then the risk of race-conditions and deadlocks could increase.

This request is to get some text in this documentation that describes which threads are used in the game and some text on which classes/areas/datastructures are expected to use locking (and when).

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.