docs: Replace non-portable "sed -i" in Makefile #27122
Merged
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
qmonnet
added
area/documentation
|
Heads up that |
|
I didn't know that. OK I'll update with |
We recently added a call to "sed" in Documentation's Makefile, as part of the generation process for the Helm reference. We use the "-i" option to edit the file in-place; but this option is not portable, and the command fails when running BSD versions of sed, for example on MacOS, as opposed to GNU sed. We have two options to fix this: using $(SED), which is set to gsed when available, and using an additional temporary file. Let's use both to have the Makefile as portable as possible. Fixes: 2e9b20f ("docs: Ignore Helm value names for spellcheck") Reported-by: Liz Rice <liz@lizrice.com> Signed-off-by: Quentin Monnet <quentin@isovalent.com>
qmonnet
force-pushed
the
pr/sed-not-inplace
branch
from
52af96c
to
a6ecf8d
Compare
qmonnet
added
needs-backport/1.12
needs-backport/1.13
learnitall
approved these changes
Jul 28, 2023
|
/test |
jibi
approved these changes
Aug 1, 2023
maintainer-s-little-helper
bot
added
the
ready-to-merge
sayboras
added
backport-pending/1.14
maintainer-s-little-helper
bot
moved this from Needs backport from main
to Backport pending to v1.14
in 1.14.1
sayboras
added
backport-pending/1.13
maintainer-s-little-helper
bot
moved this from Needs backport from main
to Backport pending to v1.13
in 1.13.6
maintainer-s-little-helper
bot
moved this from Needs backport from main
to Backport pending to v1.12
in 1.12.13
qmonnet
added
backport-done/1.12
maintainer-s-little-helper
bot
moved this from Backport pending to v1.12
to Backport done to v1.12
in 1.12.13
sayboras
added
backport-done/1.14
maintainer-s-little-helper
bot
moved this from Backport pending to v1.14
to Backport done to v1.14
in 1.14.1
sayboras
added
backport-done/1.13
This was referenced Aug 10, 2023
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.
We recently added a call to
sedin Documentation's Makefile, as part of the generation process for the Helm reference. We use the-ioption to edit the file in-place; but this option is not portable, and the command fails when running BSD versions of sed, for example on MacOS, as opposed to GNU sed.Let's fix the command by using an additional temporary file.
Fixes: 2e9b20f ("docs: Ignore Helm value names for spellcheck")