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

Fix documentation in HTML format

Browse Source 
For some reason, `No` looks weird in the HTML version of the docs.

Some other random fixes.

Tables in src/asm/rgbasm.5 are still broken in the HTML docs.

Signed-off-by: Antonio Niño Díaz <antonio_nd@outlook.com>
This commit is contained in:
Antonio Niño Díaz
2017-04-16 22:50:54 +01:00
parent 59c065cf31
commit ac69e9863e
4 changed files with 488 additions and 214 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
src/link/rgblink.5
View File

@@ -12,7 +12,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd April 12, 2017
.Dd April 16, 2017
.Dt RGBLINK 5
.Os RGBDS Manual
.Sh NAME
@@ -33,27 +33,33 @@ Any line can contain a comment starting with
.Ql \&;
that ends at the end of the line:
.Pp
ROMX $F ; This is a comment
"Functions to read array"
ALIGN 8
"Array aligned to 256 bytes"
.Bd -literal -offset indent
ROMX $F ; This is a comment
"Functions to read array"
ALIGN 8
"Array aligned to 256 bytes"
WRAMX 2
"Some variables"
WRAMX 2
"Some variables"
.Ed
.Pp
Numbers can be in decimal or hexadecimal format (the prefix is
.Ql $ ) .
It is an error if any bank or command is found before setting a bank.
.Pp
Files can be included by using the
.Ar INCLUDE No keyword followed by a string with the path of the file that has
to be included.
.Ar INCLUDE
keyword followed by a string with the path of the file that has to be included.
.Pp
The possible bank types are:
.Sy ROM0 , ROMX , VRAM , WRAM0 , WRAMX , OAM No and Sy HRAM .
.Sy ROM0 , ROMX , VRAM , WRAM0 , WRAMX , OAM
and
.Sy HRAM .
Types
.Sy ROMX , VRAM , WRAMX No and Sy SRAM No are banked, which means that it is
needed to specify a bank after the type.
.Sy ROMX , VRAM , WRAMX
and
.Sy SRAM
are banked, which means that it is needed to specify a bank after the type.
.Pp
When a new bank statement is found, sections found after it will be placed
right from the beginning of that bank.
@@ -61,15 +67,20 @@ If the linkerscript switches to a different bank and then it comes back to the
previous one it will continue from the last address that was used.
.Pp
The only two commands are
.Ar ORG No and Ar ALIGN :
.Ar ORG
and
.Ar ALIGN :
.Bl -bullet
.It
.Ar ORG No sets the address in which new sections will be placed.
.Ar ORG
sets the address in which new sections will be placed.
It can not be lower than the current address.
.It
.Ar ALIGN No will increase the address until it is aligned to the specified
boundary (it tries to set to 0 the number of bits specified after the command:
.Ar ALIGN No 8 No will align to No $100 ) .
.Ar ALIGN
will increase the address until it is aligned to the specified boundary (it
tries to set to 0 the number of bits specified after the command:
.Sy ALIGN 8
will align to $100).
.El
.Pp
Note: The bank, alignment, address and type of sections can be specified both