Igt-dev Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: "Zbigniew Kempczyński" <zbigniew.kempczynski@intel.com>
To: igt-dev@lists.freedesktop.org
Subject: [igt-dev] [PATCH i-g-t 01/18] scripts/igt_doc.py: beautify its code
Date: Fri, 10 Mar 2023 09:23:09 +0100	[thread overview]
Message-ID: <20230310082326.12088-2-zbigniew.kempczynski@intel.com> (raw)
In-Reply-To: <20230310082326.12088-1-zbigniew.kempczynski@intel.com>

From: Mauro Carvalho Chehab <mchehab@kernel.org>

Change some comments and add blank lines before docstring, in
order to better document its code.

No functional changes.

Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
Reviewed-by: Zbigniew Kempczyński <zbigniew.kempczynski@intel.com>
---
 scripts/igt_doc.py | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)
 mode change 100755 => 100644 scripts/igt_doc.py

diff --git a/scripts/igt_doc.py b/scripts/igt_doc.py
old mode 100755
new mode 100644
index b7e3129d3f..c8bd4054f6
--- a/scripts/igt_doc.py
+++ b/scripts/igt_doc.py
@@ -109,7 +109,6 @@ class TestList:
     SUBTEST as those variables are locally processed on each comment line.
     """
 
-
     def __init__(self):
         self.doc = {}
         self.test_number = 0
@@ -238,7 +237,7 @@ class TestList:
 
     def print_test(self):
 
-        """Print tests and subtests ordered by tests"""
+        """Print tests and subtests"""
 
         for test in sorted(self.doc.keys()):
             fname = self.doc[test]["File"]
@@ -368,7 +367,7 @@ class TestList:
     # File handling methods
     #
 
-    def add_file_documentation(self, fname, field_re):
+    def add_file_documentation(self, fname):
 
         """Adds the contents of test/subtest documentation form a file"""
 
-- 
2.34.1

  reply	other threads:[~2023-03-10  8:23 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-10  8:23 [igt-dev] [PATCH i-g-t 00/18] Add igt_doc.py Zbigniew Kempczyński
2023-03-10  8:23 ` Zbigniew Kempczyński [this message]
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 02/18] scripts/igt_doc.py: add JSON file output Zbigniew Kempczyński
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 03/18] scripts/igt_doc.py: dynamically create fields array from a JSON file Zbigniew Kempczyński
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 04/18] scripts/igt_doc.py: add support to specify numeric values Zbigniew Kempczyński
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 05/18] scripts/igt_doc.py: improve --show-subtests logic Zbigniew Kempczyński
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 06/18] scripts/igt_doc.py: add error handler for subprocess Zbigniew Kempczyński
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 07/18] scripts/igt_doc.py: improve multi-line logic Zbigniew Kempczyński
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 08/18] scripts/igt_doc.py: don't use ":=" operator Zbigniew Kempczyński
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 09/18] scripts/igt_doc.py: make it compatible with Python 3.6 Zbigniew Kempczyński
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 10/18] scripts/igt_doc.py: sets the minimal version to run the script Zbigniew Kempczyński
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 11/18] scripts/igt_doc.py: use a different logic to get IGT prefix Zbigniew Kempczyński
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 12/18] testplan/meson.build: add targets to build Xe test documentation Zbigniew Kempczyński
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 13/18] xe/xe_test_config.json: cleanup the field struct Zbigniew Kempczyński
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 14/18] xe/xe_huc_copy: add GPU dependency to its documentation Zbigniew Kempczyński
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 15/18] xe/xe_*: add TEST/SUBTEST documentation Zbigniew Kempczyński
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 16/18] xe-fast-feedback.testlist: update debugfs tests Zbigniew Kempczyński
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 17/18] xe_mmap: skip VRAM tests if no VRAM is found Zbigniew Kempczyński
2023-03-10 10:52   ` Das, Nirmoy
2023-03-13  6:48     ` Zbigniew Kempczyński
2023-03-14 12:26       ` Das, Nirmoy
2023-03-10  8:23 ` [igt-dev] [PATCH i-g-t 18/18] meson: replace "igt@xe/" by "igt@" Zbigniew Kempczyński
2023-03-10 10:23 ` [igt-dev] ✓ Fi.CI.BAT: success for Add igt_doc.py Patchwork
2023-03-13  1:18 ` [igt-dev] ✓ Fi.CI.IGT: " Patchwork

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230310082326.12088-2-zbigniew.kempczynski@intel.com \
    --to=zbigniew.kempczynski@intel.com \
    --cc=igt-dev@lists.freedesktop.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox