public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
* [PATCH] gdb: disable formatting-related flake8 warnings
@ 2024-02-23 20:43 Simon Marchi
  2024-02-23 21:07 ` Tom Tromey
  0 siblings, 1 reply; 3+ messages in thread
From: Simon Marchi @ 2024-02-23 20:43 UTC (permalink / raw)
  To: gdb-patches; +Cc: Simon Marchi

Tom Tromey pointed out that flake8 gives some warnings related to
formatting, such as:

    python/lib/gdb/prompt.py:149:43: E203 whitespace before ':'

We don't care about those, since all our formatting is handled
automatically by black, so ignore these warnings.

The list of warnings I put comes from:

  https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#flake8

Note that since the setup.cfg file is under the gdb directory, it will
be picked up if you run flake8 from the gdb directory like this:

    binutils-gdb/gdb $ flake8 python

but not if you do:

    binutils-gdb $ flake8 gdb/python

Change-Id: I1e42aefd388b9c3b6c9d52b4f635ac881db4bbc1
---
 gdb/setup.cfg | 5 +++++
 1 file changed, 5 insertions(+)
 create mode 100644 gdb/setup.cfg

diff --git a/gdb/setup.cfg b/gdb/setup.cfg
new file mode 100644
index 000000000000..28d7c876b33c
--- /dev/null
+++ b/gdb/setup.cfg
@@ -0,0 +1,5 @@
+[flake8]
+# E203: Whitespace before ':' (conclicts with black's way of formatting)
+# E501: line too long
+# E701: Multiple statements on one line (colon) (E701)
+ignore = E203,E501,E701

base-commit: bf8ab2ae8d33e46bb6612408c75e75a6de137ccc
-- 
2.43.2


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] gdb: disable formatting-related flake8 warnings
  2024-02-23 20:43 [PATCH] gdb: disable formatting-related flake8 warnings Simon Marchi
@ 2024-02-23 21:07 ` Tom Tromey
  2024-02-23 22:00   ` Simon Marchi
  0 siblings, 1 reply; 3+ messages in thread
From: Tom Tromey @ 2024-02-23 21:07 UTC (permalink / raw)
  To: Simon Marchi; +Cc: gdb-patches

>>>>> "Simon" == Simon Marchi <simon.marchi@polymtl.ca> writes:

Simon> +# E203: Whitespace before ':' (conclicts with black's way of formatting)

"conflicts"

Ok with that fixed IMO.
Approved-By: Tom Tromey <tom@tromey.com>

Tom

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] gdb: disable formatting-related flake8 warnings
  2024-02-23 21:07 ` Tom Tromey
@ 2024-02-23 22:00   ` Simon Marchi
  0 siblings, 0 replies; 3+ messages in thread
From: Simon Marchi @ 2024-02-23 22:00 UTC (permalink / raw)
  To: Tom Tromey; +Cc: gdb-patches



On 2024-02-23 16:07, Tom Tromey wrote:
>>>>>> "Simon" == Simon Marchi <simon.marchi@polymtl.ca> writes:
> 
> Simon> +# E203: Whitespace before ':' (conclicts with black's way of formatting)
> 
> "conflicts"

Ah, oops, this typo actually comes from where I copied the line (another
project I work on):

https://github.com/efficios/babeltrace/blob/5ecc1dc9a8d3ba726539fdd67e1be6a99f7dacf2/setup.cfg#L5

I changed the comment so it makes more sense, remove an extra "E701" as
well:

[flake8]
# Disable some formatted-related warnings that conflict with black's way of
# formatting code.
#
# E203: Whitespace before ':'
# E501: line too long
# E701: Multiple statements on one line (colon)
ignore = E203,E501,E701

I pushed that version.

Thanks,

Simon

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2024-02-23 22:00 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-02-23 20:43 [PATCH] gdb: disable formatting-related flake8 warnings Simon Marchi
2024-02-23 21:07 ` Tom Tromey
2024-02-23 22:00   ` Simon Marchi

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).