ShuriZma
/
mgba
mirror of https://github.com/mgba-emu/mgba.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

All: Fix porting guidelines a bit

This commit is contained in:
Jeffrey Pfau 2015-06-18 19:58:06 -07:00
parent 5e26f74f17
commit 7266988651
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
PORTING.md
View File

@ -5,7 +5,7 @@ Porting is preferentially done upstream so as to avoid fragmenting the codebase
Folders for each port should be under the `src/platform` folder, and make minimally invasive changes to the rest of the tree. If any changes are needed, try to make sure they are generic and have the ability to be ironed out in the future. For example, if a function doesn't work on a specific platform, maybe a way to make that function more portable should be added.
The general porting process involves branching either `master` or `port/crucible`, making the needed changes, and, when the port is mature enough to not have major effects to other ports, merged into `port/crucible`. The crucible is used for mixing upcoming ports to make sure they aren't fragile when master merges into it every so often. At this time, the crucible hasn't yet been merged into `master`, but in the future this may occur regularly. Until then, if a port is to get merged into master, make sure the changes to each port occur on the port-specific branch before being merged into `port/crucible`.
The general porting process involves branching `master`, making the needed changes, and, when the port is mature enough to not have major effects to other ports, merged into `port/crucible`. The crucible is used for mixing upcoming ports to make sure they aren't fragile when `master` merges into it every so often. At this time, the crucible hasn't yet been merged into `master`, but in the future this may occur regularly. Until then, if a port is to get merged into master, make sure the changes to each port occur on the port-specific branch before being merged into `port/crucible`.
Port-specific TODO
------------------
@ -15,6 +15,7 @@ The ports are vaguely usable, but by no means should be considered stable.
### 3DS
* Add menu
* Add audio
* Thread support testing
* Make it faster
* ARMv6 dynarec
* Hardware acceleration
@ -22,6 +23,7 @@ The ports are vaguely usable, but by no means should be considered stable.
### PSP
* Add menu
* Add audio
* Thread support
* Make it faster
* MIPS dynarec
* Hardware acceleration
@ -29,4 +31,5 @@ The ports are vaguely usable, but by no means should be considered stable.
### Wii
* Add menu
* Add audio
* Thread support
* Clean up video detection