manifests: switch to using documentation: false#4076
manifests: switch to using documentation: false#4076dustymabe wants to merge 4 commits intocoreos:testing-develfrom
Conversation
We stopped removing this binary in 13f7a3c.
We moved the symlink cleanup from ignition-and-ostree.yaml and it's now in a postprocess at the bottom of this file (fedora-coreos.yaml) which means it will actually still exist when running this code. Rather than move the postprocess up let's just remove this as the broken symlink from the build id isn't a big deal and we ignore broken symlinks for /usr/lib/.build-id in our validate-symlinks test.
Let's just rely on the underlying `--nodocs` mechanisms of rpm-ostree
(really libdnf) here. This does mean we will ship some broken symlinks
but it's OK as we'll just add exceptions to our broken symlinks test.
With this change there are a bunch more folders that are shipped under
/usr/share/{doc,info,man}, but they are just empty so should be harmless.
The linked BZ has long been closed: https://bugzilla.redhat.com/show_bug.cgi?id=2297094
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request refactors the documentation removal process by using the documentation: false manifest setting, removing the need for post-processing scripts to delete documentation files. While this simplifies the configuration, a potential issue has been identified where a removed script also performed cleanup of non-documentation-related broken symlinks. This functionality might be lost, potentially introducing new broken symlinks into the image. The symlink validation test has been updated to accommodate broken links to documentation, but not these other cases.
|
|
There was a problem hiding this comment.
The script removed here (lines 118-149) also cleaned up broken symlinks pointing to non-documentation binaries like /usr/bin/systemd-firstboot and /usr/lib/systemd/system-generators/systemd-gpt-auto-generator. The documentation: false change only makes the documentation-related cleanup redundant. Since the validate-symlinks test is only being updated for documentation paths, removing this script entirely could introduce new unhandled broken symlinks. The cleanup logic for non-documentation paths should be preserved if those binaries are still being removed.
|
cc @travier since you originally opened openshift/os#1003 I think my argument here is that we try to drain as much as we can out of our postprocess over time so our delta become less and less. These scripts seem like a good candidate. If this merges we'd follow up with a similar change over in rhel-coreos-config. |
|
for the CI failure: coreos/coreos-assembler#4505 |
1 participant
Let's just rely on the underlying
--nodocsmechanisms ofrpm-ostree(really
libdnf) here. This does mean we will ship some broken symlinksbut it's OK as we'll just add exceptions to our broken symlinks test.
With this change there are a bunch more folders that are shipped under
/usr/share/{doc,info,man}, but they are just empty so should be harmless.
See individual commit messages for each commit in this series.
Here is the diff of files when applying this change:
Details