From patchwork Wed Jul 24 11:05:08 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Patrick Steinhardt X-Patchwork-Id: 13740848 Received: from fout6-smtp.messagingengine.com (fout6-smtp.messagingengine.com [103.168.172.149]) (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 9162A2595 for ; Wed, 24 Jul 2024 11:05:15 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=103.168.172.149 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721819117; cv=none; b=LXBbHWTpzfKwY8LVlqLOFMfLSl78AaZn/uK07MEbe6EvInI4UclbYuSM1ccesrjiIwr1e2wJaFtetxoRd/7uSprOjdcbA8Qs23Ftw4CIajPVsWLPl8YemMBu6F/zsX/U2QOuPcFWR3xz/2yjpwJIUsmO2dAd1NqtWcUGLjzHbbI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1721819117; c=relaxed/simple; bh=LNggavBDKmwvVL2UeHCsm+4MwOSX91LQMvazJpFj8f4=; h=Date:From:To:Cc:Subject:Message-ID:MIME-Version:Content-Type: Content-Disposition; b=oG4Yojw54IicEM45FKzfI5fLTzHtHpuVi665Wzq+Ugggb0sSkT4odZ7pC0vtG1x0JkHvvW0pCh7c9Tt/BTuc8/mMFf2DBv88idJtFBEUy45i31eX736Bi2CRv8Yh1utZNFTYUXjRLHSNtgCy54BGZk/F6WicJ4NL4SBXalPsl0k= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=pks.im; spf=pass smtp.mailfrom=pks.im; dkim=pass (2048-bit key) header.d=pks.im header.i=@pks.im header.b=egwAQzam; dkim=pass (2048-bit key) header.d=messagingengine.com header.i=@messagingengine.com header.b=f1zZXO9d; arc=none smtp.client-ip=103.168.172.149 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=pks.im Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=pks.im Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=pks.im header.i=@pks.im header.b="egwAQzam"; dkim=pass (2048-bit key) header.d=messagingengine.com header.i=@messagingengine.com header.b="f1zZXO9d" Received: from compute4.internal (compute4.nyi.internal [10.202.2.44]) by mailfout.nyi.internal (Postfix) with ESMTP id 4E6D8138025F; Wed, 24 Jul 2024 07:05:13 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute4.internal (MEProxy); Wed, 24 Jul 2024 07:05:13 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pks.im; h=cc:cc :content-type:content-type:date:date:from:from:in-reply-to :message-id:mime-version:reply-to:subject:subject:to:to; s=fm3; t=1721819113; x=1721905513; bh=fKwXMswSqRAaco1xGj/qrVBOauElepo/ QfbNqnfUPWA=; b=egwAQzamX8TiDT6IAySBwDwkL/gD/RnaCxR6VkUwvRF+jFuL zQn4MlRGafY9FSDg1KnFMxjsYCHPuciZg1mLnRzCU99ip9uWsK0QZB79BkNynB6Z efstgicsEP2N1OaBoPl0VjtOu94aHOGRUlu4Skpd9/Nuj/xqt+E2+KjSqqefKe60 DHfPDX86p2FquucQzwmvDtsvyklBsVVf5OrQFOOE8V8eG+QnrP5T19+WxmcFjEdp 1xQDDtFiLrM8idTt3TbNeS2PQpQp7Flo5tiRz/QiyIRV/Wxy0oGwp5FYd6VWclyw jNrNg0/RrtIdmCezQPeNcwtSy5rfCjtZEdn7hw== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-type:content-type:date:date :feedback-id:feedback-id:from:from:in-reply-to:message-id :mime-version:reply-to:subject:subject:to:to:x-me-proxy :x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s=fm3; t= 1721819113; x=1721905513; bh=fKwXMswSqRAaco1xGj/qrVBOauElepo/Qfb NqnfUPWA=; b=f1zZXO9drs3TqZvtRX1J5bmLL7e9N1/MNy1HTDj2dClJLhJjKex vYZY1SqIC8+jbWiaLI2PjNBZ5Y+hEue48f7Fj4lpr8MiUdJtQ6sLDocsw80fOKmY 4XGS08aRWDSPXXqNL74+V9PXQHoYJCPOVPNto7zPmeLTYsTO4OfRIoJG4nRpXdHE kANGM6KkhrcrQC4OEXfgOViSP9Pcbos1eY0zEfRpS5nkru7Og6LmnI2AbYf1zU+6 zsX0xQvhFqRyWMgTisWRIixZOcH4wj0MROMx+4EBsnrbWGklw1gKwQNDZBK+1iwf eN0q9K+T1OIMIQZVP9NvScTvr9z6By76vJQ== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeeftddriedugdefjecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpeffhffvvefukfggtggusehgtderredttddvnecuhfhrohhmpefrrghtrhhitghk ucfuthgvihhnhhgrrhguthcuoehpshesphhkshdrihhmqeenucggtffrrghtthgvrhhnpe eugfeutdeuieehteelveegudejkeejheeljeejhffhgffhvefgkeeukeejtdeijeenucev lhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehpshesphhksh drihhmpdhnsggprhgtphhtthhopedt X-ME-Proxy: Feedback-ID: i197146af:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Wed, 24 Jul 2024 07:05:12 -0400 (EDT) Received: by localhost (OpenSMTPD) with ESMTPSA id 2d066e23 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Wed, 24 Jul 2024 11:03:54 +0000 (UTC) Date: Wed, 24 Jul 2024 13:05:08 +0200 From: Patrick Steinhardt To: git@vger.kernel.org Cc: Karthik Nayak Subject: [PATCH 0/3] Documentation: some coding guideline updates Message-ID: Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline Hi, I've had it in my mind for a long time to update our coding guideline for some things that I frequently stumble over during code reviews. This small patch series fills in those gaps. Thanks! Patrick Patrick Steinhardt (3): Documentation: clarify indentation style for C preprocessor directives Documentation: document naming schema for struct-related functions Documentation: document difference between release and free Documentation/CodingGuidelines | 41 ++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+)