Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:6 as permitted sender) client-ip=2620:137:e000::3:6;
Feedback-ID: i7a7146c5:Fastmail
From:   Jeremy Cline <jeremy@jcline.org>
To:     Nathan Chancellor <nathan@kernel.org>,
        Nick Desaulniers <ndesaulniers@google.com>
Cc:     Tom Rix <trix@redhat.com>, llvm@lists.linux.dev,
        linux-kernel@vger.kernel.org, Jeremy Cline <jeremy@jcline.org>
Subject: [PATCH] gen_compile_commands: use raw string when replacing \#
Date:   Fri, 29 Sep 2023 15:04:46 -0400
Message-ID: <20230929190446.113168-1-jeremy@jcline.org>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

I noticed this since I'm running Python 3.12-rc3, which emits
"SyntaxWarning: invalid escape sequence '\#'" when running this script.
According to the Python 3.12 release notes this will eventually become a
SyntaxError.

Based on the comment in the code, I believe the intention was to match
the literal string "\#". Marking it as a raw string will stop Python
from trying to treat it as an escape sequence and behave as intended.

Signed-off-by: Jeremy Cline <jeremy@jcline.org>
---
 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 a84cc5737c2c..bc005cac1944 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)', '#')
 
     # Use os.path.abspath() to normalize the path resolving '.' and '..' .
     abs_path = os.path.abspath(os.path.join(root_directory, file_path))
-- 
2.41.0