Skip to content

Escape CBMC makefile help path separators - #1353

Merged
rawalexe merged 1 commit into
FreeRTOS:mainfrom
Old-Ding:codex/cbmc-makefile-docstring-escape
Jul 9, 2026
Merged

Escape CBMC makefile help path separators#1353
rawalexe merged 1 commit into
FreeRTOS:mainfrom
Old-Ding:codex/cbmc-makefile-docstring-escape

Conversation

@Old-Ding

@Old-Ding Old-Ding commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

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.py
  • python test/cbmc/proofs/make_proof_makefiles.py --help and verified the H_INC = /Imy\cool\directory help output is unchanged.
  • Repository Python warning scan with SyntaxWarning promoted to errors reports TOTAL 0.
  • git diff --check -- test/cbmc/proofs/make_proof_makefiles.py
  • git ls-files --eol test/cbmc/proofs/make_proof_makefiles.py

Duplicate check:

  • No open PR or issue found for make_proof_makefiles, SyntaxWarning, or invalid escape.

Checklist:

  • I have tested my changes. No regression in existing tests.
  • I have modified and/or added unit-tests to cover the code changes in this Pull Request.

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.

@rawalexe
rawalexe force-pushed the codex/cbmc-makefile-docstring-escape branch from 14efabd to 228bc03 Compare July 8, 2026 17:28
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
Old-Ding force-pushed the codex/cbmc-makefile-docstring-escape branch from 228bc03 to 977055d Compare July 9, 2026 01:43
@rawalexe
rawalexe merged commit 115ab52 into FreeRTOS:main Jul 9, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants