From nobody Fri Apr 3 04:52:59 2026 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 46E711A6800 for ; Fri, 20 Mar 2026 10:42:48 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1774003368; cv=none; b=gMsDwVZlqzvUClmk7FNqhILRe2vBQjJUUuji5HW2Xeg9DlClKm6Zc09ykXDsbnNNvqAGhIcjSbpDcbdOqgTS82f8oaniFmL3R0iwlNclhUXiH5uWt7oOsA/C+dhkh06ytUxwkq7/H7ZHsbLVMN+A2y74T0yOzvNVsdkLruNw32c= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1774003368; c=relaxed/simple; bh=YfQvAsk39Rv1zSpCATJe5i85nKQcVHUgMl8uGowTpMI=; h=Date:From:To:Cc:Subject:Message-ID:MIME-Version:Content-Type: Content-Disposition; b=pruS9C9rSYkSUnHN4G9pDTS3esx4XJFXHgU0FFxGDibX+stoZZwTTHWejkjJDUSOBTyUWrApMzU7ZFIEGJpgv/i3jZnbxdTtu3bctu0h17vDRb1XHYo6EvHw7XIyItjYuXqo/8Abnv/VsUQpSld6WfUqwhk8aLAzk+3ny18ihpQ= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=KqY8enxD; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="KqY8enxD" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 04CB6C4CEF7; Fri, 20 Mar 2026 10:42:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1774003368; bh=YfQvAsk39Rv1zSpCATJe5i85nKQcVHUgMl8uGowTpMI=; h=Date:From:To:Cc:Subject:Reply-To:From; b=KqY8enxDSh3apgKBYrE/TQWnflgHlEObVZFdLYYBKL34agz/fHSJDmjhLa5x3/cZh qUDZf/FPQJJJDH9tMK7sH1VejJBFlK553nFJuMpnve0+QcAsVs5BfFvu4MDlnvxffM bw9FjmniZU5cdNi/bYXdLptif0jke3fgNbNZzCdjzgl1QsYCf3Lx/diVFJY+vAuiUE KknXVPSjPVRgE6GlqUZJ4qYvLSpaXXj0i+dfyS46pedTLoyYh2VYr3DyRQE0klb9G3 mF+cKAsn+JulTpklKyfp2KS1/upPthv/eShLv+eSCgCCkKSfW02X62OoLTnsxasVSz 6G0Ng16Hqa0GA== Received: by paulmck-ThinkPad-P17-Gen-1.home (Postfix, from userid 1000) id 9FDC6CE0CAC; Fri, 20 Mar 2026 03:42:45 -0700 (PDT) Date: Fri, 20 Mar 2026 03:42:45 -0700 From: "Paul E. McKenney" To: Sebastian Andrzej Siewior , Thomas =?iso-8859-1?Q?Wei=DFschuh?= Cc: linux-kernel@vger.kernel.org Subject: [PATCH] stop_machine: Fix the documentation for a NULL cpus argument Message-ID: <3ce69830-4959-4e70-8a7f-1742917fb7f3@paulmck-laptop> Reply-To: paulmck@kernel.org Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" [ For the v7.1 merge window. ] A recent refactoring of the kernel-docs for stop machine changed the description of the cpus parameter from "NULL =3D any online cpu" to "NULL =3D run on each online CPU". However the callback is only executed on a single CPU, not all of them. The old wording was a bit ambiguous and could have been read both ways. Reword the documentation to be correct again and hopefully also clearer. Fixes: fc6f89dc7078 ("stop_machine: Improve kernel-doc function-header comm= ents") Signed-off-by: Thomas Wei=C3=9Fschuh Signed-off-by: Paul E. McKenney Reviewed-by: Sebastian Andrzej Siewior diff --git a/include/linux/stop_machine.h b/include/linux/stop_machine.h index 72820503514cc..01011113d2263 100644 --- a/include/linux/stop_machine.h +++ b/include/linux/stop_machine.h @@ -99,7 +99,7 @@ static inline void print_stop_info(const char *log_lvl, s= truct task_struct *task * stop_machine: freeze the machine on all CPUs and run this function * @fn: the function to run * @data: the data ptr to pass to @fn() - * @cpus: the cpus to run @fn() on (NULL =3D run on each online CPU) + * @cpus: the cpus to run @fn() on (NULL =3D one unspecified online CPU) * * Description: This causes a thread to be scheduled on every CPU, which * will run with interrupts disabled. Each CPU specified by @cpus will @@ -133,7 +133,7 @@ int stop_machine(cpu_stop_fn_t fn, void *data, const st= ruct cpumask *cpus); * stop_machine_cpuslocked: freeze the machine on all CPUs and run this fu= nction * @fn: the function to run * @data: the data ptr to pass to @fn() - * @cpus: the cpus to run @fn() on (NULL =3D run on each online CPU) + * @cpus: the cpus to run @fn() on (NULL =3D one unspecified online CPU) * * Same as above. Avoids nested calls to cpus_read_lock(). *