From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-alma10-1.taild15c8.ts.net [100.103.45.18]) (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 EF1E538DC7C for ; Thu, 8 Oct 2026 16:16:59 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=pass smtp.client-ip=100.103.45.18 ARC-Seal:i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1791476221; cv=pass; b=aD42YfuWHPeVu55j3MJvW1quqIUItn21sOnaEY9Tjesf2WaOUk3Rw4ymx39lLz0LEaG+AxSd73nokLtmmbTy7BgTDuty+P7L5w53ZF3iuXdzM5sDA/d22S083GJchhvvO10sCRyTW6KiwXPgB6QZo0QYc6C/4j8IJWT/A6S4HeM= ARC-Message-Signature:i=2; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1791476221; c=relaxed/simple; bh=ONUAXTXET2uph2ufarl0JR+mBNLNazRrkGyxBpG9j4Q=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=P/75ZN4Xl4GMjEmtVGDoNkABR71HH2LnuozfYXgjQCIAAaHNEZaTE4HUP/eJVac6wcdBZsvcW5Mz7lyNxnp26v5zVtt4mkkBu7AwKf7BXBBGxoSrFCi/DwaFCXR1Ztj+hCIFSgK8saqSJOk92nGasYMPsHjCBvDTHqpt8ct7pCc= ARC-Authentication-Results:i=2; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=hallyn.com header.i=@hallyn.com header.b=Yc2Uacvw; arc=pass smtp.client-ip=100.103.45.18 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=hallyn.com header.i=@hallyn.com header.b="Yc2Uacvw" Received: by smtp.kernel.org (Postfix) id 9501B1F008A0; Thu, 8 Oct 2026 16:16:59 +0000 (UTC) Authentication-Results: smtp.kernel.org; arc=none smtp.remote-ip=178.63.66.53 ARC-Seal: i=1; d=kernel.org; s=arc20260519; a=rsa-sha256; cv=none; t=1791476219; b=gRTGg+R7EATgZSySTuEomDDKVwoCb8yiJbmYbDjEjnjBhRvqkf63wVEBohPuL6nS+c45 s07YmfKqcEMGdmAOIFwQGroORvHinNMiopfNVObm88foI05uCGY2/S2gaVE5/qHWtxi1o E9F2LWchSOc4PibaPeZ2PDULGOO3ap8KeQjUPUwIqAFwZJvHsGpkvNxi/kYoEJPkrX32G 7WwubcyH1crHJTE1L8CjI1hICaid8LiV7Vxwi4AZs864B1utmiROuifAM70X/Cfdycd61 U5c6peaXAodNgDlyj598mRVi3C5Sf5tgXX8oGa5kg2QH7tHg45/bC0uAZhmFCYQRZmA== ARC-Message-Signature: i=1; d=kernel.org; s=arc20260519; a=rsa-sha256; c=relaxed/relaxed; t=1791476219; h=DMARC-Filter:DKIM-Signature:Received:Date:From:To:Cc:Subject: Message-ID:References:MIME-Version:Content-Type:Content-Disposition: In-Reply-To; bh=Gihn+HihHeTxCKvXiBrQEmxagl0Z3Ut3QsBCRJJyecI=; b=VRVyCLBMQqkNuu7qyua9g3IzMwOxJU7zqyn0TtK1Ikq+KpMNfM8nDcOREOZgkIaOUdrQ hgucqUtDKonXm6zT2RyKDCAK3tgru2+AyngoXFOo5EMR9UNGWIv3vQ1g7VlKAaNEMNd6u 7gZcsZk8LAj86x1HivgIje0r+iR2TgrbeJ6pAIFlVigcV9ClE6t3FtaTjaP9oPe9JoyZn 7DuyMTyEO+uaMpkNROL67yxJAbMj5FHkQHocSPSr42FzLkDTpC4QEEx3UgoGfSIhuUB3E uI+mckLNN7dowbhUgJNbBSLq03NlFxfWRfFGlZ7PvtoAz6HIO3R1MQfWJw7QRjdkGkw== ARC-Authentication-Results: i=1; smtp.kernel.org; dkim=pass header.d=hallyn.com header.i=@hallyn.com header.a=rsa-sha256 header.s=mail header.b=Yc2Uacvw; dmarc=fail header.from=hallyn.com; spf=(null) smtp.mailfrom=hallyn.com; arc=none smtp.remote-ip=178.63.66.53 Received: from mail.hallyn.com (mail.hallyn.com [178.63.66.53]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (prime256v1) server-digest SHA256) (No client certificate requested) by smtp.kernel.org (Postfix) with ESMTPS id 7E0411F000FF; Thu, 8 Oct 2026 16:16:58 +0000 (UTC) Authentication-Results: smtp.kernel.org; dkim=pass (2048-bit key, unprotected) header.d=hallyn.com header.i=@hallyn.com header.a=rsa-sha256 header.s=mail header.b=Yc2Uacvw DMARC-Filter: OpenDMARC Filter v1.4.2 smtp.kernel.org 7E0411F000FF Authentication-Results: smtp.kernel.org; dmarc=fail (p=reject dis=none) header.from=hallyn.com Authentication-Results: smtp.kernel.org; spf=tempfail smtp.mailfrom=hallyn.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=hallyn.com; s=mail; t=1791476206; bh=ONUAXTXET2uph2ufarl0JR+mBNLNazRrkGyxBpG9j4Q=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=Yc2Uacvw/E8IC28sxXYwsgrwszsBc78gC0v31tgczm3TUURjBC6dT9qzn0ggd64gq QjPyeWKyeoRQwZpk4C/p3XxjygiZXH51hK465fbWOKEpvamDUDqilUeF1enE3vwsS1 Sb3ubVNpFDt7bIpFLiuX9kowTVZBYkLd8cmikJkEdmVmY8QY8B6sjBeBaLw91GCKAd /xvJW7ygChmDOhJcjpWbQhdJwFHlyx86JWpoebmCL/3z2VPphM3ZcSwh8pPlQzWLNK sLD/G6HPsB6z9aAZSDnHT8qc+Tj2DioSedN97XYBXA76y/VFIhwxD8J09ObjieTlrP MBNbaoIsETP9w== Received: by mail.hallyn.com (Postfix, from userid 1001) id B5C69E7D; Thu, 8 Oct 2026 11:16:46 -0500 (CDT) Date: Thu, 8 Oct 2026 11:16:46 -0500 From: "Serge E. Hallyn" To: David Laight Cc: Gregory Price , Sasha Levin , linux-api@vger.kernel.org, linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-kbuild@vger.kernel.org, linux-kselftest@vger.kernel.org, workflows@vger.kernel.org, tools@kernel.org, x86@kernel.org, Thomas Gleixner , "Paul E . McKenney" , Greg Kroah-Hartman , Jonathan Corbet , Dmitry Vyukov , Randy Dunlap , Cyril Hrubis , Kees Cook , Jake Edge , Gabriele Paoloni , Mauro Carvalho Chehab , Christian Brauner , Alexander Viro , Andrew Morton , Masahiro Yamada , Shuah Khan , Arnd Bergmann , Nathan Chancellor , Steven Rostedt , Masami Hiramatsu , Mathieu Desnoyers Subject: Re: [PATCH v5 05/11] kernel/api: add API specification for sys_open Message-ID: References: <20261008084956.2911790-1-sashal@kernel.org> <20261008084956.2911790-6-sashal@kernel.org> <20261008171205.7239c463@pumpkin> Precedence: bulk X-Mailing-List: tools@linux.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20261008171205.7239c463@pumpkin> On Thu, Oct 08, 2026 at 05:12:05PM +0100, David Laight wrote: > On Thu, 8 Oct 2026 09:20:01 -0500 > "Serge E. Hallyn" wrote: > > ... > > > > Even if there's just a three line comment above a fn, history proves > > that it will not reliably stay in sync as the fn changes. An automation > > step/check is needed. > > The only way it can possibly stay in step is to have the compiler process > the same source text. > Then, if you add/change a function parameter you'd be pretty much forced > to add/change the comment. > Return values would have to be documented at the C return statement and > really as an extra parameter to the return. > > But, IMHO, the whole thing adds too much bloat to the source files. > When you 'grep' a source file, you don't really want another match in > a big comment at the top of every function. > > David That's why I feel all this info that Sasha has added should go into a Documentation/uapi/ autogenerated directory. Auto-updated on every build, with warnings if the result has changed. -serge