From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-wr1-f41.google.com (mail-wr1-f41.google.com [209.85.221.41]) (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 1466238911B for ; Thu, 8 Oct 2026 16:12:10 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.221.41 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1791475932; cv=none; b=RrZ9J7kdrvJMuN3HX1oKoeKYHJBo8KnkD2HC6nKTMLfSbDmmSfZ9wkaw+qQgnLjEL5x3pbm6z7hEvx44R36o6S6Yb9dgueJ8ik5ztwLdioeMZn1iMVG4bIunpH8+kQjjRa9HHvU2T8R714OuOCfez2+xPhsQcknkBlc7thYvdu4= 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.41 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-f41.google.com with SMTP id ffacd0b85a97d-486e8faff03so1772493f8f.1 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=focleYCU3H7ngzrc+hsRSLOOGygGIiM2XYDRPiov3K4cqFhP4g5P8SS9UC5RLnB0ac 63PTMxzluAx3SwImSYivV91C8rtkYDLO1u3jHj4lJkvF5k+bL2IPhl5J1tmMixGbTTac QzFmIXURZsb89ZrAfgu8maM2jLh+HilAjQ0GEBvrWRCS4N2NR8ulS0W1DxwtKbgh7Usm U0AFuToGGg4u30r2M2DrqLjfKS3FGzoYxltb+MdlTp+W1KKMyQUgoGsa9Nb+1fSsTfkH XpNiChlIjt/ItRN6k7rJRmr6tDwmpsBSmTGr3bmj/aOtmDbBNigzwbegP5tMeD4T+uO9 T/HQ== X-Forwarded-Encrypted: i=1; AKwUvBxYqQhiDu+xudn2tHYARUFykvfZQyzy4KcK5RUVzfJWxmwbkBA/uiVkFv5y7txkNNY09D5x1oIseVA0gJA=@vger.kernel.org X-Gm-Message-State: AFq9FYIDc9B2xzEGR2KAbqG6WVZ1RJymO7Bvn4hJE4PWokpSqq8xb4Vc ifCVtFRGHPim3WjLXGLRHyhGAsk7MVzJIyiKEVDaq57gg4u1J8TjgPlD X-Gm-Gg: AYBFou3MbMefERbtdKV5bs5VlGqDamOmHDHv/xCkfMZyYn0eIGr7Pa6MVYz7CjAvqYs idEz7lSuQ702uakgRqDvFmLHToVMeQxZELWijLovdMBKslW4Z8y63KKQBav5aBJFjzboTKTowcZ 0x6bnTzz3d3XZze/EpyugYNbSiHpew0YPgcQLgRh//pcJOIk2bhVerMz0nXlp5jFatV9jjTtZm4 Vx/hBYsm1KWh7qQ0GIAsSLtrdY2eApfqjM5+g1F9b7jjRzEjwjeN2zH1+J6qTtQmotJQrGKE8LX 4fmgaZ8GPom3Y+LWs6fjQgYU+2hFIv6mkzSWWEvFnVKjHqmcdHW5yag6BjHIeWTYRrSyMPhWI1Z 7N+68YAqRcDATwskujEln36yCZ15vxO+0XWvQfzYPzRb7AQO6yz6rdtQg4KZTnvTP5n/8x20QXs rTF8BkqXjjDPaJNEpHm6KCdv3GvhwoGvLomMNJZajcLZf0t/ndLO0ESOJWDue/26FjW3JrcBi21 FKuvlXolVzcJ8wbOHI1OCZnKpaRLdExGNefrBqrt9R4MQ== 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: linux-kbuild@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