gbdev/rgbds
1
0
Fork 0
mirror of https://github.com/gbdev/rgbds.git synced 2025-11-21 10:42:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix style of code sections in manpages

Browse Source 
Signed-off-by: Antonio Niño Díaz <antonio_nd@outlook.com>
This commit is contained in:
Antonio Niño Díaz
2018-02-23 23:53:40 +00:00
parent 0c85240b97
commit 8cffe22295
2 changed files with 68 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
src/asm/rgbasm.5
View File

@@ -5,7 +5,7 @@
.\" .\"
.\" SPDX-License-Identifier: MIT .\" SPDX-License-Identifier: MIT
.\" .\"
.Dd February 24, 2018 .Dd February 26, 2018
.Dt RGBASM 5 .Dt RGBASM 5
.Os RGBDS Manual .Os RGBDS Manual
.Sh NAME .Sh NAME
@@ -26,7 +26,9 @@ one instruction or pseudo‐op per line:
.Pp .Pp
Example: Example:
.Pp .Pp
.Dl John: ld a,87 ;Weee .Bd -literal -offset indent
John: ld a,87 ;Weee
.Ed
.Pp .Pp
All pseudo‐ops, mnemonics and registers (reserved keywords) are case‐insensitive All pseudo‐ops, mnemonics and registers (reserved keywords) are case‐insensitive
and all labels are case‐sensitive. and all labels are case‐sensitive.
@@ -41,7 +43,9 @@ Before you can start writing code, you must define a section.
This tells the assembler what kind of information follows and, if it is code, This tells the assembler what kind of information follows and, if it is code,
where to put it. where to put it.
.Pp .Pp
.Dl SECTION \[dq]CoolStuff\[dq],ROMX .Bd -literal -offset indent
SECTION \[dq]CoolStuff\[dq],ROMX
.Ed
.Pp .Pp
This switches to the section called "CoolStuff" (or creates it if it doesn't This switches to the section called "CoolStuff" (or creates it if it doesn't
already exist) and it defines it as a code section. already exist) and it defines it as a code section.
@@ -128,22 +132,30 @@ obligation to follow any specific rules.
The following example defines a section that can be placed anywhere in any ROMX The following example defines a section that can be placed anywhere in any ROMX
bank: bank:
.Pp .Pp
.Dl SECTION \[dq]CoolStuff\[dq],ROMX .Bd -literal -offset indent
SECTION \[dq]CoolStuff\[dq],ROMX
.Ed
.Pp .Pp
If it is needed, the following syntax can be used to fix the base address of the If it is needed, the following syntax can be used to fix the base address of the
section: section:
.Pp .Pp
.Dl SECTION \[dq]CoolStuff\[dq],ROMX[$4567] .Bd -literal -offset indent
SECTION \[dq]CoolStuff\[dq],ROMX[$4567]
.Ed
.Pp .Pp
It won't, however, fix the bank number, which is left to the linker. It won't, however, fix the bank number, which is left to the linker.
If you also want to specify the bank you can do: If you also want to specify the bank you can do:
.Pp .Pp
.Dl SECTION \[dq]CoolStuff\[dq],ROMX[$4567],BANK[3] .Bd -literal -offset indent
SECTION \[dq]CoolStuff\[dq],ROMX[$4567],BANK[3]
.Ed
.Pp .Pp
And if you only want to force the section into a certain bank, and not it's And if you only want to force the section into a certain bank, and not it's
position within the bank, that's also possible: position within the bank, that's also possible:
.Pp .Pp
.Dl SECTION \[dq]CoolStuff\[dq],ROMX,BANK[7] .Bd -literal -offset indent
SECTION \[dq]CoolStuff\[dq],ROMX,BANK[7]
.Ed
.Pp .Pp
In addition, you can specify byte alignment for a section. In addition, you can specify byte alignment for a section.
This ensures that the section starts at a memory address where the given number This ensures that the section starts at a memory address where the given number
@@ -155,9 +167,11 @@ However, if an alignment is specified, the base address must be left unassigned.
This can be useful when using DMA to copy data or when it is needed to align the This can be useful when using DMA to copy data or when it is needed to align the
start of an array to 256 bytes to optimize the code that accesses it. start of an array to 256 bytes to optimize the code that accesses it.
.Pp .Pp
.Dl SECTION \[dq]OAM Data\[dq],WRAM0,ALIGN[8] ; align to 256 bytes .Bd -literal -offset indent
.Pp SECTION \[dq]OAM Data\[dq],WRAM0,ALIGN[8] ; align to 256 bytes
.Dl SECTION \[dq]VRAM Data\[dq],ROMX,BANK[2],ALIGN[4] ; align to 16 bytes
SECTION \[dq]VRAM Data\[dq],ROMX,BANK[2],ALIGN[4] ; align to 16 bytes
.Ed
.Pp .Pp
HINT: If you think this is a lot of typing for doing a simple HINT: If you think this is a lot of typing for doing a simple
.Ic ORG .Ic ORG
@@ -255,8 +269,10 @@ EQUates are constant symbols.
They can, for example, be used for things such as bit-definitions of hardware They can, for example, be used for things such as bit-definitions of hardware
registers. registers.
.Pp .Pp
.Dl EXIT_OK EQU $00 .Bd -literal -offset indent
.Dl EXIT_FAILURE EQU $01 EXIT_OK EQU $00
EXIT_FAILURE EQU $01
.Ed
.Pp .Pp
Note that a colon (:) following the label-name is not allowed. Note that a colon (:) following the label-name is not allowed.
EQUates cannot be exported and imported. EQUates cannot be exported and imported.
@@ -278,7 +294,9 @@ Note that a colon (:) following the label-name is not allowed.
SETs cannot be exported and imported. SETs cannot be exported and imported.
Alternatively you can use = as a synonym for SET. Alternatively you can use = as a synonym for SET.
.Pp .Pp
.Dl COUNT = 2 .Bd -literal -offset indent
COUNT = 2
.Ed
.Pp .Pp
.It Sy RSSET , RSRESET , RB , RW .It Sy RSSET , RSRESET , RB , RW
.Pp .Pp
@@ -341,12 +359,16 @@ quoted to be useful.
.Pp .Pp
This will be interpreted as: This will be interpreted as:
.Pp .Pp
.Dl ld a,[hl+] .Bd -literal -offset indent
.Dl db \[dq]John\[dq] ld a,[hl+]
db \[dq]John\[dq]
.Ed
.Pp .Pp
String-symbols can also be used to define small one-line macros: String-symbols can also be used to define small one-line macros:
.Pp .Pp
.Dl PUSHA EQUS \[dq]push af\[rs]npush bc\[rs]npush de\[rs]npush hl\[rs]n\[dq] .Bd -literal -offset indent
PUSHA EQUS \[dq]push af\[rs]npush bc\[rs]npush de\[rs]npush hl\[rs]n\[dq]
.Ed
.Pp .Pp
Note that a colon (:) following the label-name is not allowed. Note that a colon (:) following the label-name is not allowed.
String equates can't be exported or imported. String equates can't be exported or imported.
@@ -459,7 +481,9 @@ Now I can call the macro specifying two arguments.
The first being the address and the second being a bytecount. The first being the address and the second being a bytecount.
The macro will then reset all bytes in this range. The macro will then reset all bytes in this range.
.Pp .Pp
.Dl LoopyMacro MyVars,54 .Bd -literal -offset indent
LoopyMacro MyVars,54
.Ed
.Pp .Pp
Arguments are passed as string equates. Arguments are passed as string equates.
There's no need to enclose them in quotes. There's no need to enclose them in quotes.
@@ -565,7 +589,9 @@ The following symbols are defined by the assembler:
defines a list of bytes that will be stored in the final image. defines a list of bytes that will be stored in the final image.
Ideal for tables and text (which is not zero-terminated). Ideal for tables and text (which is not zero-terminated).
.Pp .Pp
.Dl DB 1,2,3,4,\[dq]This is a string\[dq] .Bd -literal -offset indent
DB 1,2,3,4,\[dq]This is a string\[dq]
.Ed
.Pp .Pp
Alternatively, you can use Alternatively, you can use
.Ic DW .Ic DW
@@ -609,7 +635,9 @@ and
.Ic DL .Ic DL
without any arguments instead. without any arguments instead.
.Pp .Pp
.Dl DS str_SIZEOF ;allocate str_SIZEOF bytes .Bd -literal -offset indent
DS str_SIZEOF ;allocate str_SIZEOF bytes
.Ed
.Pp .Pp
.Ss Including binary files .Ss Including binary files
You probably have some graphics you'd like to include. You probably have some graphics you'd like to include.
@@ -619,15 +647,19 @@ to include a raw binary file as it is.
If the file isn't found in the current directory, the include-path list passed If the file isn't found in the current directory, the include-path list passed
to the linker on the command line will be searched. to the linker on the command line will be searched.
.Pp .Pp
.Dl INCBIN \[dq]titlepic.bin\[dq] .Bd -literal -offset indent
.Dl INCBIN \[dq]sprites/hero.bin\[dq]\ ; UNIX INCBIN \[dq]titlepic.bin\[dq]
.Dl INCBIN \[dq]sprites\[rs]\[rs]hero.bin\[dq]\ ; Windows INCBIN \[dq]sprites/hero.bin\[dq]\ ; UNIX
INCBIN \[dq]sprites\[rs]\[rs]hero.bin\[dq]\ ; Windows
.Ed
.Pp .Pp
You can also include only part of a file with You can also include only part of a file with
.Ic INCBIN . .Ic INCBIN .
The example below includes 256 bytes from data.bin starting from byte 78. The example below includes 256 bytes from data.bin starting from byte 78.
.Pp .Pp
.Dl INCBIN \[dq]data.bin\[dq],78,256 .Bd -literal -offset indent
INCBIN \[dq]data.bin\[dq],78,256
.Ed
.Ss Unions .Ss Unions
Unions allow multiple memory allocations to share the same space in memory, Unions allow multiple memory allocations to share the same space in memory,
like unions in C. like unions in C.
@@ -755,7 +787,9 @@ You may nest
.Ic INCLUDE .Ic INCLUDE
calls infinitely (or until you run out of memory, whichever comes first). calls infinitely (or until you run out of memory, whichever comes first).
.Pp .Pp
.Dl INCLUDE \[dq]irq.inc\[dq] .Bd -literal -offset indent
INCLUDE \[dq]irq.inc\[dq]
.Ed
.Pp .Pp
.Ss Conditional assembling .Ss Conditional assembling
The four commands The four commands
@@ -831,7 +865,9 @@ The last one, Gameboy graphics, is quite interesting and useful.
The values are actually pixel values and it converts the The values are actually pixel values and it converts the
.Do chunky Dc data to Do planar Dc data as used in the Gameboy. .Do chunky Dc data to Do planar Dc data as used in the Gameboy.
.Pp .Pp
.Dl DW \`01012323 .Bd -literal -offset indent
DW \`01012323
.Ed
.Pp .Pp
Admittedly, an expression with just a single number is quite boring. Admittedly, an expression with just a single number is quite boring.
To spice things up a bit there are a few operators you can use to perform To spice things up a bit there are a few operators you can use to perform

8
src/gbz80.7
View File

@@ -5,7 +5,7 @@
.\" .\"
.\" SPDX-License-Identifier: MIT .\" SPDX-License-Identifier: MIT
.\" .\"
.Dd January 26, 2018 .Dd February 23, 2018
.Dt GBZ80 7 .Dt GBZ80 7
.Os RGBDS Manual .Os RGBDS Manual
.Sh NAME .Sh NAME
@@ -24,8 +24,10 @@ as destination can omit the destination as it is assumed it's register
.Sy A . .Sy A .
The following two lines have the same effect: The following two lines have the same effect:
.Pp .Pp
.Dl OR A,B .Bd -literal -offset indent
.Dl OR B OR A,B
OR B
.Ed
.Pp .Pp
.Sh LEGEND .Sh LEGEND
List of abbreviations used in this document. List of abbreviations used in this document.