git.y1.nz

commit 648317bc4a626b56d2a9504fced7ec5d671cbbd5
parent e66ea4d1a6df13b84b55d025bd81943d30b4ea69
Author: bbbbbr <bbbbbr@users.noreply.github.com>
Date:   Tue, 18 Jan 2022 23:40:11 -0800

Merge pull request #303 from bbbbbr/docs_4_0_6

Docs: Some updates for next release - 4.0.6
Diffstat:
M
docs/pages/09_migrating_new_versions.md
3
+++
M
docs/pages/10_release_notes.md
41
+++++++++++++++++++++++++++++++++++++++++
M
docs/pages/20_toolchain_settings.md
10
++++++----

3 files changed, 50 insertions(+), 4 deletions(-)
diff --git a/docs/pages/09_migrating_new_versions.md b/docs/pages/09_migrating_new_versions.md
@@ -4,6 +4,9 @@ This section contains information that may be useful to know or important when u
 
 # GBDK 2020 versions
 
+## Porting to GBDK 2020 4.0.6
+  - No significant changes required
+
 ## Porting to GBDK 2020 4.0.5
   - GBDK now requires SDCC 12259 or higher with GBDK-2020 patches
   - @ref utility_png2asset "png2asset" is the new name for the `png2mtspr` utility
diff --git a/docs/pages/10_release_notes.md b/docs/pages/10_release_notes.md
@@ -5,6 +5,47 @@ https://github.com/gbdk-2020/gbdk-2020/releases
 
 
 # GBDK 2020 Release Notes
+## GBDK 2020 4.0.6
+  2022/xx
+  - Building GBDK
+    - Changed to target older version of macOS (10.10) when building for better compatibility
+  - Platforms
+    - Added support for Mega Duck / Cougar Boy (`duck`). See @ref docs_supported_consoles
+  - Library
+    - Added @ref memcmp()
+    - Added @ref add_low_priority_TIM() function for timer interrupts which allow nesting for GB/CGB
+    - Added @ref set_bkg_based_tiles(), @ref set_bkg_based_submap(), @ref set_win_based_tiles(), @ref set_win_based_submap() for when a map's tiles don't start at VRAM index zero
+    - Added @ref clock() for SMS/GG
+    - Added macro definitions for SDCC features:
+      - `#define SFR     __sfr`
+      - `#define AT(A)   __at(A)`
+    - Added check for OAM overflow to metasprite calls for GB/CGB
+    - Added constant definitions @ref PSG_LATCH, @ref PSG_CH0, @ref PSG_CH1, @ref PSG_CH2, @ref PSG_CH3, @ref PSG_VOLUME for SMS/GG
+    - Changed headers to wrap SDCC specific features (such as `NONBANKED`) with `#ifdef __SDCC`
+    - Changed @ref rand() and @ref arand() to return `uint8_t` instead of `int8_t` (closer to the standard)
+    - Fixed declaration for @ref PCM_SAMPLE and definition for @ref AUD3WAVE
+    - Fixed definition of `size_t` to be `unsigned int` instead of  `int`
+    - Fixed @ref vmemcpy() and @ref memmove() for SMS/GG
+    - Fixed random number generation for SMS/GG
+    - Fixed letter `U` appearing as `K` for min font
+    - Fixed define name in crash_handler.h
+  - Toolchain / Utilities
+    - @ref utility_png2asset "png2asset"
+      - Added SMS/GG graphics format support
+      - Added 4bpp and SGB borders
+      - Added warning when image size is not an even multiple of tile size
+      - Added `-tile_origin` offset option for when map tiles do not start at tile 0 in VRAM
+      - Added `*_TILE_COUNT` definition to output
+      - Fixed CGB `...s_map_attributes` type definition in output
+      - Fixed values for `num_palettes` in output
+      - Fixed incorrect `TILE_COUNT` value when not `-using_structs`
+    - @ref lcc
+      - Changed @ref makebin flags to turn off Nintendo logo copy for GB/CGB (use version in crt instead)
+  - Examples
+    - Added logo example (cross-platform)
+    - Added @ref ISR_VECTOR example of a raw ISR vector with no dispatcher for GB/CGB
+    - Changed sgb_border example to use png2asset for graphics
+    - Changed use of set_interrupts() in examples so it's outside critical sections (since it disables/enables interrupts)
 
 ## GBDK 2020 4.0.5
   2021/09
diff --git a/docs/pages/20_toolchain_settings.md b/docs/pages/20_toolchain_settings.md
@@ -18,7 +18,7 @@
 -Idir	add `dir' to the beginning of the list of #include directories
 -K don't run ihxcheck test on linker ihx output
 -lx	search library `x'
--m	select port and platform: "-m[port]:[plat]" ports:gbz80,z80 plats:ap,gb,sms,gg
+-m	select port and platform: "-m[port]:[plat]" ports:gbz80,z80 plats:ap,duck,gb,sms,gg
 -N	do not search the standard directories for #include files
 -n	emit code to check for dereferencing zero pointers
 -no-crt do not auto-include the gbdk crt0.o runtime in linker list
@@ -155,8 +155,6 @@ Linker options:
 Special options for the z80 port:
       --callee-saves-bc     Force a called function to always save BC
       --portmode=           Determine PORT I/O mode (z80/z180)
-      -bo                   <num> use code bank <num>
-      -ba                   <num> use data bank <num>
       --asm=                Define assembler name (rgbds/asxxxx/isas/z80asm/gas)
       --codeseg             <name> use this name for the code segment
       --constseg            <name> use this name for the const segment
@@ -431,7 +429,7 @@ Options
 --cin  : Read input as .c source format (8 bit char ONLY, uses first array found)
 --cout : Write output in .c / .h source format (8 bit char ONLY) 
 --varname=<NAME> : specify variable name for c source output
---alg=<type>     : specify compression type. 'rle', 'gb' (default)
+--alg=<type>     : specify compression type: 'rle', 'gb' (default)
 Example: "gbcompress binaryfile.bin compressed.bin"
 Example: "gbcompress -d compressedfile.bin decompressed.bin"
 Example: "gbcompress --alg=rle binaryfile.bin compressed.bin"
@@ -459,4 +457,8 @@ usage: png2asset    <file>.png [options]
 -map                Export as map (tileset + bg)
 -use_map_attributes Use CGB BG Map attributes (default: palettes are stored for each tile in a separate array)
 -use_structs        Group the exported info into structs (default: false)
+-bpp                bits per pixel (default: 2)
+-max_palettes       maximum number of palettes allowed (default: 2)
+-pack_mode          gb, sgb or sms (default:GB)
+-tile_origin        tile index offset for maps (instead of zero)
 ```

This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.