release: escape spaces in filenames with METALOG
Needs RevisionPublic
Actions

Authored by khorben on Mon, Sep 14, 5:37 PM.

Details

Reviewers

andrew
jrtc27

Group Reviewers

pkg
releng

Summary

When generating release images, the METALOG option of pkg(8) is used to list the contents of binary packages installed in the image created. The resulting output is provided to makefs(8) as part of the mtree specfile describing the files. However, spaces in filenames are not escaped and confuse the parser.

These changes introduce an awk(1) script, escaping the part of the METALOG file before the first tag (type=) is encountered, when used by
makefs(8).

Affects and fixes amd64, arm64, and i386; tested on FreeBSD/amd64.

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Event Timeline

khorben created this revision.Mon, Sep 14, 5:37 PM

Herald added a reviewer: andrew. · View Herald TranscriptMon, Sep 14, 5:37 PM

Herald added a reviewer: andrew. · View Herald Transcript

Herald added subscribers: ivy, jrtc27, emaste, imp. · View Herald Transcript

khorben requested review of this revision.Mon, Sep 14, 5:37 PM

Adding pkg for review, since this might really be a bug with the -o METALOG option in pkg(8).

i'm curious why we have files with spaces in on the release to begin with. where do those come from?

ivy added a reviewer: releng.Mon, Sep 14, 8:32 PM

In D59670#1369462, @ivy wrote:

i'm curious why we have files with spaces in on the release to begin with. where do those come from?

We do not :)

But if someone creates a custom image with extra packages (like I do e.g., for the graphical installer) and these packages contain files with spaces in the filename (like lcms2, a dependency for Gtk+ 3) then we have the issue.

So this is by no means a release blocker, but it's a nice to have for more advanced uses and downstreams extending the build system.

Um, yeah, if pkg produces a METALOG that is not readable by makefs, due to not escaping the whitespace, that's a bug in pkg to fix in pkg? And it's impossible to reliably escape at this point, because it is inherently ambiguous whether what comes after the space is a continuation of the path or a new key=value pair. So we really should not be trying to guesstimate what the correct METALOG entry is.

This revision now requires changes to proceed.Tue, Sep 15, 10:42 AM