[FFmpeg-trac] #10767(documentation:new): Bad documentation on chroma-derived-nc and friends

[FFmpeg]

#10767: Bad documentation on chroma-derived-nc and friends
-------------------------------------+-------------------------------------
             Reporter:  Mingye Wang  |                    Owner:  (none)
                 Type:  defect       |                   Status:  new
             Priority:  normal       |                Component:
                                     |  documentation
              Version:  git-master   |               Resolution:
             Keywords:  colorspace   |               Blocked By:
             Blocking:               |  Reproduced by developer:  0
Analyzed by developer:  0            |
-------------------------------------+-------------------------------------
Description changed by Mingye Wang:

Old description:

> Summary of the bug:
> The texinfo documentation on chroma-derived-{nc,c} is bad. In fact, it's
> worse than what we have in pixfmt.h. We should replace these all with
> pixfmt.h documentation.
>
> How to reproduce:
> Navigate to:
> * https://github.com/FFmpeg/FFmpeg/blob/master/libavutil/pixfmt.h, for
> how the documentation should look like.
> * https://ffmpeg.org/ffmpeg-codecs.html#Codec-Options, which has one
> instance of these options. Here we see {{{chroma-derived-nc}}} explained
> as "Chroma-derived NCL", which is very unhelpful compared to
> [https://github.com/FFmpeg/FFmpeg/blob/e063c1d079086150580ed7a9ad076da122e27f76/libavutil/pixfmt.h#L620
> what pixfmt says]. In general, the descriptions for
> {{{color_primaries}}}, {{{color_trc}}}, and {{{colorspace}}} are of lower
> quality than their pixfmt.h version, so I recommend that they all be
> replaced.
> * https://ffmpeg.org/ffmpeg-filters.html#setparams-1, which has another
> instance. This one is just blank.

New description:

 Summary of the bug:
 The texinfo documentation on chroma-derived-{nc,c} is bad. In fact, it's
 worse than what we have in pixfmt.h. We should replace these all with
 pixfmt.h documentation.

 How to reproduce:
 Navigate to:
 * https://github.com/FFmpeg/FFmpeg/blob/master/libavutil/pixfmt.h, for how
 the documentation should look like.
 * https://ffmpeg.org/ffmpeg-codecs.html#Codec-Options, which has one
 instance of these options. Here we see {{{chroma-derived-nc}}} explained
 as "Chroma-derived NCL", which is very unhelpful compared to
 [https://github.com/FFmpeg/FFmpeg/blob/e063c1d079086150580ed7a9ad076da122e27f76/libavutil/pixfmt.h#L620
 what pixfmt says]. In general, the descriptions for {{{color_primaries}}},
 {{{color_trc}}}, {{{colorspace}}} are of lower quality than their pixfmt.h
 version, so I recommend that they all be replaced.
 ** While we are at it, the texinfo description for {{{color_range}}} is
 straight up wrong. pixfmt again has it right.
 * https://ffmpeg.org/ffmpeg-filters.html#setparams-1, which has another
 instance. This one is just blank.

--
-- 
Ticket URL: <https://trac.ffmpeg.org/ticket/10767#comment:2>
FFmpeg <https://ffmpeg.org>
FFmpeg issue tracker