| Message ID | 20240128233249.32794-1-herdler@nurfuerspam.de |
|---|---|
| Headers | show |
| Series | media: docs: uAPI: dvb/decoder: completing the documentation | expand |
Hi Stefan, Em Mon, 29 Jan 2024 00:32:43 +0100 Stefan Herdler <herdler@nurfuerspam.de> escreveu: > This is basically a resend of v3 after 6 month, with some minor updates. > Changes since v3: > * Adjust title and description to better match existing documentation. > * Fix warnings from kernel test robot. > (At least I hope it is fixed now, I couldn't reproduce this warning.) > > No changes to the text it self. > The layout is still identical since v1, just split into multiple patches. > My comments of v3 attached below, they refer to Mauros comments[3] to > v2 and still fully apply. Patch series applied. I opted to reorder the series placing patch 1 at the end, as otherwise it would cause bisect issues, as the index would be trying to reference non-existing files. Thank you for the series! Regards, Mauro > > [3: https://patchwork.kernel.org/project/linux-media/patch/decd5d71-f06e-5873-5ebf-7028107f65ee@nurfuerspam.de/] > > > [PATCH v3] (July '23) --------------------------------------------------- > > Changes since v2: > * Split the patch into a patch series. > * Incorporate the changes requested. > * Style updates to better match the existing documentation. > * And a lot of small fixes. > > > Hi Mauro, > > it took a little longer then expected, but I didn't had much time in spare > for this. I'm pretty much occupied by other things at the moment. > The winter season would be better for things like this, but I try to > finish it as quick as possible. > > I went through your mail point by point and I'm confident, that I was able > to sort out your questions now. At least I don't see anything that need to > be improved anymore. > The work has been done in a lot of small blocks over a pretty long period > after my daily work, mostly late at night. Despite double checking > everything, I maybe still have missed something. I hope it is not too > much. > > For usage it has been checked against the known projects using the DVB > decoder APIs: > * The AV7110 kernel driver. > * The out of tree driver for the HD full featured cards.[1] > * The "Enigma2" sources from openatv team.[2] > (The drivers of the boxes are binary only.) > > Possibly unused items have been listed in the comment of the patches. > Please take this lists with a pinch of salt. With the number of items > checked, it is pretty easy to miss an occurrence or have a false positive. > Although I've done my best, there is still the chance that I've missed an > use case. > > I tried to complete the documentation of this unused definition too. > Most information had been collect anyway and writing it down wasn't that > much of effort. > > Removing the definition and documentation later at once is always an > option. > I would prefer to do it this way, if something has to be removed. > It is easier to revert the change in case of a regression. > If necessary I can provide the patches too. > > Regards > Stefan > > [1: https://github.com/s-moch/linux-saa716x] > [2: https://github.com/openatv/enigma2/tree/master] > > > > Stefan Herdler (6): > Add documentation for legacy DVB decoder API > Add documentation for osd.h > Add documentation for audio.h (data types) > Add documentation for audio.h (function calls) > Add documentation for video.h (data types) > Add documentation for video.h (function calls) > > .../media/dvb/legacy_dvb_apis.rst | 1 + > .../media/dvb/legacy_dvb_audio.rst | 1642 +++++++++++ > .../media/dvb/legacy_dvb_decoder_api.rst | 61 + > .../media/dvb/legacy_dvb_osd.rst | 883 ++++++ > .../media/dvb/legacy_dvb_video.rst | 2430 +++++++++++++++++ > 5 files changed, 5017 insertions(+) > create mode 100644 Documentation/userspace-api/media/dvb/legacy_dvb_audio.rst > create mode 100644 Documentation/userspace-api/media/dvb/legacy_dvb_decoder_api.rst > create mode 100644 Documentation/userspace-api/media/dvb/legacy_dvb_osd.rst > create mode 100644 Documentation/userspace-api/media/dvb/legacy_dvb_video.rst > > -- > 2.34.0 > > Thanks, Mauro
Hi Mauro, On 07/02/24 06:10 Mauro Carvalho Chehab wrote: > Hi Stefan, > > Em Mon, 29 Jan 2024 00:32:43 +0100 > Stefan Herdler <herdler@nurfuerspam.de> escreveu: > >> This is basically a resend of v3 after 6 month, with some minor updates. >> Changes since v3: >> * Adjust title and description to better match existing documentation. >> * Fix warnings from kernel test robot. >> (At least I hope it is fixed now, I couldn't reproduce this warning.) >> >> No changes to the text it self. >> The layout is still identical since v1, just split into multiple patches. >> My comments of v3 attached below, they refer to Mauros comments[3] to >> v2 and still fully apply. > > Patch series applied. I opted to reorder the series placing patch 1 at the > end, as otherwise it would cause bisect issues, as the index would be > trying to reference non-existing files. To reorder makes perfectly sense to me. Somehow I overlooked it all the time. Thanks for fixing :-). I'm glad, that it was the only thing I messed up, I expected much more. This hole process is still a learning experience for me. Thank you again, for your feedback, hints and patience. Regards, Stefan > > Thank you for the series! > > Regards, > Mauro > > >> >> [3: https://patchwork.kernel.org/project/linux-media/patch/decd5d71-f06e-5873-5ebf-7028107f65ee@nurfuerspam.de/] >> >> >> [PATCH v3] (July '23) --------------------------------------------------- >> >> Changes since v2: >> * Split the patch into a patch series. >> * Incorporate the changes requested. >> * Style updates to better match the existing documentation. >> * And a lot of small fixes. >> >> >> Hi Mauro, >> >> it took a little longer then expected, but I didn't had much time in spare >> for this. I'm pretty much occupied by other things at the moment. >> The winter season would be better for things like this, but I try to >> finish it as quick as possible. >> >> I went through your mail point by point and I'm confident, that I was able >> to sort out your questions now. At least I don't see anything that need to >> be improved anymore. >> The work has been done in a lot of small blocks over a pretty long period >> after my daily work, mostly late at night. Despite double checking >> everything, I maybe still have missed something. I hope it is not too >> much. >> >> For usage it has been checked against the known projects using the DVB >> decoder APIs: >> * The AV7110 kernel driver. >> * The out of tree driver for the HD full featured cards.[1] >> * The "Enigma2" sources from openatv team.[2] >> (The drivers of the boxes are binary only.) >> >> Possibly unused items have been listed in the comment of the patches. >> Please take this lists with a pinch of salt. With the number of items >> checked, it is pretty easy to miss an occurrence or have a false positive. >> Although I've done my best, there is still the chance that I've missed an >> use case. >> >> I tried to complete the documentation of this unused definition too. >> Most information had been collect anyway and writing it down wasn't that >> much of effort. >> >> Removing the definition and documentation later at once is always an >> option. >> I would prefer to do it this way, if something has to be removed. >> It is easier to revert the change in case of a regression. >> If necessary I can provide the patches too. >> >> Regards >> Stefan >> >> [1: https://github.com/s-moch/linux-saa716x] >> [2: https://github.com/openatv/enigma2/tree/master] >> >> >> >> Stefan Herdler (6): >> Add documentation for legacy DVB decoder API >> Add documentation for osd.h >> Add documentation for audio.h (data types) >> Add documentation for audio.h (function calls) >> Add documentation for video.h (data types) >> Add documentation for video.h (function calls) >> >> .../media/dvb/legacy_dvb_apis.rst | 1 + >> .../media/dvb/legacy_dvb_audio.rst | 1642 +++++++++++ >> .../media/dvb/legacy_dvb_decoder_api.rst | 61 + >> .../media/dvb/legacy_dvb_osd.rst | 883 ++++++ >> .../media/dvb/legacy_dvb_video.rst | 2430 +++++++++++++++++ >> 5 files changed, 5017 insertions(+) >> create mode 100644 Documentation/userspace-api/media/dvb/legacy_dvb_audio.rst >> create mode 100644 Documentation/userspace-api/media/dvb/legacy_dvb_decoder_api.rst >> create mode 100644 Documentation/userspace-api/media/dvb/legacy_dvb_osd.rst >> create mode 100644 Documentation/userspace-api/media/dvb/legacy_dvb_video.rst >> >> -- >> 2.34.0 >> >> > > > > Thanks, > Mauro