* [PATCH] gen_compile_commands: fix invalid escape sequence
@ 2024-02-13 1:20 Andrew Ballance
2024-02-13 1:48 ` Masahiro Yamada
0 siblings, 1 reply; 10+ messages in thread
From: Andrew Ballance @ 2024-02-13 1:20 UTC (permalink / raw)
To: linux-kernel
Cc: masahiroy, nathan, nicolas, ndesaulniers, morbo, justinstitt,
linux-kbuild, llvm, skhan, linux-kernel-mentees, Andrew Ballance
this fixes the error, "SyntaxWarning: invalid escape sequence '\#'"
the error can be recreated by running
make CC=clang compile_commands.json
Signed-off-by: Andrew Ballance <andrewjballance@gmail.com>
---
scripts/clang-tools/gen_compile_commands.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/scripts/clang-tools/gen_compile_commands.py b/scripts/clang-tools/gen_compile_commands.py
index 5dea4479240b..93f64095fda9 100755
--- a/scripts/clang-tools/gen_compile_commands.py
+++ b/scripts/clang-tools/gen_compile_commands.py
@@ -170,7 +170,7 @@ def process_line(root_directory, command_prefix, file_path):
# escape the pound sign '#', either as '\#' or '$(pound)' (depending on the
# kernel version). The compile_commands.json file is not interepreted
# by Make, so this code replaces the escaped version with '#'.
- prefix = command_prefix.replace('\#', '#').replace('$(pound)', '#')
+ prefix = command_prefix.replace('\\#', '#').replace('$(pound)', '#')
# Return the canonical path, eliminating any symbolic links encountered in the path.
abs_path = os.path.realpath(os.path.join(root_directory, file_path))
--
2.43.0
^ permalink raw reply related [flat|nested] 10+ messages in thread* Re: [PATCH] gen_compile_commands: fix invalid escape sequence
2024-02-13 1:20 [PATCH] gen_compile_commands: fix invalid escape sequence Andrew Ballance
@ 2024-02-13 1:48 ` Masahiro Yamada
2024-02-13 2:25 ` [PATCH v2] gen_compile_commands: fix invalid escape sequence warning Andrew Ballance
0 siblings, 1 reply; 10+ messages in thread
From: Masahiro Yamada @ 2024-02-13 1:48 UTC (permalink / raw)
To: Andrew Ballance
Cc: linux-kernel, nathan, nicolas, ndesaulniers, morbo, justinstitt,
linux-kbuild, llvm, skhan, linux-kernel-mentees
On Tue, Feb 13, 2024 at 10:21 AM Andrew Ballance
<andrewjballance@gmail.com> wrote:
>
> this fixes the error, "SyntaxWarning: invalid escape sequence '\#'"
>
> the error can be recreated by running
Not an error.
It is a warning.
> make CC=clang compile_commands.json
What is more important is to mention the Python version
in the commit description.
Example:
---------------->8----------------
With Python 3.12, '\#' results in this warning:
SyntaxWarning: invalid escape sequence '\#'
---------------->8----------------
Please update the commit message.
The make command is not so important.
I quickly confirm it in the interactive mode
instead of running the build command.
$ python3.12
Python 3.12.0 (main, Oct 4 2023, 06:27:34) [GCC 13.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> '\#'
<stdin>:1: SyntaxWarning: invalid escape sequence '\#'
'\\#'
>>> '\\#'
'\\#'
>
> Signed-off-by: Andrew Ballance <andrewjballance@gmail.com>
> ---
> scripts/clang-tools/gen_compile_commands.py | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/scripts/clang-tools/gen_compile_commands.py b/scripts/clang-tools/gen_compile_commands.py
> index 5dea4479240b..93f64095fda9 100755
> --- a/scripts/clang-tools/gen_compile_commands.py
> +++ b/scripts/clang-tools/gen_compile_commands.py
> @@ -170,7 +170,7 @@ def process_line(root_directory, command_prefix, file_path):
> # escape the pound sign '#', either as '\#' or '$(pound)' (depending on the
> # kernel version). The compile_commands.json file is not interepreted
> # by Make, so this code replaces the escaped version with '#'.
> - prefix = command_prefix.replace('\#', '#').replace('$(pound)', '#')
> + prefix = command_prefix.replace('\\#', '#').replace('$(pound)', '#')
>
> # Return the canonical path, eliminating any symbolic links encountered in the path.
> abs_path = os.path.realpath(os.path.join(root_directory, file_path))
> --
> 2.43.0
>
--
Best Regards
Masahiro Yamada
^ permalink raw reply [flat|nested] 10+ messages in thread* [PATCH v2] gen_compile_commands: fix invalid escape sequence warning
2024-02-13 1:48 ` Masahiro Yamada
@ 2024-02-13 2:25 ` Andrew Ballance
2024-02-13 20:00 ` Nicolas Schier
2024-02-14 0:40 ` [PATCH v2] " Justin Stitt
0 siblings, 2 replies; 10+ messages in thread
From: Andrew Ballance @ 2024-02-13 2:25 UTC (permalink / raw)
To: masahiroy
Cc: andrewjballance, justinstitt, linux-kbuild, linux-kernel-mentees,
linux-kernel, llvm, morbo, nathan, ndesaulniers, nicolas, skhan
with python 12.1 '\#' results in this warning
SyntaxWarning: invalid escape sequence '\#'
Signed-off-by: Andrew Ballance <andrewjballance@gmail.com>
---
scripts/clang-tools/gen_compile_commands.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/scripts/clang-tools/gen_compile_commands.py b/scripts/clang-tools/gen_compile_commands.py
index 5dea4479240b..93f64095fda9 100755
--- a/scripts/clang-tools/gen_compile_commands.py
+++ b/scripts/clang-tools/gen_compile_commands.py
@@ -170,7 +170,7 @@ def process_line(root_directory, command_prefix, file_path):
# escape the pound sign '#', either as '\#' or '$(pound)' (depending on the
# kernel version). The compile_commands.json file is not interepreted
# by Make, so this code replaces the escaped version with '#'.
- prefix = command_prefix.replace('\#', '#').replace('$(pound)', '#')
+ prefix = command_prefix.replace('\\#', '#').replace('$(pound)', '#')
# Return the canonical path, eliminating any symbolic links encountered in the path.
abs_path = os.path.realpath(os.path.join(root_directory, file_path))
--
2.43.0
^ permalink raw reply related [flat|nested] 10+ messages in thread* Re: [PATCH v2] gen_compile_commands: fix invalid escape sequence warning
2024-02-13 2:25 ` [PATCH v2] gen_compile_commands: fix invalid escape sequence warning Andrew Ballance
@ 2024-02-13 20:00 ` Nicolas Schier
2024-02-14 0:31 ` Justin Stitt
2024-02-14 0:40 ` [PATCH v2] " Justin Stitt
1 sibling, 1 reply; 10+ messages in thread
From: Nicolas Schier @ 2024-02-13 20:00 UTC (permalink / raw)
To: Andrew Ballance
Cc: masahiroy, justinstitt, linux-kbuild, linux-kernel-mentees,
linux-kernel, llvm, morbo, nathan, ndesaulniers, skhan
[-- Attachment #1: Type: text/plain, Size: 1525 bytes --]
On Mon 12 Feb 2024 20:25:52 GMT, Andrew Ballance wrote:
> with python 12.1 '\#' results in this warning
funny typo: it's Python 3.12 :)
Kind regards,
Nicolas
> SyntaxWarning: invalid escape sequence '\#'
>
> Signed-off-by: Andrew Ballance <andrewjballance@gmail.com>
> ---
> scripts/clang-tools/gen_compile_commands.py | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/scripts/clang-tools/gen_compile_commands.py b/scripts/clang-tools/gen_compile_commands.py
> index 5dea4479240b..93f64095fda9 100755
> --- a/scripts/clang-tools/gen_compile_commands.py
> +++ b/scripts/clang-tools/gen_compile_commands.py
> @@ -170,7 +170,7 @@ def process_line(root_directory, command_prefix, file_path):
> # escape the pound sign '#', either as '\#' or '$(pound)' (depending on the
> # kernel version). The compile_commands.json file is not interepreted
> # by Make, so this code replaces the escaped version with '#'.
> - prefix = command_prefix.replace('\#', '#').replace('$(pound)', '#')
> + prefix = command_prefix.replace('\\#', '#').replace('$(pound)', '#')
>
> # Return the canonical path, eliminating any symbolic links encountered in the path.
> abs_path = os.path.realpath(os.path.join(root_directory, file_path))
> --
> 2.43.0
>
--
Nicolas Schier
epost|xmpp: nicolas@fjasle.eu irc://oftc.net/nsc
↳ gpg: 18ed 52db e34f 860e e9fb c82b 7d97 0932 55a0 ce7f
-- frykten for herren er opphav til kunnskap --
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 10+ messages in thread* Re: [PATCH v2] gen_compile_commands: fix invalid escape sequence warning
2024-02-13 20:00 ` Nicolas Schier
@ 2024-02-14 0:31 ` Justin Stitt
2024-02-14 1:23 ` [PATCH v3 0/1] " Andrew Ballance
0 siblings, 1 reply; 10+ messages in thread
From: Justin Stitt @ 2024-02-14 0:31 UTC (permalink / raw)
To: Nicolas Schier
Cc: Andrew Ballance, masahiroy, linux-kbuild, linux-kernel-mentees,
linux-kernel, llvm, morbo, nathan, ndesaulniers, skhan
On Tue, Feb 13, 2024 at 12:00 PM Nicolas Schier <nicolas@fjasle.eu> wrote:
>
> On Mon 12 Feb 2024 20:25:52 GMT, Andrew Ballance wrote:
> > with python 12.1 '\#' results in this warning
>
> funny typo: it's Python 3.12 :)
They probably meant Python 3.12.1 and forgot the "3." (or had a vim
moment resulting in its unfortunate removal)
>
> Kind regards,
> Nicolas
>
>
> > SyntaxWarning: invalid escape sequence '\#'
> >
> > Signed-off-by: Andrew Ballance <andrewjballance@gmail.com>
> > ---
> > scripts/clang-tools/gen_compile_commands.py | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/scripts/clang-tools/gen_compile_commands.py b/scripts/clang-tools/gen_compile_commands.py
> > index 5dea4479240b..93f64095fda9 100755
> > --- a/scripts/clang-tools/gen_compile_commands.py
> > +++ b/scripts/clang-tools/gen_compile_commands.py
> > @@ -170,7 +170,7 @@ def process_line(root_directory, command_prefix, file_path):
> > # escape the pound sign '#', either as '\#' or '$(pound)' (depending on the
> > # kernel version). The compile_commands.json file is not interepreted
> > # by Make, so this code replaces the escaped version with '#'.
> > - prefix = command_prefix.replace('\#', '#').replace('$(pound)', '#')
> > + prefix = command_prefix.replace('\\#', '#').replace('$(pound)', '#')
> >
> > # Return the canonical path, eliminating any symbolic links encountered in the path.
> > abs_path = os.path.realpath(os.path.join(root_directory, file_path))
> > --
> > 2.43.0
> >
>
> --
> Nicolas Schier
>
> epost|xmpp: nicolas@fjasle.eu irc://oftc.net/nsc
> ↳ gpg: 18ed 52db e34f 860e e9fb c82b 7d97 0932 55a0 ce7f
> -- frykten for herren er opphav til kunnskap --
^ permalink raw reply [flat|nested] 10+ messages in thread* [PATCH v3 0/1] gen_compile_commands: fix invalid escape sequence warning
2024-02-14 0:31 ` Justin Stitt
@ 2024-02-14 1:23 ` Andrew Ballance
2024-02-14 1:23 ` [PATCH v3 1/1] " Andrew Ballance
0 siblings, 1 reply; 10+ messages in thread
From: Andrew Ballance @ 2024-02-14 1:23 UTC (permalink / raw)
To: justinstitt
Cc: andrewjballance, linux-kbuild, linux-kernel-mentees,
linux-kernel, llvm, masahiroy, morbo, nathan, ndesaulniers,
nicolas, skhan
this fixes the version in the commit. I did in fact have a vim moment.
this also uses a raw string as sugested.
thanks.
Andrew Ballance (1):
gen_compile_commands: fix invalid escape sequence warning
scripts/clang-tools/gen_compile_commands.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
--
2.43.0
^ permalink raw reply [flat|nested] 10+ messages in thread
* [PATCH v3 1/1] gen_compile_commands: fix invalid escape sequence warning
2024-02-14 1:23 ` [PATCH v3 0/1] " Andrew Ballance
@ 2024-02-14 1:23 ` Andrew Ballance
2024-02-14 18:28 ` Justin Stitt
2024-02-14 21:27 ` Masahiro Yamada
0 siblings, 2 replies; 10+ messages in thread
From: Andrew Ballance @ 2024-02-14 1:23 UTC (permalink / raw)
To: justinstitt
Cc: andrewjballance, linux-kbuild, linux-kernel-mentees,
linux-kernel, llvm, masahiroy, morbo, nathan, ndesaulniers,
nicolas, skhan
with python 3.12.1 '\#' results in this warning
SyntaxWarning: invalid escape sequence '\#'
Signed-off-by: Andrew Ballance <andrewjballance@gmail.com>
---
scripts/clang-tools/gen_compile_commands.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/scripts/clang-tools/gen_compile_commands.py b/scripts/clang-tools/gen_compile_commands.py
index 5dea4479240b..e4fb686dfaa9 100755
--- a/scripts/clang-tools/gen_compile_commands.py
+++ b/scripts/clang-tools/gen_compile_commands.py
@@ -170,7 +170,7 @@ def process_line(root_directory, command_prefix, file_path):
# escape the pound sign '#', either as '\#' or '$(pound)' (depending on the
# kernel version). The compile_commands.json file is not interepreted
# by Make, so this code replaces the escaped version with '#'.
- prefix = command_prefix.replace('\#', '#').replace('$(pound)', '#')
+ prefix = command_prefix.replace(r'\#', '#').replace('$(pound)', '#')
# Return the canonical path, eliminating any symbolic links encountered in the path.
abs_path = os.path.realpath(os.path.join(root_directory, file_path))
--
2.43.0
^ permalink raw reply related [flat|nested] 10+ messages in thread* Re: [PATCH v3 1/1] gen_compile_commands: fix invalid escape sequence warning
2024-02-14 1:23 ` [PATCH v3 1/1] " Andrew Ballance
@ 2024-02-14 18:28 ` Justin Stitt
2024-02-14 21:27 ` Masahiro Yamada
1 sibling, 0 replies; 10+ messages in thread
From: Justin Stitt @ 2024-02-14 18:28 UTC (permalink / raw)
To: Andrew Ballance
Cc: linux-kbuild, linux-kernel-mentees, linux-kernel, llvm,
masahiroy, morbo, nathan, ndesaulniers, nicolas, skhan
Hi,
On Tue, Feb 13, 2024 at 07:23:05PM -0600, Andrew Ballance wrote:
> with python 3.12.1 '\#' results in this warning
> SyntaxWarning: invalid escape sequence '\#'
>
> Signed-off-by: Andrew Ballance <andrewjballance@gmail.com>
You probably don't need to send a patch series (with a cover letter) if
you're only sending a single patch to the list.
Really, though, who cares!
Reviewed-by: Justin Stitt <justinstitt@google.com>
> ---
> scripts/clang-tools/gen_compile_commands.py | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/scripts/clang-tools/gen_compile_commands.py b/scripts/clang-tools/gen_compile_commands.py
> index 5dea4479240b..e4fb686dfaa9 100755
> --- a/scripts/clang-tools/gen_compile_commands.py
> +++ b/scripts/clang-tools/gen_compile_commands.py
> @@ -170,7 +170,7 @@ def process_line(root_directory, command_prefix, file_path):
> # escape the pound sign '#', either as '\#' or '$(pound)' (depending on the
> # kernel version). The compile_commands.json file is not interepreted
> # by Make, so this code replaces the escaped version with '#'.
> - prefix = command_prefix.replace('\#', '#').replace('$(pound)', '#')
> + prefix = command_prefix.replace(r'\#', '#').replace('$(pound)', '#')
>
> # Return the canonical path, eliminating any symbolic links encountered in the path.
> abs_path = os.path.realpath(os.path.join(root_directory, file_path))
> --
> 2.43.0
>
Thanks
Justin
^ permalink raw reply [flat|nested] 10+ messages in thread* Re: [PATCH v3 1/1] gen_compile_commands: fix invalid escape sequence warning
2024-02-14 1:23 ` [PATCH v3 1/1] " Andrew Ballance
2024-02-14 18:28 ` Justin Stitt
@ 2024-02-14 21:27 ` Masahiro Yamada
1 sibling, 0 replies; 10+ messages in thread
From: Masahiro Yamada @ 2024-02-14 21:27 UTC (permalink / raw)
To: Andrew Ballance
Cc: justinstitt, linux-kbuild, linux-kernel-mentees, linux-kernel,
llvm, morbo, nathan, ndesaulniers, nicolas, skhan
On Wed, Feb 14, 2024 at 10:25 AM Andrew Ballance
<andrewjballance@gmail.com> wrote:
>
> with python 3.12.1 '\#' results in this warning
> SyntaxWarning: invalid escape sequence '\#'
I changed "3.12.1" to "3.12" when I applied it
because this occurs for Python 3.12.0
Thanks.
>
> Signed-off-by: Andrew Ballance <andrewjballance@gmail.com>
> ---
> scripts/clang-tools/gen_compile_commands.py | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/scripts/clang-tools/gen_compile_commands.py b/scripts/clang-tools/gen_compile_commands.py
> index 5dea4479240b..e4fb686dfaa9 100755
> --- a/scripts/clang-tools/gen_compile_commands.py
> +++ b/scripts/clang-tools/gen_compile_commands.py
> @@ -170,7 +170,7 @@ def process_line(root_directory, command_prefix, file_path):
> # escape the pound sign '#', either as '\#' or '$(pound)' (depending on the
> # kernel version). The compile_commands.json file is not interepreted
> # by Make, so this code replaces the escaped version with '#'.
> - prefix = command_prefix.replace('\#', '#').replace('$(pound)', '#')
> + prefix = command_prefix.replace(r'\#', '#').replace('$(pound)', '#')
>
> # Return the canonical path, eliminating any symbolic links encountered in the path.
> abs_path = os.path.realpath(os.path.join(root_directory, file_path))
> --
> 2.43.0
>
--
Best Regards
Masahiro Yamada
^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH v2] gen_compile_commands: fix invalid escape sequence warning
2024-02-13 2:25 ` [PATCH v2] gen_compile_commands: fix invalid escape sequence warning Andrew Ballance
2024-02-13 20:00 ` Nicolas Schier
@ 2024-02-14 0:40 ` Justin Stitt
1 sibling, 0 replies; 10+ messages in thread
From: Justin Stitt @ 2024-02-14 0:40 UTC (permalink / raw)
To: Andrew Ballance
Cc: masahiroy, linux-kbuild, linux-kernel-mentees, linux-kernel,
llvm, morbo, nathan, ndesaulniers, nicolas, skhan
Hi,
On Mon, Feb 12, 2024 at 6:28 PM Andrew Ballance
<andrewjballance@gmail.com> wrote:
>
> with python 12.1 '\#' results in this warning
> SyntaxWarning: invalid escape sequence '\#'
Yes, since Python 3.12 escaping invalid characters will result in a
SyntaxWarning.
The complete table of supported escape codes is available here [1].
>
> Signed-off-by: Andrew Ballance <andrewjballance@gmail.com>
> ---
> scripts/clang-tools/gen_compile_commands.py | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/scripts/clang-tools/gen_compile_commands.py b/scripts/clang-tools/gen_compile_commands.py
> index 5dea4479240b..93f64095fda9 100755
> --- a/scripts/clang-tools/gen_compile_commands.py
> +++ b/scripts/clang-tools/gen_compile_commands.py
> @@ -170,7 +170,7 @@ def process_line(root_directory, command_prefix, file_path):
> # escape the pound sign '#', either as '\#' or '$(pound)' (depending on the
> # kernel version). The compile_commands.json file is not interepreted
> # by Make, so this code replaces the escaped version with '#'.
> - prefix = command_prefix.replace('\#', '#').replace('$(pound)', '#')
> + prefix = command_prefix.replace('\\#', '#').replace('$(pound)', '#')
I'd personally prefer using a raw string:
- prefix = command_prefix.replace('\#', '#').replace('$(pound)', '#')
+ prefix = command_prefix.replace(r'\#', '#').replace('$(pound)', '#')
This makes it clear that a literal backslash followed by a literal
pound sign will be replaced.
>
> # Return the canonical path, eliminating any symbolic links encountered in the path.
> abs_path = os.path.realpath(os.path.join(root_directory, file_path))
> --
> 2.43.0
>
[1]: https://docs.python.org/3/reference/lexical_analysis.html#index-23
Thanks
Justin
^ permalink raw reply [flat|nested] 10+ messages in thread
end of thread, other threads:[~2024-02-14 21:28 UTC | newest]
Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-02-13 1:20 [PATCH] gen_compile_commands: fix invalid escape sequence Andrew Ballance
2024-02-13 1:48 ` Masahiro Yamada
2024-02-13 2:25 ` [PATCH v2] gen_compile_commands: fix invalid escape sequence warning Andrew Ballance
2024-02-13 20:00 ` Nicolas Schier
2024-02-14 0:31 ` Justin Stitt
2024-02-14 1:23 ` [PATCH v3 0/1] " Andrew Ballance
2024-02-14 1:23 ` [PATCH v3 1/1] " Andrew Ballance
2024-02-14 18:28 ` Justin Stitt
2024-02-14 21:27 ` Masahiro Yamada
2024-02-14 0:40 ` [PATCH v2] " Justin Stitt
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 NNTP newsgroup(s).