Ensure strings in config_vars.h are escaped correctly #1530
Conversation
This file contains 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
This is more tricky than it first appears as the strings in question have to make it through make expansion, shell string expansion, interpretation by the command writing the file, and end up making sense to the C compiler. The values are escaped by converting \ to \\, " to \" and ' to \x27 (as it's impossible to quote a ' in a single-quoted string). Writing the file is now done by printf, which won't try to interpret any of the strings being printed as an option. Its arguments are all single-quoted to prevent the shell from trying to expand them in an unwanted manner.
|
I'm a bit uneasy about requiring a command-line printf tool, but it seems to be a defined part of the POSIX environment so I assume it's now everywhere that sed, awk, etc are. Certainly for our own CI. |
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.
This is more tricky than it first appears as the strings in question have to make it through make expansion, shell string expansion, interpretation by the command writing the file, and end up making sense to the C compiler.
The values are escaped by converting
\to\\,"to\"and'to\x27(as it's impossible to quote a'in a single-quoted string). Writing the file is now done byprintf, which won't try to interpret any of the strings being printed as an option. Its arguments are all single-quoted to prevent the shell from trying to expand them in an unwanted manner.Fixes #1527