-
Notifications
You must be signed in to change notification settings - Fork 323
flac.md: fix "-q" misinformation, and more. #818
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
Conversation
* max -q value was wrong, issue xiph#816 . Fixed that. * Also, reworded -m, -M for clarity, -p for consistency with -q, --lax for brevity. * This should have been done in the previous round: the --help text has the tagging options right after --picture. Did so here too. * But, and this should either also be fixed in the help text or be rejected: --no-utf-8 is a tagging option - aren't those encoding-only? Moved and reworded, but reject as appropriate.
Reworded the wording of -j, correcting the max to the actual 64.
|
Looks like max thread count was wrong as well. Also reworded, clarifying that default is single-thread. |
man/flac.md
Outdated
|
|
||
| **-M**, **\--adaptive-mid-side** | ||
| : Adaptive mid-side coding for all frames (stereo only, otherwise ignored). | ||
| : Like -m, but adaptive choice (faster, slightly weaker compression). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe use the word heuristics here? I think that is more descriptive than adaptive. I know, the word adaptive was there already, but it is rather unclear what it means I think
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No objection to that. I'll look over it and - if you don't mind doing it in this thread - submit more textual suggestions. I have briefly tested picture and RG features and tried to make sense out of actual behaviour vs help text, so a question -- indeed two:
- Could RG still leave PADDING even if --no-padding is used? I didn't get to provoke that. Looks like something similar was addressed in 1.2.1b?
- General formatting: Should one more generally write out e.g.
-wwith ticks instead of -w without? I assume it would be a good thing to write flac double-asterisk-surrounded for the tool, to contrast it from the format (which likely should be FLAC in allcaps?), that is quite common manpage style?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That draft nearly managed to clear up #840 if only "by collateral damage". To do when we get that far.
|
@ktmf01 : You had a few comments on the previous draft, I worked my way up to include the Examples subsection too, yes I introduced some errors there, now rectified. And I did some choice you might not approve upon (like emphasis on error and warning, and more subsectioning), which may be reverted before I run a PR.
If/when this is ready for a PR ... |
|
Time to try to finish it. A comprehensive rewrite, where the first part now looks more like xz man page style - whether that is an improvement is anyone's say I guess, but the information content was overdue for an overhaul. H2Swine@a555fe1#r163204042 comments on those changes that are new since H2Swine@1639bed . There are still a couple of questions up on changes that could have been taken on board. Again: if/when this is ready for a PR ... now it is so much that I guess, not only "if/when @ktmf01 has the time to review whether a PR based on that first part is even a good idea", but also what details are still valid when 1.5.1 is shaping up. (Example: the document does say that as of 1.5.0, treatment of the ".aifc" file extension is inconsistent, and maybe that part of is obsoleted by 1.5.1.) Edit: Now also with |
|
I have completely lost track of what you're doing, mixing up too many things. Please just file a PR already, because I keep forgetting where to find your changes. And if possible, please split uncorrelated stuff up. Maybe first fix things, then after we merge that, do some reordering. Or the other way around. |
* max -q value was wrong, issue xiph#816 . Fixed that. * Also, reworded -m, -M for clarity, -p for consistency with -q, --lax for brevity. * move the tagging options right after --picture. * moved and reworded --no-utf-8 is a tagging option * Correct -j description Co-authored-by: Martijn van Beurden <[email protected]>
Hope I haven't messed up how pulls work. Wouldn't be the first time.
This intends to fix #816 , the man page wrongly states -q 16 is permitted.
I have worked on more on the man page, but I don't want to put in too much in one request.