2022-11-30 12:25:35

by Akira Yokosawa

[permalink] [raw]
Subject: [PATCH] media: Add ignore patterns to frontend.h.rst.exceptions

Commit 6508a50fe84f ("media: dvb: add DVB-C2 and DVB-S2X parameter
values") failed to add ignore patterns to frontend.h.rst.exceptions.
This results in new warning msgs from "make htmldocs" as reported
by Stephen [1].

Fix the issue by adding needed patterns.

While at it, fix typos of "QAM-1024" and "QAM-4096" in frontend.h.

Fixes: 6508a50fe84f ("media: dvb: add DVB-C2 and DVB-S2X parameter values")
Reported-by: Stephen Rothwell <[email protected]>
Link: [1] https://lore.kernel.org/r/[email protected]/
Signed-off-by: Akira Yokosawa <[email protected]>
Cc: Robert Schlabbach <[email protected]>
Cc: Mauro Carvalho Chehab <[email protected]>
---
.../media/frontend.h.rst.exceptions | 28 +++++++++++++++++++
include/uapi/linux/dvb/frontend.h | 4 +--
2 files changed, 30 insertions(+), 2 deletions(-)

diff --git a/Documentation/userspace-api/media/frontend.h.rst.exceptions b/Documentation/userspace-api/media/frontend.h.rst.exceptions
index 6283702c08c8..6f03c704d6ac 100644
--- a/Documentation/userspace-api/media/frontend.h.rst.exceptions
+++ b/Documentation/userspace-api/media/frontend.h.rst.exceptions
@@ -86,6 +86,13 @@ ignore symbol APSK_16
ignore symbol APSK_32
ignore symbol DQPSK
ignore symbol QAM_4_NR
+ignore symbol QAM_1024
+ignore symbol QAM_4096
+ignore symbol APSK_8_L
+ignore symbol APSK_16_L
+ignore symbol APSK_32_L
+ignore symbol APSK_64
+ignore symbol APSK_64_L

ignore symbol SEC_VOLTAGE_13
ignore symbol SEC_VOLTAGE_18
@@ -119,6 +126,22 @@ ignore symbol FEC_AUTO
ignore symbol FEC_3_5
ignore symbol FEC_9_10
ignore symbol FEC_2_5
+ignore symbol FEC_1_3
+ignore symbol FEC_1_4
+ignore symbol FEC_5_9
+ignore symbol FEC_7_9
+ignore symbol FEC_8_15
+ignore symbol FEC_11_15
+ignore symbol FEC_13_18
+ignore symbol FEC_9_20
+ignore symbol FEC_11_20
+ignore symbol FEC_23_36
+ignore symbol FEC_25_36
+ignore symbol FEC_13_45
+ignore symbol FEC_26_45
+ignore symbol FEC_28_45
+ignore symbol FEC_32_45
+ignore symbol FEC_77_90

ignore symbol TRANSMISSION_MODE_AUTO
ignore symbol TRANSMISSION_MODE_1K
@@ -143,6 +166,7 @@ ignore symbol GUARD_INTERVAL_19_256
ignore symbol GUARD_INTERVAL_PN420
ignore symbol GUARD_INTERVAL_PN595
ignore symbol GUARD_INTERVAL_PN945
+ignore symbol GUARD_INTERVAL_1_64

ignore symbol HIERARCHY_NONE
ignore symbol HIERARCHY_AUTO
@@ -163,6 +187,9 @@ ignore symbol ROLLOFF_35
ignore symbol ROLLOFF_20
ignore symbol ROLLOFF_25
ignore symbol ROLLOFF_AUTO
+ignore symbol ROLLOFF_15
+ignore symbol ROLLOFF_10
+ignore symbol ROLLOFF_5

ignore symbol INVERSION_ON
ignore symbol INVERSION_OFF
@@ -172,6 +199,7 @@ ignore symbol SYS_UNDEFINED
ignore symbol SYS_DVBC_ANNEX_A
ignore symbol SYS_DVBC_ANNEX_B
ignore symbol SYS_DVBC_ANNEX_C
+ignore symbol SYS_DVBC2
ignore symbol SYS_ISDBC
ignore symbol SYS_DVBT
ignore symbol SYS_DVBT2
diff --git a/include/uapi/linux/dvb/frontend.h b/include/uapi/linux/dvb/frontend.h
index 4fed9e316147..ab215d1c15d2 100644
--- a/include/uapi/linux/dvb/frontend.h
+++ b/include/uapi/linux/dvb/frontend.h
@@ -363,8 +363,8 @@ enum fe_code_rate {
* @APSK_32: 32-APSK modulation
* @DQPSK: DQPSK modulation
* @QAM_4_NR: 4-QAM-NR modulation
- * @QAM-1024: 1024-QAM modulation
- * @QAM-4096: 4096-QAM modulation
+ * @QAM_1024: 1024-QAM modulation
+ * @QAM_4096: 4096-QAM modulation
* @APSK_8_L: 8APSK-L modulation
* @APSK_16_L: 16APSK-L modulation
* @APSK_32_L: 32APSK-L modulation

base-commit: 6a5a4514854a637d01c50f5ea17b28f78b31ddb8
--
2.25.1


2022-11-30 13:10:23

by Akira Yokosawa

[permalink] [raw]
Subject: Re: [PATCH] media: Add ignore patterns to frontend.h.rst.exceptions

On Wed, 30 Nov 2022 13:46:25 +0100, Hans Verkuil wrote:
> On 11/30/22 13:37, Akira Yokosawa wrote:
>> On Wed, 30 Nov 2022 13:08:57 +0100, Hans Verkuil wrote:
>>> On 11/30/22 13:02, Akira Yokosawa wrote:
>>>> Commit 6508a50fe84f ("media: dvb: add DVB-C2 and DVB-S2X parameter
>>>> values") failed to add ignore patterns to frontend.h.rst.exceptions.
>>>> This results in new warning msgs from "make htmldocs" as reported
>>>> by Stephen [1].
>>>>
>>>> Fix the issue by adding needed patterns.
>>>
>>> Patch has already been posted:
>>>
>>> https://patchwork.linuxtv.org/project/linux-media/patch/[email protected]/
>>
>> Even better!
>>
>>>
>>> Regards,
>>>
>>> Hans
>>>
>>>>
>>>> While at it, fix typos of "QAM-1024" and "QAM-4096" in frontend.h.
>>
>> Have these typos been taken care of?
>
> Yes, in another patch.
>
> https://patchwork.linuxtv.org/project/linux-media/patch/[email protected]/

Nice!

Thank you for letting me know.

Akira
>
> Hans
>
>>
>> Thanks, Akira
>>
>>>>
>>>> Fixes: 6508a50fe84f ("media: dvb: add DVB-C2 and DVB-S2X parameter values")
>>>> Reported-by: Stephen Rothwell <[email protected]>
>>>> Link: [1] https://lore.kernel.org/r/[email protected]/
>>>> Signed-off-by: Akira Yokosawa <[email protected]>
>>>> Cc: Robert Schlabbach <[email protected]>
>>>> Cc: Mauro Carvalho Chehab <[email protected]>
>>>> ---
>>>> .../media/frontend.h.rst.exceptions | 28 +++++++++++++++++++
>>>> include/uapi/linux/dvb/frontend.h | 4 +--
>>>> 2 files changed, 30 insertions(+), 2 deletions(-)
>>>>
>>>> diff --git a/Documentation/userspace-api/media/frontend.h.rst.exceptions b/Documentation/userspace-api/media/frontend.h.rst.exceptions
>>>> index 6283702c08c8..6f03c704d6ac 100644
>>>> --- a/Documentation/userspace-api/media/frontend.h.rst.exceptions
>>>> +++ b/Documentation/userspace-api/media/frontend.h.rst.exceptions
>>>> @@ -86,6 +86,13 @@ ignore symbol APSK_16
>>>> ignore symbol APSK_32
>>>> ignore symbol DQPSK
>>>> ignore symbol QAM_4_NR
>>>> +ignore symbol QAM_1024
>>>> +ignore symbol QAM_4096
>>>> +ignore symbol APSK_8_L
>>>> +ignore symbol APSK_16_L
>>>> +ignore symbol APSK_32_L
>>>> +ignore symbol APSK_64
>>>> +ignore symbol APSK_64_L
>>>>
>>>> ignore symbol SEC_VOLTAGE_13
>>>> ignore symbol SEC_VOLTAGE_18
>>>> @@ -119,6 +126,22 @@ ignore symbol FEC_AUTO
>>>> ignore symbol FEC_3_5
>>>> ignore symbol FEC_9_10
>>>> ignore symbol FEC_2_5
>>>> +ignore symbol FEC_1_3
>>>> +ignore symbol FEC_1_4
>>>> +ignore symbol FEC_5_9
>>>> +ignore symbol FEC_7_9
>>>> +ignore symbol FEC_8_15
>>>> +ignore symbol FEC_11_15
>>>> +ignore symbol FEC_13_18
>>>> +ignore symbol FEC_9_20
>>>> +ignore symbol FEC_11_20
>>>> +ignore symbol FEC_23_36
>>>> +ignore symbol FEC_25_36
>>>> +ignore symbol FEC_13_45
>>>> +ignore symbol FEC_26_45
>>>> +ignore symbol FEC_28_45
>>>> +ignore symbol FEC_32_45
>>>> +ignore symbol FEC_77_90
>>>>
>>>> ignore symbol TRANSMISSION_MODE_AUTO
>>>> ignore symbol TRANSMISSION_MODE_1K
>>>> @@ -143,6 +166,7 @@ ignore symbol GUARD_INTERVAL_19_256
>>>> ignore symbol GUARD_INTERVAL_PN420
>>>> ignore symbol GUARD_INTERVAL_PN595
>>>> ignore symbol GUARD_INTERVAL_PN945
>>>> +ignore symbol GUARD_INTERVAL_1_64
>>>>
>>>> ignore symbol HIERARCHY_NONE
>>>> ignore symbol HIERARCHY_AUTO
>>>> @@ -163,6 +187,9 @@ ignore symbol ROLLOFF_35
>>>> ignore symbol ROLLOFF_20
>>>> ignore symbol ROLLOFF_25
>>>> ignore symbol ROLLOFF_AUTO
>>>> +ignore symbol ROLLOFF_15
>>>> +ignore symbol ROLLOFF_10
>>>> +ignore symbol ROLLOFF_5
>>>>
>>>> ignore symbol INVERSION_ON
>>>> ignore symbol INVERSION_OFF
>>>> @@ -172,6 +199,7 @@ ignore symbol SYS_UNDEFINED
>>>> ignore symbol SYS_DVBC_ANNEX_A
>>>> ignore symbol SYS_DVBC_ANNEX_B
>>>> ignore symbol SYS_DVBC_ANNEX_C
>>>> +ignore symbol SYS_DVBC2
>>>> ignore symbol SYS_ISDBC
>>>> ignore symbol SYS_DVBT
>>>> ignore symbol SYS_DVBT2
>>>> diff --git a/include/uapi/linux/dvb/frontend.h b/include/uapi/linux/dvb/frontend.h
>>>> index 4fed9e316147..ab215d1c15d2 100644
>>>> --- a/include/uapi/linux/dvb/frontend.h
>>>> +++ b/include/uapi/linux/dvb/frontend.h
>>>> @@ -363,8 +363,8 @@ enum fe_code_rate {
>>>> * @APSK_32: 32-APSK modulation
>>>> * @DQPSK: DQPSK modulation
>>>> * @QAM_4_NR: 4-QAM-NR modulation
>>>> - * @QAM-1024: 1024-QAM modulation
>>>> - * @QAM-4096: 4096-QAM modulation
>>>> + * @QAM_1024: 1024-QAM modulation
>>>> + * @QAM_4096: 4096-QAM modulation
>>>> * @APSK_8_L: 8APSK-L modulation
>>>> * @APSK_16_L: 16APSK-L modulation
>>>> * @APSK_32_L: 32APSK-L modulation
>>>>
>>>> base-commit: 6a5a4514854a637d01c50f5ea17b28f78b31ddb8
>>>
>