From patchwork Tue Oct 10 10:12:40 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Max Kellermann X-Patchwork-Id: 150641 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:612c:2908:b0:403:3b70:6f57 with SMTP id ib8csp87026vqb; Tue, 10 Oct 2023 03:13:09 -0700 (PDT) X-Google-Smtp-Source: AGHT+IFHUTe7iKYZNWpZqJTOcc4Ai2sXbhVtphwEpmqE2U5Z2v5B9qoaPJJew4Pdg9QwuJ+ekHJf X-Received: by 2002:a05:6808:b:b0:3a9:9bb6:811 with SMTP id u11-20020a056808000b00b003a99bb60811mr17929031oic.57.1696932788769; Tue, 10 Oct 2023 03:13:08 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1696932788; cv=none; d=google.com; s=arc-20160816; b=l56ftSGTpTK1oYBoN75ycrCh27Y3dGOiMWoRCArS1EFGN1QUbC02bzVh4aV9+FlBis M1h99p0dYgGv4CX5WYgI8s81C3p4R+DSOsRWDeyaHZ4dlI9tJL0VpoxjiwdTiHvbKTxw ksOIKEewkuWriVtX+ucHyWt7cYZysPhG5oY7beffvrV3ajLqcbMPuFHDPaolK98DproP FgZxZCZNmhYqqtKNkMO8nT0YvFBcEhgW4+IBD5TNsr2bpeWg/uvBl1yUVnOabBEBn4EN NPFNLyiuYDS6v3pXaILEjR1eMsvfhxkjUa3lZ2Z1ZY/NB0vsEzLNOzgZ6hYeZ1vufKjs Uolw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=teYJaujWBCZMTxCLTD+iOO+xzJ4IWgTIsHFi/8ohCow=; fh=GpP8dusKvxeOi4AYyA9hCEMiPEh7InvT1FP9bta97gk=; b=JMg3BHw5xutcwVqXKk2+6vVo+vDCyqtattaTK7bKWf4laj0Vi15PqFPa1Romdx1Hmh QU0RF/THQRw6ovyDEiNwmYdbldpRHlbKvti5uEhJnexEZL49TTbuUT+WbQ3tuzeHqTOT S8xfNj1OoVk9MIv6X4rHJ++VpZ46O68+O6oZj4pM8rn2UusK1wH0SDeCsnmrorILlWq7 Lrm30zRFpZEkzY3zDbG394Zla1dIeEeq9KXPstdg5Xt/BeJAtmkrq0jmj4d15Qr1GF7c SMVrXTqM2G99CA49vSCQ+gkmOlI90+tKj6Wk0aPoQizd+49nnmST3W1Aao26lqnhnTFa ZTrw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@ionos.com header.s=google header.b=RYELOLeF; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:2 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=ionos.com Received: from agentk.vger.email (agentk.vger.email. [2620:137:e000::3:2]) by mx.google.com with ESMTPS id h2-20020a635302000000b005898699b2b8si3427735pgb.317.2023.10.10.03.13.08 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 10 Oct 2023 03:13:08 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:2 as permitted sender) client-ip=2620:137:e000::3:2; Authentication-Results: mx.google.com; dkim=pass header.i=@ionos.com header.s=google header.b=RYELOLeF; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:2 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=ionos.com Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by agentk.vger.email (Postfix) with ESMTP id 9CF29801E740; Tue, 10 Oct 2023 03:13:06 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at agentk.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230302AbjJJKMq (ORCPT + 20 others); Tue, 10 Oct 2023 06:12:46 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42580 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229499AbjJJKMp (ORCPT ); Tue, 10 Oct 2023 06:12:45 -0400 Received: from mail-wm1-x32d.google.com (mail-wm1-x32d.google.com [IPv6:2a00:1450:4864:20::32d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 167AC94 for ; Tue, 10 Oct 2023 03:12:44 -0700 (PDT) Received: by mail-wm1-x32d.google.com with SMTP id 5b1f17b1804b1-40566f89f6eso55582365e9.3 for ; Tue, 10 Oct 2023 03:12:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ionos.com; s=google; t=1696932762; x=1697537562; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=teYJaujWBCZMTxCLTD+iOO+xzJ4IWgTIsHFi/8ohCow=; b=RYELOLeFmbycvKbS5j7pdiq+gIU9r6GKjpP7iyvoWjvStQ1zfGZenwc/gDCH0QFZp9 ToIDV1m6wE04IHsyKpRgnX3nSxj3+4mNuuMshD7dTV6nkhyyrGQyVb9RH+lVBhtRDTAA K8zkEKJ3tZl7xt61/8oNiqkLwn9/WBF59R1Pj9qy0Jm/cE8+0HNfqi+e0rJIX4xN7EEt TlUpO/Cvm7v+FlYK/6v52Zhl1rueHulPuILI+Qsl6VG5uCydU6+kFk4taaxskvA9m7dG 8aBiLhJgxZBAp3qAkwo9Bm952urWHVzu83/qWVcKQaXEiiEZ+DhdsFVTU3QI4nlABQ86 drAw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1696932762; x=1697537562; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=teYJaujWBCZMTxCLTD+iOO+xzJ4IWgTIsHFi/8ohCow=; b=m4JahtydmhDaqZXKx+IFoag+mHT9XDnRuQzIl+UYT1k7S476JlkW8MP/e6dwNQlLHl ZnsiAQRY5hgYnMO55aLVMZTjleuOo77zXXMZ9XGr499Bhd/OORRxpgiM2pwYSVZJMqlr jNgLvCPQae0zxlj3vHDIcK6J8boyqLGsZoYvTeJjOyivuF1xtdebSlKskdgtQU049aj2 7svVXGXHuTTkAzrMI+BlpWqT46j/CvZnRfldNfueWCeBXuFO1E/Ru899R8+KwXlu0voR ohRe7C24R9/gWCn4lFqG73ri3bKDEwhfv2e+8Dht07oZvVKcLrVGEUjX2vBioMz5h/f1 PvAQ== X-Gm-Message-State: AOJu0YwbCkljIqUebRLvm4cz/Az0t2/WK6zLodm/QuShAV7K6iwLM5GM ifM33qHRderF6NSWokVl/hFCdg== X-Received: by 2002:a1c:6a18:0:b0:405:4a78:a892 with SMTP id f24-20020a1c6a18000000b004054a78a892mr14910939wmc.9.1696932762426; Tue, 10 Oct 2023 03:12:42 -0700 (PDT) Received: from heron.intern.cm-ag (p200300dc6f49a600529a4cfffe3dd983.dip0.t-ipconnect.de. [2003:dc:6f49:a600:529a:4cff:fe3d:d983]) by smtp.gmail.com with ESMTPSA id 1-20020a05600c230100b0040644e699a0sm15977562wmo.45.2023.10.10.03.12.41 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 10 Oct 2023 03:12:42 -0700 (PDT) From: Max Kellermann To: linux@roeck-us.net, joe@perches.com, Jonathan Corbet Cc: Max Kellermann , workflows@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH] Documentation/process/coding-style.rst: space around const/volatile Date: Tue, 10 Oct 2023 12:12:40 +0200 Message-Id: <20231010101240.992984-1-max.kellermann@ionos.com> X-Mailer: git-send-email 2.39.2 MIME-Version: 1.0 X-Spam-Status: No, score=2.7 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, RCVD_IN_SBL_CSS,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on agentk.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (agentk.vger.email [0.0.0.0]); Tue, 10 Oct 2023 03:13:06 -0700 (PDT) X-Spam-Level: ** X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1779362995653524355 X-GMAIL-MSGID: 1779362995653524355 There are currently no rules on the placement of "const" and "volatile", but a recent code submission revealed that there is clearly a preference for spaces around them. checkpatch.pl has no check at all for this; though it does sometimes complain, but only because it erroneously thinks that the "*" (on local variables) is an unary dereference operator, not a pointer type. Current coding style for const pointers-to-pointers: "*const*": 2 occurrences "* const*": 3 "*const *": 182 "* const *": 681 Just const pointers: "*const": 2833 occurrences "* const": 16615 Link: https://lore.kernel.org/r/264fa39d-aed6-4a54-a085-107997078f8d@roeck-us.net/ Link: https://lore.kernel.org/r/f511170fe61d7e7214a3a062661cf4103980dad6.camel@perches.com/ Signed-off-by: Max Kellermann --- Documentation/process/coding-style.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst index 6db37a46d305..b40830517938 100644 --- a/Documentation/process/coding-style.rst +++ b/Documentation/process/coding-style.rst @@ -271,6 +271,18 @@ adjacent to the type name. Examples: unsigned long long memparse(char *ptr, char **retptr); char *match_strdup(substring_t *s); +Use space around the keywords ``const`` and ``volatile`` (except when +adjacent to parentheses). Example: + +.. code-block:: c + + const void *a; + void * const b; + void ** const c; + void * const * const d; + void * volatile e; + int strcmp(const char *a, const char *b); + Use one space around (on each side of) most binary and ternary operators, such as any of these::