From patchwork Thu Nov 3 13:29:25 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Juraj_Linke=C5=A1?= X-Patchwork-Id: 119432 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 822ACA00C2; Thu, 3 Nov 2022 14:29:31 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 229BC42D03; Thu, 3 Nov 2022 14:29:31 +0100 (CET) Received: from lb.pantheon.sk (lb.pantheon.sk [46.229.239.20]) by mails.dpdk.org (Postfix) with ESMTP id F165242D02 for ; Thu, 3 Nov 2022 14:29:28 +0100 (CET) Received: from localhost (localhost [127.0.0.1]) by lb.pantheon.sk (Postfix) with ESMTP id C42761B68DF; Thu, 3 Nov 2022 14:29:27 +0100 (CET) X-Virus-Scanned: amavisd-new at siecit.sk Received: from lb.pantheon.sk ([127.0.0.1]) by localhost (lb.pantheon.sk [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id bdF7nHCQUE5Z; Thu, 3 Nov 2022 14:29:26 +0100 (CET) Received: from entguard.lab.pantheon.local (unknown [46.229.239.141]) by lb.pantheon.sk (Postfix) with ESMTP id B232C1B68EC; Thu, 3 Nov 2022 14:29:26 +0100 (CET) From: =?utf-8?q?Juraj_Linke=C5=A1?= To: Cc: dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= Subject: [PATCH v1 1/2] git: ignore standard python files Date: Thu, 3 Nov 2022 13:29:25 +0000 Message-Id: <20221103132926.445627-2-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20221103132926.445627-1-juraj.linkes@pantheon.tech> References: <20221103132926.445627-1-juraj.linkes@pantheon.tech> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org These are python byte-compiled/optimized/dll files and IDE files. Signed-off-by: Juraj Linkeš Acked-by: Bruce Richardson --- .gitignore | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 212c7aa28e..fbec0ce441 100644 --- a/.gitignore +++ b/.gitignore @@ -33,8 +33,10 @@ GRTAGS tags TAGS -# ignore python bytecode files -*.pyc +# python byte-compiled/optimized/dll files +__pycache__/ +*.py[cod] +*$py.class # ignore default build directory, and directories from test-meson-builds.sh build From patchwork Thu Nov 3 13:29:26 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Juraj_Linke=C5=A1?= X-Patchwork-Id: 119434 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 46193A00C2; Thu, 3 Nov 2022 14:29:42 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id DFF3042D0E; Thu, 3 Nov 2022 14:29:32 +0100 (CET) Received: from lb.pantheon.sk (lb.pantheon.sk [46.229.239.20]) by mails.dpdk.org (Postfix) with ESMTP id A841442D04 for ; Thu, 3 Nov 2022 14:29:29 +0100 (CET) Received: from localhost (localhost [127.0.0.1]) by lb.pantheon.sk (Postfix) with ESMTP id E4EC21B68EC; Thu, 3 Nov 2022 14:29:28 +0100 (CET) X-Virus-Scanned: amavisd-new at siecit.sk Received: from lb.pantheon.sk ([127.0.0.1]) by localhost (lb.pantheon.sk [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id Lg0KC3Mp-Ktg; Thu, 3 Nov 2022 14:29:27 +0100 (CET) Received: from entguard.lab.pantheon.local (unknown [46.229.239.141]) by lb.pantheon.sk (Postfix) with ESMTP id D21CE1B68F8; Thu, 3 Nov 2022 14:29:26 +0100 (CET) From: =?utf-8?q?Juraj_Linke=C5=A1?= To: Cc: dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= Subject: [PATCH v1 2/2] doc: increase python max line to 88 Date: Thu, 3 Nov 2022 13:29:26 +0000 Message-Id: <20221103132926.445627-3-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20221103132926.445627-1-juraj.linkes@pantheon.tech> References: <20221103132926.445627-1-juraj.linkes@pantheon.tech> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org 88 is a good compromise between shorter files, readability and other considerations. More in [0]. [0] https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#line-length Signed-off-by: Owen Hilyard Signed-off-by: Juraj Linkeš Acked-by: Bruce Richardson --- .editorconfig | 2 +- doc/doc_build/meson-private/meson.lock | 0 doc/guides/contributing/coding_style.rst | 8 +++++++- 3 files changed, 8 insertions(+), 2 deletions(-) create mode 100644 doc/doc_build/meson-private/meson.lock diff --git a/.editorconfig b/.editorconfig index ab41c95085..f20996f329 100644 --- a/.editorconfig +++ b/.editorconfig @@ -16,7 +16,7 @@ max_line_length = 100 [*.py] indent_style = space indent_size = 4 -max_line_length = 79 +max_line_length = 88 # https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#line-length [meson.build] indent_style = space diff --git a/doc/doc_build/meson-private/meson.lock b/doc/doc_build/meson-private/meson.lock new file mode 100644 index 0000000000..e69de29bb2 diff --git a/doc/guides/contributing/coding_style.rst b/doc/guides/contributing/coding_style.rst index 89db6260cf..7620268dc7 100644 --- a/doc/guides/contributing/coding_style.rst +++ b/doc/guides/contributing/coding_style.rst @@ -851,7 +851,13 @@ Python Code All Python code should be compliant with `PEP8 (Style Guide for Python Code) `_. -The ``pep8`` tool can be used for testing compliance with the guidelines. +The ``pep8`` tool can be used for testing compliance with the guidelines. Note that the +maximum line length is 88, as that is a good compromise between shorter files, usability +with other tools (side-by-side diffs, docs, presentations) and disability accommodation. +More in `Black's documentation +`_. + +.. Integrating with the Build System ---------------------------------