search

gp48k / zmac

Z-80 macro cross-assembler.
http://48k.ca/zmac.html
13 stars 7 forks source link

Lcu manpage and makefile #5

Open mojadita opened 1 year ago

mojadita commented 1 year ago

Hi, I have added a manpage to zmac, based on the documentation you generate with the doc program. I have also tweaked the Makerile to create/install the man pages and install them with $(prefix) based directories.

I expect you will accept my pull request, as I plan to use it (and propose this new version) to be used as a submodule in xtrs project. This will allow us to have a precise version of zmac in xtrs, so we don't need to tweak Makefile in order to compile xtrs. That project claims to use an old version of zmac (one that has a different command line options).

Thanks in advance,

Luis.

gp48k commented 1 year ago

Sorry about the delay; I hadn't noticed the pull requests until just recently.

I'd want the manual page to be generated from the source documentation rather than something I'd need to maintain separately. I'll work on extending doc.c to handle that.

I'd rather the changes to the makefile be more minimal. Just to keep it as simple as possible.

gp48k commented 1 year ago

Oh, forgot to thank you for the manual page. It'll be a big help in showing what doc.c needs to do. I wrote manual pages long, long ago but am not up to date on the latest things.

mojadita commented 1 year ago

I tried to do that, but unfortunately, the format of a unix manual page is a bit rigid in the overal structure of the manual page and your documentation doesn't follow the schema you are using, so I didn't dare to do it myself. But from your message I don't know if the PR requires more work on my side or it just has been rejected. I understand your point and, based on that, I decided to make it separately. I strongly agree with you in the point that the documentation source should be only one point, but the manual pages require the SYNOPSIS and DESCRIPTION sections in that order, and I didn't find (and of course I didn't dare to change it myself) a good edit of your documentation to adapt to the schema used by man pages. Anyway, IMHO that a man page for an assembler that is mostly used in UNIX should be available.

Thanks anyway for your answer, but tell me please if we are working together on this, or you are kindly rejecting my work. I will use the manpage anyway, but modifying it as you make changes to the application requires short following your development. Just transcripting the doc contents into a unix man page took me several days of work.

Luis Colorado Urcola Hakarinne 2, N170

02100 EspooFI Cellphone: +358 41 31 82 147

El dom, 2 abr 2023 a las 22:55, George Phillips @.***>) escribió:

Sorry about the delay; I hadn't noticed the pull requests until just recently.

I'd want the manual page to be generated from the source documentation rather than something I'd need to maintain separately. I'll work on extending doc.c to handle that.

I'd rather the changes to the makefile be more minimal. Just to keep it as simple as possible.

— Reply to this email directly, view it on GitHub https://github.com/gp48k/zmac/pull/5#issuecomment-1493426216, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACCU2O5JBDEMOYSMMOV4VNTW7HKU3ANCNFSM6AAAAAAUJ5II34 . You are receiving this because you authored the thread.Message ID: @.***>

gp48k commented 1 year ago

My idea was to work it out together to accept your PR.

I've committed changes to have "doc.c" generate the manual page. There is room for improvement but I think it is a good starting point.

I'm not really familiar with git or github workflow. All we really need now is to get the Makefile updated so it can optionally install the manual page. I don't know if it makes more sense for you to update your PR which the Makefile changes or to simply make a new PR with the Makefile changes.

Take your pick; either is fine by me.