Received-SPF: pass (google.com: domain of linux-kernel+bounces-191399-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
From: Gabriel Krisman Bertazi <gabriel@krisman.be>
To: Jeff Johnson <quic_jjohnson@quicinc.com>
Cc: Gabriel Krisman Bertazi <krisman@kernel.org>,
  <linux-fsdevel@vger.kernel.org>,  <linux-kernel@vger.kernel.org>,
  <kernel-janitors@vger.kernel.org>
Subject: Re: [PATCH] unicode: add MODULE_DESCRIPTION() macros
In-Reply-To: <20240524-md-unicode-v1-1-e2727ce8574d@quicinc.com> (Jeff
	Johnson's message of "Fri, 24 May 2024 11:48:09 -0700")
References: <20240524-md-unicode-v1-1-e2727ce8574d@quicinc.com>
Date: Mon, 27 May 2024 16:40:47 -0400
Message-ID: <87y17vng34.fsf@mailhost.krisman.be>
User-Agent: Gnus/5.13 (Gnus v5.13)
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain

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