Bug 228 - Reword a bit the command line switches in order to be less confusing for people
Summary: Reword a bit the command line switches in order to be less confusing for people
Status: UNCONFIRMED
Alias: None
Product: RLN
Classification: Unclassified
Component: Core (show other bugs)
Version: unspecified
Hardware: All All
: Normal enhancement
Assignee: Shamus Hammons
URL:
Depends on:
Blocks:
 
Reported: 2024-03-06 08:16 CST by ggn
Modified: 2024-03-06 08:16 CST (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description ggn 2024-03-06 08:16:47 CST
In the command line help text (which is pretty much what people are getting with rln, we don't ship a manual with it), there are a few switches that confuse people. These are

-a <text> <data> <bss>  output absolute file (default: ABS)
-e                      output COF absolute file
-n 						output no file header to absolute file (overrides -e)


When people see "-a" they assume that rln is going to output a headerless binary assembled at an absolute address. Instead they get an ABS file, which is different (is that a relic from Alpine binaries? I honestly am not sure).

In any case, they might want a COFF binary for skunkboard or whatever, or just a binary file they can then turn into a ROM.

I would propose that if we don't want to change the switches work (probably a bad idea anyway) we should at least change the wording a bit. Something like:

-a <text> <data> <bss>  output ABS file (assembled at absolute address, includes header)
-e                      output COF file (assembled at absolute address, includes header)
-n 						output no file header to absolute file (overrides -e)