From patchwork Mon Jul 24 19:58:00 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Corbet X-Patchwork-Id: 108597 Delivered-To: patch@linaro.org Received: by 10.182.45.195 with SMTP id p3csp4218180obm; Mon, 24 Jul 2017 12:58:11 -0700 (PDT) X-Received: by 10.84.211.44 with SMTP id b41mr13815883pli.444.1500926291784; Mon, 24 Jul 2017 12:58:11 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1500926291; cv=none; d=google.com; s=arc-20160816; b=og77mxaVWKc78JTjj/E3dEirayUetRZigTPlQefyAW4k00Usx9PhmprwxlV6QfflNx 7XCsg9eVWwtZ8IfeyV/OZ3jVnBh+cFKFoB6Nz++tmRR7O73ptqmqft+2mbbZJPatzSff DtO57FtJO2rpBeSvawqGf+r+gS61Sd8i5S5LCELRWsQkMYNT8lW28A0dlXKkyxngSMLV 3JQcZsZEK+CKmrsUEOi/mKvJxSHKqiptW8pdpMaFLaLhu5eJ/hsAY7RDgdXXd4/D5H0i 4vys2XJUq9fl7GkUbekCAoG6M/wnm2JpPSTwrB11LGt4gRHfq8lCpUqiVJJ0OvSmiQNC Zgvw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :organization:message-id:subject:cc:to:from:date :arc-authentication-results; bh=VhrNMKz651soko7OPqDDITFNUlyoeGBxY3wsCcYPj60=; b=1BmmiCLV/WFpmMr5vK7+L0skHSZkNfLZQeP1ebRBiHicLEjaf011zIuDqF0UJo6tRa oYaZq8TSrgDkmJ+gPmHY8atHxSXIaYJF2oW4QpH6T9KVHQeXgcp4j125wzjZT/be4gpL 3n7spf6MEP01YDjVxdsqDzq/B9sr6OOnElgMo2ozds75i3IX03ZklIQNh71hoeLO30Da s2LsuG0JPgndqu3fCmoioxjeFJ13ImQCZ96IEYia2RifIOKkRbIESChTglYGcA0JYW7L ezLLnZhIdZVC0epEg65sArqWQRx8+Ege39ZczXEAEKMionbItjN0mdSUx28LiPaMA+iI l7OA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id z62si7064585pfk.443.2017.07.24.12.58.11; Mon, 24 Jul 2017 12:58:11 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752359AbdGXT6J (ORCPT + 26 others); Mon, 24 Jul 2017 15:58:09 -0400 Received: from ms.lwn.net ([45.79.88.28]:38564 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751729AbdGXT6B (ORCPT ); Mon, 24 Jul 2017 15:58:01 -0400 Received: from localhost.localdomain (localhost [127.0.0.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id 45F442CF; Mon, 24 Jul 2017 19:58:01 +0000 (UTC) Date: Mon, 24 Jul 2017 13:58:00 -0600 From: Jonathan Corbet To: Ingo Molnar , Peter Zijlstra Cc: LKML , linux-doc@vger.kernel.org Subject: [PATCH] sched/wait: Clean up some documentation warnings Message-ID: <20170724135800.769c4042@lwn.net> Organization: LWN.net X-Mailer: Claws Mail 3.14.1 (GTK+ 2.24.31; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org A couple of kerneldoc comments in had incorrect names for macro parameters, with this unsightly result: ./include/linux/wait.h:555: warning: No description found for parameter 'wq' ./include/linux/wait.h:555: warning: Excess function parameter 'wq_head' description in 'wait_event_interruptible_hrtimeout' ./include/linux/wait.h:759: warning: No description found for parameter 'wq_head' ./include/linux/wait.h:759: warning: Excess function parameter 'wq' description in 'wait_event_killable' Correct the comments and kill the warnings. Signed-off-by: Jonathan Corbet --- include/linux/wait.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) -- 2.9.4 diff --git a/include/linux/wait.h b/include/linux/wait.h index b289c96151ee..5b74e36c0ca8 100644 --- a/include/linux/wait.h +++ b/include/linux/wait.h @@ -529,13 +529,13 @@ do { \ /** * wait_event_interruptible_hrtimeout - sleep until a condition gets true or a timeout elapses - * @wq_head: the waitqueue to wait on + * @wq: the waitqueue to wait on * @condition: a C expression for the event to wait for * @timeout: timeout, as a ktime_t * * The process is put to sleep (TASK_INTERRUPTIBLE) until the * @condition evaluates to true or a signal is received. - * The @condition is checked each time the waitqueue @wq_head is woken up. + * The @condition is checked each time the waitqueue @wq is woken up. * * wake_up() has to be called after changing any variable that could * change the result of the wait condition. @@ -735,12 +735,12 @@ extern int do_wait_intr_irq(wait_queue_head_t *, wait_queue_entry_t *); /** * wait_event_killable - sleep until a condition gets true - * @wq: the waitqueue to wait on + * @wq_head: the waitqueue to wait on * @condition: a C expression for the event to wait for * * The process is put to sleep (TASK_KILLABLE) until the * @condition evaluates to true or a signal is received. - * The @condition is checked each time the waitqueue @wq is woken up. + * The @condition is checked each time the waitqueue @wq_head is woken up. * * wake_up() has to be called after changing any variable that could * change the result of the wait condition.