Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20210608025427.2781445-1-libaokun1@huawei.com>
In-Reply-To: <20210608025427.2781445-1-libaokun1@huawei.com>
From:   "Rafael J. Wysocki" <rafael@kernel.org>
Date:   Fri, 11 Jun 2021 18:47:03 +0200
Message-ID: <CAJZ5v0iZwwkKznqxzbkrDK8+gF1todJvg6Yy4DzvZ8enN5khnQ@mail.gmail.com>
Subject: Re: [PATCH -next] x86/power: fix doc warnings in cpu.c
To:     Baokun Li <libaokun1@huawei.com>
Cc:     "Rafael J. Wysocki" <rjw@rjwysocki.net>,
        Pavel Machek <pavel@ucw.cz>,
        Thomas Gleixner <tglx@linutronix.de>,
        Ingo Molnar <mingo@redhat.com>, Borislav Petkov <bp@alien8.de>,
        "the arch/x86 maintainers" <x86@kernel.org>,
        "H. Peter Anvin" <hpa@zytor.com>,
        Linux PM <linux-pm@vger.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
        Wei Yongjun <weiyongjun1@huawei.com>,
        Yue Haibing <yuehaibing@huawei.com>, yangjihong1@huawei.com,
        yu kuai <yukuai3@huawei.com>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Tue, Jun 8, 2021 at 4:45 AM Baokun Li <libaokun1@huawei.com> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
>  arch/x86/power/cpu.c:76: warning: Function parameter or
>   member 'ctxt' not described in '__save_processor_state'
>  arch/x86/power/cpu.c:192: warning: Function parameter or
>   member 'ctxt' not described in '__restore_processor_state'
>
> Signed-off-by: Baokun Li <libaokun1@huawei.com>
> ---
>  arch/x86/power/cpu.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/arch/x86/power/cpu.c b/arch/x86/power/cpu.c
> index 3a070e7cdb8b..2640b9128479 100644
> --- a/arch/x86/power/cpu.c
> +++ b/arch/x86/power/cpu.c
> @@ -60,7 +60,7 @@ static void msr_restore_context(struct saved_context *ctxt)
>  /**
>   *     __save_processor_state - save CPU registers before creating a
>   *             hibernation image and before restoring the memory state from it
> - *     @ctxt - structure to store the registers contents in
> + *     @ctxt: structure to store the registers contents in

Any chance to fix the formatting of this kerneldoc comment too in this patch?

>   *
>   *     NOTE: If there is a CPU register the modification of which by the
>   *     boot kernel (ie. the kernel used for loading the hibernation image)
> @@ -183,7 +183,7 @@ static void fix_processor_context(void)
>  /**
>   * __restore_processor_state - restore the contents of CPU registers saved
>   *                             by __save_processor_state()
> - * @ctxt - structure to load the registers contents from
> + * @ctxt: structure to load the registers contents from
>   *
>   * The asm code that gets us here will have restored a usable GDT, although
>   * it will be pointing to the wrong alias.
> --
> 2.31.1
>