-
-
Notifications
You must be signed in to change notification settings - Fork 228
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
Add hexyl.1 man page to source tree? #159
Comments
Thank you for packaging hexyl for NetBSD! The idea is that we auto-generate the man page from that markdown document. The tarballs on the release page will include the generated Hope this workflow works for package maintainers. |
@sharkdp Thank you for your reply. This doesn't solve the issue, though.
|
Features -Added new --plain, --no-characters, and --no-position flags -Allow hex numbers and units for --block-size argument Other -Added a man page not installed on NetBSD for now, see sharkdp/hexyl#159 -Mention ability to specify length in hex --length and --bytes are now marked as conflicting command-line options
ping @sorairolake: what do you think? |
@sharkdp I think it can be solved by including the generated file in the repo. This makes both maintainability and portability. |
@sorairolake and @sharkdp from our perspective this is the most welcome solution. |
So.. how would we ensure that they are in sync? Change the CI stage to also generate the manpage to a temp file and then compare the output with the checked in |
May I ask what kind of architectures we are talking about? What architecture has a working Rust compiler but no working Haskell compiler? I cannot speak for NetBSD, but at least in Debian, pandoc (and ghc) is not only available on arm, aarch64, x86 , x86_64, riscv64 but also on older and less common architectures like ia64, m68k, sparc64, s390x, ppc64, hppa, mipsel, mips64el... I am tempted to argue that any solution that increases the cost of maintenance has to be balanced against the number of users trying to run hexyl on for instance a VAX running NetBSD (insert your architecture here). Don't get me wrong, I really appreciate the work in keeping old or obscure architectures alive. I have been a user of Debian's powerpcspe port for years and was devastated to see the support for it in GCC go.... |
Honestly, I wouldn't know. I use plain x86_64 and don't keep track of the status for all the other architectures. But, I had a similar issue with another project a week earlier and asked internally on thoughts on how to handle this. Fortunately, in the other case, upstream just decided to provide the man page in the desired format.
Maybe but, that's not the point. I don't think a bunch of if ... then ... else ... endif at the packaging end is the best way to go. But, if you guys think so, I'll respect that. I can always define the package to install the markdown file into |
@sharkdp Could it simply be extracted back from one of the various tarballs you already provide as packages for different OS's? |
I don't understand. The problem is not to generate the man page somehow. The question is whether we want the source file and the autogenerated man page to be in the repo. Accepting the risk that (1) contributors accidentally change the autogenerated file and (2) things are out of sync. Both things can be solved somehow, but I'm personally not going to work on this. If someone wants to implement this, I'm happy to integrate a PR. |
Could we just have the CI add the generated man page separately alongside the existing release tarballs and deb packages? |
@0323pin would that work for you? |
Yes, as long as it's in the release tarball (source code tar.gz, not a pre-packed binary), I can extract it and install. Btw, one of todays commits :) |
But... that should already be the case?
|
Not really, we fetch Source code (tar.gz) and build it natively (the very last file in https://github.com/sharkdp/hexyl/releases/tag/v0.11.0)
It would be awesome if |
I understand. But would it be feasible to download a second file? Either the man page directly (assuming it would be attached separately), or one of the existing tarballs (and you would simply only extraxct |
Yes, this is possible. I can look into this and fetch a second distfile, extract it and add it to the install. |
Thank you. I'll tentatively close this, but feel free to comment here in case you need help. Thank you for packaging |
@sharkdp Finally took the time to fix this and merged the change, http://mail-index.netbsd.org/pkgsrc-changes/2023/09/10/msg282373.html I'm using |
Hi,
Thank you for a new release. I was looking into updating the package for NetBSD and realized the man page is provided in markdown.
Would it possible to provide the man page in the man page Unix format, i.e. like
hexyl.1
orhexyl.1.gz
? It would be desirable to avoid the need of external build dependencies for a simple man page.TIA
The text was updated successfully, but these errors were encountered: