From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-wr1-f46.google.com (mail-wr1-f46.google.com [209.85.221.46]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 4E12A388E76 for ; Thu, 8 Oct 2026 16:12:10 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.46 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1791475932; cv=none; b=IkmIrucIARwCqz8Cv8tG/mIkqXlz21+BcWhpPdG/f36oUzKNOH0/tSrRJuvL0qrOyHn7oWoWMsJKwiTjsurovQ0UJkUIZB0JkebmJXmihamm8T+9bEOXC2pbKzvQICr2lAGKxeZgq4fK43xpcR2HKMfRDsJeIlMh2FUcYwAcKlg= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1791475932; c=relaxed/simple; bh=BI0G7qBpI/7KwQFAhmOUXBzLsg9VZTTr2gCpFXZLAhc=; h=Date:From:To:Cc:Subject:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=nnqNu1a81jgtOz1MV9+GuxeYMfMBjYXWVHiFguFnVp6fHWSYioSDZ3EztENVjVFA2O7rg9+0evGFeCrUTvmuZG0HyrlZbk+ty5MKyE0O0gBEzdm8tOUv1l2g+2LC5GrnYXWHheB9GA/B04racuZCMD8s6loYAfOmMXYJ0IqtaGU= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=cBV3HFqz; arc=none smtp.client-ip=209.85.221.46 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="cBV3HFqz" Received: by mail-wr1-f46.google.com with SMTP id ffacd0b85a97d-48c411d6615so2256874f8f.3 for ; Thu, 08 Oct 2026 09:12:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20251104; t=1791475929; x=1792080729; darn=vger.kernel.org; h=content-transfer-encoding:content-type:mime-version:references :in-reply-to:message-id:subject:cc:to:from:date:from:to:cc:subject :date:message-id:reply-to:content-type; bh=IGTDk2M1CVr9/HPRZF14PhrI+tmF1KcbANTHbSO6d8s=; b=cBV3HFqzzOWW6/3mIA5IUdq0aM9r9hZqea0qp+sbS+quwYPN03Xl2tEzFF1fM72QhI /MZxGKXKbaBRh7XSSAEQfpK/r4I6uy2cIeljH9/LKXLwHoT+AvHZLRE4uvH4TSA70Df1 xMa4MTwSXFIG6huQ31xlXGdhSIItoM1l9uQ+LTTqybNAURHWE7gP72MfEQXopxrCXrA/ L9gjISpur6L/aZR2K/SIiuuWCC1YMR/J/aaQ5lkVlLZBUTCBfNJGMCzIZwaoA2MbFHa9 sAWSyoUQbs1dkFjbDjGrlKLdI8gKE+FCl1emLGi4fG7+MByYp3V8EXvQ1nnU8PsYIcHZ 6vww== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20260707; t=1791475929; x=1792080729; h=content-transfer-encoding:content-type:mime-version:references :in-reply-to:message-id:subject:cc:to:from:date:x-gm-gg :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to :content-type; bh=IGTDk2M1CVr9/HPRZF14PhrI+tmF1KcbANTHbSO6d8s=; b=0u4AqVVJ/joW4IIrKMxcz3AZuGgcofkqvwajgsYU/d9N7p9xHaxjRYgUoGkyrBDc2C w6bz7EgIbQNEYtuxKFObfjY7dwF3uHLN8hC7P9vVX8m19QUmaoC2wz1XMNgmNlievEPo IVkSAQq5exHy6wspp8zjKPf0u2iF70xIXGHR3klMjVVokIWJ5FVRK6wgAB51WTv1Vmjp JkyZemkMCzhWIlPnRxjVyaU4UvujyUYCHosSWj7mdH4wAI31munpmtFMOHTqJpx+GA74 yrkEugfOZwIKNf2gb1+HcpJPKCDUMqD7UrJxDbW6lmV2fXGomLdtuGDRD/8XzXrYHCHd UmkA== X-Forwarded-Encrypted: i=1; AKwUvByoNp5tmR3zyF+3jPvoIXXayJzJxbQclPUtt3q9mLtDBHs/62OXVzA+Eep5hxbISVEtJRAKNMv2un8=@vger.kernel.org X-Gm-Message-State: AFq9FYIBLojOzTYbG8SfS0cEvwgMH1vP0V7MFOiQbm67FaxB2xu12qR5 J7AS8ZPHT/EkfeF7asP6ubOCPyBhTsjhh3vkogMd7DfK3bV84TrZ5RrL X-Gm-Gg: AYBFou1fmyEqhGpOkr3/tPMKrxAGjbsAugjTPxB9lyr8VWTI3p3b38Rhm7oE5FSF0Jj x2/A5Ay2RbefYlcptwRzs7f5huTbL017Zc43WEPswytOdhQv7kQbOUhIYTJnChyLt77tHJ+NovD i+TQclJrYPas8hAINA8TARFeK1n+K3+UTQBYUOO0fTPxKnXYivJu0VoShvy3e4JDF9SOnZv2GT4 5/W/6rW8BbhYiqUlLjTL119HmpyYvq+wmtyhLxJU9jWkdTfiRb+KuJ4TLZpCkB/guG9/cQEBKGR sO7d07bkAfr/28hodBcDpVgW0BA8fCr/So6+fMdxJHV5ZgTwEzhXUDRwrqaPYx2qrVeo65AJ29z Emh12xsk5SCY9ArJ5QRKfAA8H+Z/AASpg322u+WIndKZMV5qxJnnkxDp8EAN0DoCrZOWSAwhuIj I3f+DiBpfV8WAwNat8SHvYbB917cNgEDyc1C8HTGF6cIz50c/mWf9jx7KSJdEthhZBRzpt0++Em L12fe6nH0iQuphjuzCuH1gILpDBmKv0d0nI9m3VtQ4+CA== X-Received: by 2002:a05:6000:25fb:b0:48c:77ad:d52d with SMTP id ffacd0b85a97d-48c77add59dmr9194549f8f.43.1791475929174; Thu, 08 Oct 2026 09:12:09 -0700 (PDT) Received: from pumpkin (82-69-66-36.dsl.in-addr.zen.co.uk. [82.69.66.36]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-48db650fd4bsm478599f8f.11.2026.10.08.09.12.06 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 08 Oct 2026 09:12:07 -0700 (PDT) Date: Thu, 8 Oct 2026 17:12:05 +0100 From: David Laight To: "Serge E. Hallyn" 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: <20261008171205.7239c463@pumpkin> In-Reply-To: References: <20261008084956.2911790-1-sashal@kernel.org> <20261008084956.2911790-6-sashal@kernel.org> X-Mailer: Claws Mail 4.1.1 (GTK 3.24.38; arm-unknown-linux-gnueabihf) Precedence: bulk X-Mailing-List: workflows@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit 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 > > > ~Gregory