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

man pages bundled in 1.4.0 release are empty #432

Closed
namtsui opened this issue Sep 9, 2022 · 9 comments · Fixed by #440
Closed

man pages bundled in 1.4.0 release are empty #432

namtsui opened this issue Sep 9, 2022 · 9 comments · Fixed by #440

Comments

@namtsui
Copy link

namtsui commented Sep 9, 2022

I think these man pages were intended to be removed according to: 80d064e

currently, the flac.1 and metaflac.1 are included in the release tarball
https://downloads.xiph.org/releases/flac/flac-1.4.0.tar.xz

the effect is that empty man pages are produced and pandoc never gets a chance to run.

$ make flac.1
`flac.1' is up to date.

@namtsui
Copy link
Author

namtsui commented Sep 9, 2022

while here, I see that the warning message can be updated: docbook-to-man --> pandoc

echo "*** Warning: docbook-to-man not found; man pages will not be built."

@ktmf01
Copy link
Collaborator

ktmf01 commented Sep 10, 2022

currently, the flac.1 and metaflac.1 are included in the release tarball https://downloads.xiph.org/releases/flac/flac-1.4.0.tar.xz

That was intentional

the effect is that empty man pages are produced

That doesn't happen at my end, can you elaborate?

and pandoc never gets a chance to run.

Yes, as soon as flac.md or metaflac.md changes, it is run, but I don't see why pandoc has to be run if nothing has changed?

while here, I see that the warning message can be updated: docbook-to-man --> pandoc

echo "*** Warning: docbook-to-man not found; man pages will not be built."

Yes, that should be cleaned up

@heirecka
Copy link

currently, the flac.1 and metaflac.1 are included in the release tarball https://downloads.xiph.org/releases/flac/flac-1.4.0.tar.xz

That was intentional

Was it also intentional, that they are empty in the tarball?
I assume the motivation for including them in the tarball was to avoid pulling in pandoc, which with its haskell stack can be quite a heavy dependency? Of course that doesn't help much if they are empty ;-).

@namtsui
Copy link
Author

namtsui commented Sep 10, 2022

I wrote the original post in a confusing way. As mentioned by heirecka, the release tarball contains empty man pages.

@ktmf01
Copy link
Collaborator

ktmf01 commented Sep 10, 2022

Aha, I see now. I was looking at another tarball than the one I released.

@ktmf01
Copy link
Collaborator

ktmf01 commented Sep 10, 2022

I see now the api documentation isn't included either. I will look into this

@ktmf01 ktmf01 changed the title man page bundled in 1.4.0 release contains flac.1 and metaflac.1 man pages bundled in 1.4.0 release are empty Sep 12, 2022
@ktmf01 ktmf01 linked a pull request Sep 12, 2022 that will close this issue
@diizzyy
Copy link

diizzyy commented Sep 13, 2022

Is there going to be a release with this fixed and the other issues reported in the near future?

@ktmf01
Copy link
Collaborator

ktmf01 commented Sep 14, 2022

Yes, that is the plan. At first I planned on re-releasing 1.4.0, but the choice was made to not wait too long with 1.4.1. So please do report any other (build) problems. I expect to have 1.4.1 ready end of next week.

@ktmf01
Copy link
Collaborator

ktmf01 commented Sep 22, 2022

I've just released FLAC 1.4.1, with man pages this time

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

Successfully merging a pull request may close this issue.

4 participants