unicode: add MODULE_DESCRIPTION() macros

[PATCH] unicode: add MODULE_DESCRIPTION() macros

Posted by Jeff Johnson 1 year, 8 months ago

Currently 'make W=1' reports:
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/unicode/utf8data.o
WARNING: modpost: missing MODULE_DESCRIPTION() in fs/unicode/utf8-selftest.o

Add a MODULE_DESCRIPTION() to utf8-selftest.c and utf8data.c_shipped,
and update mkutf8data.c to add a MODULE_DESCRIPTION() to any future
generated utf8data file.

Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
Note that I verified that REGENERATE_UTF8DATA creates a file with
the correct MODULE_DESCRIPTION(), but that file has significantly
different contents than utf8data.c_shipped using the current:
https://www.unicode.org/Public/UNIDATA/UCD.zip
---
 fs/unicode/mkutf8data.c       | 1 +
 fs/unicode/utf8-selftest.c    | 1 +
 fs/unicode/utf8data.c_shipped | 1 +
 3 files changed, 3 insertions(+)

diff --git a/fs/unicode/mkutf8data.c b/fs/unicode/mkutf8data.c
index bc1a7c8b5c8d..77b685db8275 100644
--- a/fs/unicode/mkutf8data.c
+++ b/fs/unicode/mkutf8data.c
@@ -3352,6 +3352,7 @@ static void write_file(void)
 	fprintf(file, "};\n");
 	fprintf(file, "EXPORT_SYMBOL_GPL(utf8_data_table);");
 	fprintf(file, "\n");
+	fprintf(file, "MODULE_DESCRIPTION(\"UTF8 data table\");\n");
 	fprintf(file, "MODULE_LICENSE(\"GPL v2\");\n");
 	fclose(file);
 }
diff --git a/fs/unicode/utf8-selftest.c b/fs/unicode/utf8-selftest.c
index eb2bbdd688d7..f955dfcaba8c 100644
--- a/fs/unicode/utf8-selftest.c
+++ b/fs/unicode/utf8-selftest.c
@@ -307,4 +307,5 @@ module_init(init_test_ucd);
 module_exit(exit_test_ucd);
 
 MODULE_AUTHOR("Gabriel Krisman Bertazi <krisman@collabora.co.uk>");
+MODULE_DESCRIPTION("Kernel module for testing utf-8 support");
 MODULE_LICENSE("GPL");
diff --git a/fs/unicode/utf8data.c_shipped b/fs/unicode/utf8data.c_shipped
index d9b62901aa96..dafa5fed761d 100644
--- a/fs/unicode/utf8data.c_shipped
+++ b/fs/unicode/utf8data.c_shipped
@@ -4120,4 +4120,5 @@ struct utf8data_table utf8_data_table = {
 	.utf8data = utf8data,
 };
 EXPORT_SYMBOL_GPL(utf8_data_table);
+MODULE_DESCRIPTION("UTF8 data table");
 MODULE_LICENSE("GPL v2");

---
base-commit: 07506d1011521a4a0deec1c69721c7405c40049b
change-id: 20240524-md-unicode-48357fb5cd99

Re: [PATCH] unicode: add MODULE_DESCRIPTION() macros

Posted by Gabriel Krisman Bertazi 1 year, 8 months ago

Jeff Johnson <quic_jjohnson@quicinc.com> writes:

> Currently 'make W=1' reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in fs/unicode/utf8data.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in fs/unicode/utf8-selftest.o
>
> Add a MODULE_DESCRIPTION() to utf8-selftest.c and utf8data.c_shipped,
> and update mkutf8data.c to add a MODULE_DESCRIPTION() to any future
> generated utf8data file.
>
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
> ---
> Note that I verified that REGENERATE_UTF8DATA creates a file with
> the correct MODULE_DESCRIPTION(), but that file has significantly
> different contents than utf8data.c_shipped using the current:
> https://www.unicode.org/Public/UNIDATA/UCD.zip

Thanks for reporting this.  I'll investigate and definitely regenerate
the file.

The patch is good, I'll apply it to the unicode code tree
following the fix to the above issue.

> ---
>  fs/unicode/mkutf8data.c       | 1 +
>  fs/unicode/utf8-selftest.c    | 1 +
>  fs/unicode/utf8data.c_shipped | 1 +
>  3 files changed, 3 insertions(+)
>
> diff --git a/fs/unicode/mkutf8data.c b/fs/unicode/mkutf8data.c
> index bc1a7c8b5c8d..77b685db8275 100644
> --- a/fs/unicode/mkutf8data.c
> +++ b/fs/unicode/mkutf8data.c
> @@ -3352,6 +3352,7 @@ static void write_file(void)
>  	fprintf(file, "};\n");
>  	fprintf(file, "EXPORT_SYMBOL_GPL(utf8_data_table);");
>  	fprintf(file, "\n");
> +	fprintf(file, "MODULE_DESCRIPTION(\"UTF8 data table\");\n");
>  	fprintf(file, "MODULE_LICENSE(\"GPL v2\");\n");
>  	fclose(file);
>  }
> diff --git a/fs/unicode/utf8-selftest.c b/fs/unicode/utf8-selftest.c
> index eb2bbdd688d7..f955dfcaba8c 100644
> --- a/fs/unicode/utf8-selftest.c
> +++ b/fs/unicode/utf8-selftest.c
> @@ -307,4 +307,5 @@ module_init(init_test_ucd);
>  module_exit(exit_test_ucd);
>  
>  MODULE_AUTHOR("Gabriel Krisman Bertazi <krisman@collabora.co.uk>");
> +MODULE_DESCRIPTION("Kernel module for testing utf-8 support");
>  MODULE_LICENSE("GPL");
> diff --git a/fs/unicode/utf8data.c_shipped b/fs/unicode/utf8data.c_shipped
> index d9b62901aa96..dafa5fed761d 100644
> --- a/fs/unicode/utf8data.c_shipped
> +++ b/fs/unicode/utf8data.c_shipped
> @@ -4120,4 +4120,5 @@ struct utf8data_table utf8_data_table = {
>  	.utf8data = utf8data,
>  };
>  EXPORT_SYMBOL_GPL(utf8_data_table);
> +MODULE_DESCRIPTION("UTF8 data table");
>  MODULE_LICENSE("GPL v2");
>
> ---
> base-commit: 07506d1011521a4a0deec1c69721c7405c40049b
> change-id: 20240524-md-unicode-48357fb5cd99
>

-- 
Gabriel Krisman Bertazi

Re: [PATCH] unicode: add MODULE_DESCRIPTION() macros

Posted by Gabriel Krisman Bertazi 1 year, 7 months ago

> Jeff Johnson <quic_jjohnson@quicinc.com> writes:
>
>> Currently 'make W=1' reports:
>> WARNING: modpost: missing MODULE_DESCRIPTION() in fs/unicode/utf8data.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in fs/unicode/utf8-selftest.o
>>
>> Add a MODULE_DESCRIPTION() to utf8-selftest.c and utf8data.c_shipped,
>> and update mkutf8data.c to add a MODULE_DESCRIPTION() to any future
>> generated utf8data file.
>>
>> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
>> ---
>> Note that I verified that REGENERATE_UTF8DATA creates a file with
>> the correct MODULE_DESCRIPTION(), but that file has significantly
>> different contents than utf8data.c_shipped using the current:
>> https://www.unicode.org/Public/UNIDATA/UCD.zip
>
> Thanks for reporting this.  I'll investigate and definitely regenerate
> the file.

Now that I investigated it, I realized there is perhaps a
misunderstanding and not an issue. I just tried regenerating utf8data.c
and the file is byte-per-byte equal utf8data_shipped.c, so all is
good.

Considering the link you posted, I suspect you used the latest
unicode version and not version 12.1, which we support.  So there is no
surprise the files won't match.

> The patch is good, I'll apply it to the unicode code tree
> following the fix to the above issue.

Applied!

ty,

-- 
Gabriel Krisman Bertazi

Re: [PATCH] unicode: add MODULE_DESCRIPTION() macros

Posted by Jeff Johnson 1 year, 6 months ago

On 6/20/2024 4:41 PM, Gabriel Krisman Bertazi wrote:
> 
>> Jeff Johnson <quic_jjohnson@quicinc.com> writes:
>>
>>> Currently 'make W=1' reports:
>>> WARNING: modpost: missing MODULE_DESCRIPTION() in fs/unicode/utf8data.o
>>> WARNING: modpost: missing MODULE_DESCRIPTION() in fs/unicode/utf8-selftest.o
>>>
>>> Add a MODULE_DESCRIPTION() to utf8-selftest.c and utf8data.c_shipped,
>>> and update mkutf8data.c to add a MODULE_DESCRIPTION() to any future
>>> generated utf8data file.
>>>
>>> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
>>> ---
>>> Note that I verified that REGENERATE_UTF8DATA creates a file with
>>> the correct MODULE_DESCRIPTION(), but that file has significantly
>>> different contents than utf8data.c_shipped using the current:
>>> https://www.unicode.org/Public/UNIDATA/UCD.zip
>>
>> Thanks for reporting this.  I'll investigate and definitely regenerate
>> the file.
> 
> Now that I investigated it, I realized there is perhaps a
> misunderstanding and not an issue. I just tried regenerating utf8data.c
> and the file is byte-per-byte equal utf8data_shipped.c, so all is
> good.
> 
> Considering the link you posted, I suspect you used the latest
> unicode version and not version 12.1, which we support.  So there is no
> surprise the files won't match.
> 
>> The patch is good, I'll apply it to the unicode code tree
>> following the fix to the above issue.
> 
> Applied!
> 
> ty,
> 

Hi,
I see this landed in linux-next, but is not currently in Linus' tree for 6.11.
Will you be able to have this pulled during the merge window?
I'm trying to eradicate all of these warnings before 6.11 rc-final.

Thanks!
/jeff

Re: [PATCH] unicode: add MODULE_DESCRIPTION() macros

Posted by Jeff Johnson 1 year, 7 months ago

On 6/20/2024 4:41 PM, Gabriel Krisman Bertazi wrote:
> 
>> Jeff Johnson <quic_jjohnson@quicinc.com> writes:
>>
>>> Currently 'make W=1' reports:
>>> WARNING: modpost: missing MODULE_DESCRIPTION() in fs/unicode/utf8data.o
>>> WARNING: modpost: missing MODULE_DESCRIPTION() in fs/unicode/utf8-selftest.o
>>>
>>> Add a MODULE_DESCRIPTION() to utf8-selftest.c and utf8data.c_shipped,
>>> and update mkutf8data.c to add a MODULE_DESCRIPTION() to any future
>>> generated utf8data file.
>>>
>>> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
>>> ---
>>> Note that I verified that REGENERATE_UTF8DATA creates a file with
>>> the correct MODULE_DESCRIPTION(), but that file has significantly
>>> different contents than utf8data.c_shipped using the current:
>>> https://www.unicode.org/Public/UNIDATA/UCD.zip
>>
>> Thanks for reporting this.  I'll investigate and definitely regenerate
>> the file.
> 
> Now that I investigated it, I realized there is perhaps a
> misunderstanding and not an issue. I just tried regenerating utf8data.c
> and the file is byte-per-byte equal utf8data_shipped.c, so all is
> good.
> 
> Considering the link you posted, I suspect you used the latest
> unicode version and not version 12.1, which we support.  So there is no
> surprise the files won't match.
> 
>> The patch is good, I'll apply it to the unicode code tree
>> following the fix to the above issue.
> 
> Applied!
> 
> ty,
> 
yes, I was using current data.
thanks for taking the patch -- two more files to color green in my spreadsheet :)