Received: by 2002:a05:6a10:f347:0:0:0:0 with SMTP id d7csp1016377pxu; Mon, 23 Nov 2020 09:31:26 -0800 (PST) X-Google-Smtp-Source: ABdhPJyv6gTpZQJ3DVGu1NNCSRuMB5LEfoqTKg3Bb4SO4EPxOSBDc2ZaNFHX+MhFO4vePaGOvLlz X-Received: by 2002:a17:906:23e9:: with SMTP id j9mr628012ejg.344.1606152686163; Mon, 23 Nov 2020 09:31:26 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1606152686; cv=none; d=google.com; s=arc-20160816; b=B8wrvlFZggsEpTBJg5sUS//KtmjoeVLyRAC4ig5EXpOf35BXgnafOFLpp2woPPO1An gYYFljzzK68gcqE2UsPtnnxKqVITaQY0OMvVHIVzUSlrChH56OqoJj9XyKCbyppgu2i5 gx2k2aSAkKvNNcu1wyNi9q2WC7u5cCoJyJssOWzOLlac32DWot8dfHRqBsSFNbD4B7r/ 6P+8ntR1kY6VdbOO19zzt32KhYgu78cejRtQQe/mxKyn61rrMQBtFDggbHswGzjoJ7JD rkYktgIiyhe4cChSvoFbZgqzTT8wbcv+mOh6jvKgykct4YPRbF98+cOJ6Dc3+Oj+6OjL 1Vkw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:cc:to:subject:message-id:date:from:in-reply-to :references:mime-version; bh=74gAAKrXGHCOv5Lu8fi+qsQUyGkmNSPiGNb1uC5KwBU=; b=MjOKo3H3ybCfXFcIk6HEX5hKFscJlPOgMJtzpnjplXTl2lENx4qDWtADcVpWy1Si8B VhJQDqVxaGDy11KOju7RYg0EDtOC7IGHUFioXcne1pHA2/v1KhtRkkjlPAwgfyH6WbOR xoQ9CXzCh/Dp+uw3S42c0xI2R5JPhDFDrddro1ieg6ELNfLU1R8U/qQBP0GLy9O6TBY8 mq7tVbG+O6CWwF3YkN5YFI2rK2Smzd/NVdjvHMr1aMNZQb+ed4IVXZCG62WK6cY7xzbm 5FMNKgDA6uAoKOqPwhoPNdtUG5HwBEo32Vg8BaGWruejwgu0XKQhwY3aAX95ocPBBYbJ 3T7g== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id o3si6688728ejn.637.2020.11.23.09.31.02; Mon, 23 Nov 2020 09:31:26 -0800 (PST) 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; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2387642AbgKWR0s (ORCPT + 99 others); Mon, 23 Nov 2020 12:26:48 -0500 Received: from mail-oo1-f67.google.com ([209.85.161.67]:41791 "EHLO mail-oo1-f67.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1733189AbgKWR0s (ORCPT ); Mon, 23 Nov 2020 12:26:48 -0500 Received: by mail-oo1-f67.google.com with SMTP id o20so1442670oor.8; Mon, 23 Nov 2020 09:26:47 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=74gAAKrXGHCOv5Lu8fi+qsQUyGkmNSPiGNb1uC5KwBU=; b=eHUW5Lbq9b+qc+zWwfFWsOJywPXc7GS0Fr5k47oweBLIapTMEishqwdJ1VS5S8ZT34 aStD1/3m6k+6NKqw9pp+kGN7HTfKHvzbEvrLkIv2EE7zREWbeEbXnFpi08PWag2Ux/u4 FjeAz6OOSy2ENN2EoiVIT9zkFRhLibL6P+hlHD35WCnSSU7TdyEf0P0XR0+iHLy9buac 85qdaRwJ3kBnZiPvNjxai4yc2nSf39U9Px9qYl6yHcRZFSpf3qQrg7GrPEFWOmO33bV+ 8GNt1MjSmMDGh0XYIyrIBaRXSX5jJceO8obW6SmosRjxs7EM6oWXQzcZib8U4aG+FdxF waIA== X-Gm-Message-State: AOAM5330/wekNIKIiMtaVbLrfM/vp77aSiqSBLxFmXdEf6bydRdjwSpb OkG7Ijm1BnvCVtA/QCHvfHopu2zvMCFUSsUS0K7i7u8pU6Y= X-Received: by 2002:a4a:bb07:: with SMTP id f7mr306250oop.44.1606152407187; Mon, 23 Nov 2020 09:26:47 -0800 (PST) MIME-Version: 1.0 References: <1605257895-5536-1-git-send-email-alex.shi@linux.alibaba.com> In-Reply-To: <1605257895-5536-1-git-send-email-alex.shi@linux.alibaba.com> From: "Rafael J. Wysocki" Date: Mon, 23 Nov 2020 18:26:36 +0100 Message-ID: Subject: Re: [PATCH] PM / suspend: fix kernel-doc markup To: Alex Shi Cc: "Rafael J. Wysocki" , Len Brown , Pavel Machek , Linux PM , Linux Kernel Mailing List Content-Type: text/plain; charset="UTF-8" Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Fri, Nov 13, 2020 at 9:58 AM Alex Shi wrote: > > Add parameter explanation to fix kernel-doc marks: > > kernel/power/suspend.c:233: warning: Function parameter or member > 'state' not described in 'suspend_valid_only_mem' > kernel/power/suspend.c:344: warning: Function parameter or member > 'state' not described in 'suspend_prepare' > > Signed-off-by: Alex Shi > Cc: "Rafael J. Wysocki" > Cc: Len Brown > Cc: Pavel Machek > Cc: linux-pm@vger.kernel.org > Cc: linux-kernel@vger.kernel.org > --- > kernel/power/suspend.c | 2 ++ > 1 file changed, 2 insertions(+) > > diff --git a/kernel/power/suspend.c b/kernel/power/suspend.c > index 32391acc806b..502d86ed99c7 100644 > --- a/kernel/power/suspend.c > +++ b/kernel/power/suspend.c > @@ -224,6 +224,7 @@ EXPORT_SYMBOL_GPL(suspend_set_ops); > > /** > * suspend_valid_only_mem - Generic memory-only valid callback. > + * @state: Suspend state to be set > * > * Platform drivers that implement mem suspend only and only need to check for > * that in their .valid() callback can use this instead of rolling their own > @@ -335,6 +336,7 @@ static int suspend_test(int level) > > /** > * suspend_prepare - Prepare for entering system sleep state. > + * @state: suspend state which sleep from > * > * Common code run for every system sleep state that can be entered (except for > * hibernation). Run suspend notifiers, allocate the "suspend" console and > -- Applied as 5.11 material, but I've changed the originally proposed parameter descriptions into "Target system sleep state" in both cases. Thanks!