osbuild/copy: add TODO comment related to GenCopyFSTreeOptions()

The `GenCopyFSTreeOptions()` function has unused argument
`inputPipeline`. After discussing this with @achilleas-k, we determined
that it would be for the best to refactor this function and split out
the part that generates Mounts and Devices and instead return the actual
Stage from it. The reason for splitting out Mounts and Devices is that
these are then reused also by other stages when constructing pipelines
inside composer.

This would be a bigger change, so just adding the comment to the code to
capture this future work.

Signed-off-by: Tomáš Hozza <thozza@redhat.com>
This commit is contained in:
Tomáš Hozza 2023-01-31 11:39:15 +01:00 committed by Sanne Raymaekers
parent b68cf83a8e
commit 772a131d35

View file

@ -42,6 +42,12 @@ func NewCopyStageSimple(options *CopyStageOptions, inputs Inputs) *Stage {
// GenCopyFSTreeOptions creates the options, inputs, devices, and mounts properties
// for an org.osbuild.copy stage for a given source tree using a partition
// table description to define the mounts
//
// TODO: the `inputPipeline` parameter is not used. We should instead split out
// the part that creates Devices and Mounts into a separate functions
// such as `GenFSMounts()` and `GenFSMountsDevices()` and take their output
// as parameters. Also we should be returning the final stage from this
// function, not just the options, devices, and mounts.
func GenCopyFSTreeOptions(inputName, inputPipeline, filename string, pt *disk.PartitionTable) (
*CopyStageOptions,
*Devices,