Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve dformat #1

Open
eiro opened this issue Nov 5, 2021 · 14 comments
Open

improve dformat #1

eiro opened this issue Nov 5, 2021 · 14 comments

Comments

@eiro
Copy link
Owner

eiro commented Nov 5, 2021

hello @sathlan and @hjoertel,

as discussed here https://lists.gnu.org/archive/html/groff/2021-11/msg00008.html, i want to implement new features (basically more theming, handle parameters, support comments) in dformat. before that, i would like to:

  • add some regression tests (t/test1.dformat must produce t/test1.pic, ...) from the papers and any other source i can find
  • add a man page and some examples
  • add a debian/ dir

also i wonder if autotools makes sense for such a little project: maybe we can reduce the scaffold?
@sathlan is your repo open for such contributions ? @hjoertel do you still consider contribute to dformat ?

regards,
marc

@hjoertel
Copy link

hjoertel commented Nov 5, 2021 via email

@eiro
Copy link
Owner Author

eiro commented Nov 5, 2021

i'm really happy to read from you @hjoertel, thanks for replying.

as suggested on the list, i used mutool to extract your patched version then i started to work on it:

  • reformat the code and make it work
  • use #! /usr/bin/env -S awk -f as shebang and make it executable
  • remove the parm[] and use variables so they can be defined from command line
    (like dformat -vlinedisp=.05 -vrecht=.2 ethernet.dformat | pic | groff )

then i realized i was changing the code without testing regression which is a bad idea. i'll keep the original version as bin test.

it would be nice if i can have:

  • your patched script
  • the roff of the patched paper you sent on the list years ago
  • any dformat files and their .pic results
  • any comment on my roadmap, advice or request

regards

@Alhadis
Copy link

Alhadis commented Nov 7, 2021

@hjoertel Please also consider removing these useless boilerplate files (which appear to be completely unused):

Moreover, this program was NOT released under the GPL, but the Caldera license (like the rest of Unix). So the GPL COPYING file should be replaced with a copy of the Caldera license, IMHO.

@eiro
Copy link
Owner Author

eiro commented Nov 7, 2021 via email

@Alhadis
Copy link

Alhadis commented Nov 7, 2021

+1 to remove the automake thing but those files should remain

Not if they remain empty. 😉 Somebody should start filling them out.

Or i'll rewrite the whole thing from scratch as a clone (i was about to change a lot of things anyway)

That's something I've thought of doing myself, to be honest. What exactly did you have in mind by way of changes?

@eiro
Copy link
Owner Author

eiro commented Nov 18, 2021

hello,

i had some ideas to make the code easier to maintain so we could add backends (one of them i have in mind is an english description of the frames so people with visual deficiency can actually ear a description of the content)

i was hoping @hjoertel to reply first (i really think we should start from the content he could provide to us but my very first step should be (as written earlier) to make dformat easy to ship and have a regression test suite.

regards

@hjoertel
Copy link

hjoertel commented Nov 19, 2021 via email

@eiro
Copy link
Owner Author

eiro commented Nov 21, 2021

@hjoertel no attachment here. please send me directly at mc unistra < punt > fr.

Regards
marc

@sathlan
Copy link
Collaborator

sathlan commented Feb 8, 2022

Never too late to reply. Thanks for all the points raised here especially the license one. This "project" doesn't really belong to me, but just a copy of it because that was useful to me at the time. Hope you've clone it somewhere or I could give the repo/name to somebody if interested - not sure it's really needed :)

@eiro
Copy link
Owner Author

eiro commented Feb 8, 2022 via email

@sathlan
Copy link
Collaborator

sathlan commented Feb 8, 2022

Hey Marc,

If you're fine with that, please give me the repo so I (and
@Alhadis, @hjoertel if still interested) will take care.

transfert request initiated

chem.

@eiro
Copy link
Owner Author

eiro commented Feb 8, 2022

next steps to close this issue: do everything mentioned (including having a test suite so we can change/delete some code).

@sathlan thanks again! under what identity should i credit you on a HISTORY section?

@sathlan
Copy link
Collaborator

sathlan commented Feb 9, 2022

Hi @eiro, you can add me as Sofer Athlan-Guyot if you need to, but again I really didn't do anything here, so you can skip me safely :)

Enjoy.

@Alhadis
Copy link

Alhadis commented Feb 10, 2022

You can go ahead and add me also. I'm at least semi-active on GitHub these days. 😉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants