Skip to content

Commit

Permalink
Revise documentation for rgbasm -p (#1190)
Browse files Browse the repository at this point in the history
Fixes #1125
  • Loading branch information
Rangi42 authored Oct 31, 2023
1 parent 84f3cb4 commit 80bdc88
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions man/rgbasm.1
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@ instruction immediately after any
instruction.
.It Fl I Ar path , Fl Fl include Ar path
Add a new
.Dq include path ; Ar path
.Dq include path ;
.Ar path
must point to a directory.
When a
.Ic INCLUDE
Expand Down Expand Up @@ -166,7 +167,9 @@ This acts as if a
was read before the input
.Ar asmfile .
.It Fl p Ar pad_value , Fl Fl pad-value Ar pad_value
When padding an image, pad with this value.
Use this as the fill value for

This comment has been minimized.

Copy link
@ISSOtm

ISSOtm Oct 31, 2023

Member

"Use this as the default value"?

This comment has been minimized.

Copy link
@Rangi42

Rangi42 Oct 31, 2023

Author Contributor

We already say "The default is 0x00" below. I think having a default value for a default value is a bit confusing.

How about just "Use this as the value"?

This comment has been minimized.

Copy link
@ISSOtm

ISSOtm Nov 2, 2023

Member

"...directives in ROM sections, unless overridden.", maybe?

This comment has been minimized.

Copy link
@Rangi42

Rangi42 Nov 3, 2023

Author Contributor

I copied the phrasing for -Q: "Use this as the precision of fixed-point numbers after the decimal point, unless they specify their own precision."

.Ic DS
directives in ROM sections, unless they specify their own value or values.
The default is 0x00.
.It Fl Q Ar fix_precision , Fl Fl q-precision Ar fix_precision
Use this as the precision of fixed-point numbers after the decimal point, unless they specify their own precision.
Expand Down

0 comments on commit 80bdc88

Please # to comment.