Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quadlet - do not look for line continuation in comment lines #21556

Merged
merged 1 commit into from
Feb 8, 2024

Conversation

ygalblum
Copy link
Contributor

@ygalblum ygalblum commented Feb 8, 2024

Does this PR introduce a user-facing change?

No

None

Resolves: #21555

Copy link
Contributor

openshift-ci bot commented Feb 8, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ygalblum

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 8, 2024
for len(data) > 0 && line[len(line)-1] == '\\' {
line, data = nextLine(origdata, len(line)+1)
nLines++
if !lineIsComment(line) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know much about quadlet, so this may be a stupid question: why is this not:

    if lineIsComment(line) {
        next iteration
    }

Is there metadata in comments? Special handling of some sort? It makes me super uncomfortable to see in-loop handling of comments instead of just immediate discard.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. In its current behavior, Quadlet copies the comments from the input file into the generated .service file. For this reason it handles such lines and does not skip them.
Since I didn't want to change the behavior, I just made it disregard any possible line continuation character in comments

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The passing on of comments is nice, because they will then end up in the generated service file which can sometimes be shown by systemd.

Copy link
Member

@Luap99 Luap99 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mheon
Copy link
Member

mheon commented Feb 8, 2024

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 8, 2024
@openshift-merge-bot openshift-merge-bot bot merged commit 5311233 into containers:main Feb 8, 2024
79 of 82 checks passed
@ygalblum ygalblum deleted the quadlet-comment-line branch February 8, 2024 20:02
@stale-locking-app stale-locking-app bot added the locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. label May 9, 2024
@stale-locking-app stale-locking-app bot locked as resolved and limited conversation to collaborators May 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. release-note-none
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Quadlet - Line continuation character '/' at the end of a comment line causes infinite loop
5 participants