From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mx1.redhat.com (mx1.redhat.com [209.132.183.28]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 3C9CC2095E00F for ; Fri, 11 Aug 2017 09:46:37 -0700 (PDT) Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.12]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 62829C052449; Fri, 11 Aug 2017 16:48:57 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mx1.redhat.com 62829C052449 Authentication-Results: ext-mx08.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com Authentication-Results: ext-mx08.extmail.prod.ext.phx2.redhat.com; spf=fail smtp.mailfrom=lersek@redhat.com Received: from lacos-laptop-7.usersys.redhat.com (ovpn-116-239.phx2.redhat.com [10.3.116.239]) by smtp.corp.redhat.com (Postfix) with ESMTP id 0DC8B78DEF; Fri, 11 Aug 2017 16:48:55 +0000 (UTC) From: Laszlo Ersek To: edk2-devel-01 Cc: Ard Biesheuvel , Jordan Justen , Leif Lindholm , Michael D Kinney Date: Fri, 11 Aug 2017 18:48:50 +0200 Message-Id: <20170811164851.9466-2-lersek@redhat.com> In-Reply-To: <20170811164851.9466-1-lersek@redhat.com> References: <20170811164851.9466-1-lersek@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.5.11.12 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.32]); Fri, 11 Aug 2017 16:48:57 +0000 (UTC) Subject: [edk2-CCodingStandardsSpecification PATCH 1/2] Source Files / General Rules: limit line lengths to 80 columns X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.22 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 11 Aug 2017 16:46:37 -0000 We currently say "stick with 80 if it's convenient, extend to 120 otherwise". This is too lax; much new edk2 code ignores the 80 columns recommendation, resulting in source files that are hard to read for some contributors. Remove the 120 columns excuse and make 80 columns a requirement. Cc: Ard Biesheuvel Cc: Jordan Justen Cc: Leif Lindholm Cc: Michael D Kinney Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Laszlo Ersek --- 5_source_files/README.md | 17 ++++++++++++----- README.md | 1 + 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/5_source_files/README.md b/5_source_files/README.md index a93492db4f0f..546d44d94fcb 100644 --- a/5_source_files/README.md +++ b/5_source_files/README.md @@ -33,12 +33,19 @@ ## 5.1 General Rules -### 5.1.1 Lines shall be 120 columns, or less +### 5.1.1 Lines shall be 80 columns, or less -Preferably, limit line lengths to 80 columns or less. When this doesn't leave -sufficient space for a good postfix style comment, extend the line to a total -of 120 columns. Having some level of uniformity in the expected width of the -source is useful for viewing and printing the code. +Limit line lengths to 80 columns. + +Lines longer than 80 columns make it more difficult for the reader to find the +beginning of the next line. They also tend to prevent users from displaying two +source listings side-by-side on common display devices. + +When the 80 columns limit doesn't leave sufficient space for a postfix style +comment, break the line into shorter segments at logical boundaries (for +example, between the arguments of a function call, adhering to the spacing +rules), or replace the postfix style comment with a standalone comment that +precedes the statement. ### 5.1.2 Do not use tab characters diff --git a/README.md b/README.md index 8b9675b94937..8fad5a327b8c 100644 --- a/README.md +++ b/README.md @@ -112,3 +112,4 @@ Copyright (c) 2006-2017, Intel Corporation. All rights reserved. | 2.1 | DRAFT for REFORMAT | 10/30/2015 | | 2.2 | Convert to Gitbook | June 2017 | | | [#425](https://bugzilla.tianocore.org/show_bug.cgi?id=425) [CCS] clarify line breaking and indentation requirements for multi-line function calls | | +| | Limit lines to 80 columns | | -- 2.13.1.3.g8be5a757fa67