Escape CBMC makefile help path separators - #1353
Merged
rawalexe merged 1 commit intoJul 9, 2026
Merged
Conversation
rawalexe
force-pushed
the
codex/cbmc-makefile-docstring-escape
branch
from
July 8, 2026 17:28
14efabd to
228bc03
Compare
rawalexe
approved these changes
Jul 8, 2026
cookpate
approved these changes
Jul 8, 2026
Escape the backslashes in the Windows include path example so Python does not emit a SyntaxWarning for an invalid escape sequence while keeping the rendered help text unchanged. Signed-off-by: Old-Ding <ai.neo.ae86@gmail.com>
Old-Ding
force-pushed
the
codex/cbmc-makefile-docstring-escape
branch
from
July 9, 2026 01:43
228bc03 to
977055d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The CBMC makefile generator help text includes a Windows path example with single backslashes inside a normal Python string literal. Python reports this as an invalid escape sequence
SyntaxWarning.This escapes the backslashes in the source string while keeping the rendered help text unchanged.
Test Steps
python -W error::SyntaxWarning -m py_compile test/cbmc/proofs/make_proof_makefiles.pypython test/cbmc/proofs/make_proof_makefiles.py --helpand verified theH_INC = /Imy\cool\directoryhelp output is unchanged.SyntaxWarningpromoted to errors reportsTOTAL 0.git diff --check -- test/cbmc/proofs/make_proof_makefiles.pygit ls-files --eol test/cbmc/proofs/make_proof_makefiles.pyDuplicate check:
make_proof_makefiles,SyntaxWarning, orinvalid escape.Checklist:
Related Issue
N/A
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.