dkogan / feedgnuplot

Tool to plot realtime and stored data from the commandline, using gnuplot.
Other
710 stars 37 forks source link

Add man-page for feedgnuplot #34

Closed TomTheBear closed 6 years ago

TomTheBear commented 6 years ago

We use feedgnuplot in https://github.com/RRZE-HPC/likwid. For the integration into the Debian package repository we needed a man page for all executables we ship. Feedgnuplot is one of those, so I created a man page. Feel free to add it to your repository. The version and date of last changelog change are hardcoded because I don't know how to add them in your Makefile.PL to adjust them automatically at build time.

dkogan commented 6 years ago

Hi. I'm not sure why this would be needed. First off, there's already a Debian package:

https://packages.debian.org/sid/feedgnuplot

And this package already has a manpage:

https://packages.debian.org/sid/all/feedgnuplot/filelist

This manpage is built by the build system:

dima@shorty:~/projects/feedgnuplot$ perl Makefile.PL

Generating a Unix-style Makefile Writing Makefile for feedgnuplot Writing MYMETA.yml and MYMETA.json

dima@shorty:~/projects/feedgnuplot$ make

cp bin/feedgnuplot blib/script/feedgnuplot "/usr/bin/perl" -MExtUtils::MY -e 'MY->fixin(shift)' -- blib/script/feedgnuplot Manifying 1 pod document

dima@shorty:~/projects/feedgnuplot$ ls -l blib/man1/feedgnuplot.1

-rw-r--r-- 1 dima dima 44782 May 2 09:32 blib/man1/feedgnuplot.1

Does some of this not work for you, or was it not clear how it was supposed to work? I'd like to fix any problems in the build system, but the manpage is generated data, so I don't want to commit it into the repo.

Thanks

TomTheBear commented 6 years ago

We integrated feedgnuplot in LIKWID already some years ago (even before I started working on it) and there hasn't been a man page for it at that time. Since one of my co-workers thought that he wrote feedgnuplot and didn't create a man page, I created the man page by hand. Since you don't need it, you can delete the pull request. We only changed the shebangs in all included scripts in LIKWID and I wanted to push them back to the original projects. In issue https://github.com/dkogan/feedgnuplot/issues/28 you made clear that you don't want the env-based shebang, so I just added the man page

dkogan commented 6 years ago

Hi. I'm definitely interested in people sending me patches, so the effort is absolutely appreciated. Thanks! I think the manpage generation is already handled, so I'm not going to take this one, if that's ok. Do let me know if you have other improvements. I don't reject everything :)

TomTheBear commented 6 years ago

We didn't do other changes to your script. We don't do advanced plotting through feedgnuplot, just default xy plots. Of course, we report back when we do (helpful) changes.