Skip to content

Assorted fixes #319

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Assorted fixes #319

wants to merge 3 commits into from

Conversation

cfergeau
Copy link
Collaborator

@cfergeau cfergeau commented Jun 5, 2025

One doc fix reported in containers/krunkit#51 (comment)
One consistency fix reported in #317 (comment)
And silencing of 2 debug-looking logs.

Summary by Sourcery

Silence nonessential logs, standardize script flag naming, and improve documentation clarity for the RESTful service default

Enhancements:

  • Downgrade startup options and boot parameters logging from info to debug
  • Unify pid-file flag style in start-gvproxy script for consistency

Documentation:

  • Clarify in usage documentation that the RESTful service is disabled by default

Copy link

sourcery-ai bot commented Jun 5, 2025

Reviewer's Guide

Lowered verbosity for startup logs, standardized flag formatting in the gvproxy script, and corrected the default RESTful URI description in the usage documentation.

File-Level Changes

Change Details Files
Silenced startup info logging in vfkit command by switching to debug level
  • Replaced log.Info(opts) with log.Debugf for parsed options
  • Replaced log.Infof boot parameters log with log.Debugf
cmd/vfkit/main.go
Standardized flag usage and spacing in start-gvproxy script
  • Removed extra space before -log-file option
  • Changed --pid-file to -pid-file for consistency
contrib/scripts/start-gvproxy.sh
Updated RESTful URI default description in usage documentation
  • Removed default tcp://localhost:8081 URI
  • Rephrased default RESTful service as disabled
doc/usage.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@openshift-ci openshift-ci bot requested review from baude and lstocchi June 5, 2025 16:25
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @cfergeau - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@@ -23,7 +23,7 @@ set -exuo pipefail
DISK_IMAGE="${1?Usage: $0 diskimage}"
VM_NAME="$(basename ${DISK_IMAGE})"

${GVPROXY} -mtu 1500 -ssh-port 2223 -listen-vfkit unixgram://$(pwd)/${VM_NAME}.sock -log-file ${VM_NAME}.gvproxy.log --pid-file ${VM_NAME}.gvproxy.pid &
${GVPROXY} -mtu 1500 -ssh-port 2223 -listen-vfkit unixgram://$(pwd)/${VM_NAME}.sock -log-file ${VM_NAME}.gvproxy.log -pid-file ${VM_NAME}.gvproxy.pid &
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would use -- for all commands since it is more consistent with other commands in this file, and most commands, but this is good enough.

@openshift-ci openshift-ci bot added the lgtm label Jun 5, 2025
Copy link

openshift-ci bot commented Jun 5, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: nirs
Once this PR has been reviewed and has the lgtm label, please assign lstocchi for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

cfergeau added 3 commits June 5, 2025 18:53
They are dumping some internal data structures using %+v which is not
very user friendly.

Signed-off-by: Christophe Fergeau <[email protected]>
By default it’s set to `none://`:

```
pkg/cmdline/cmdline.go:const DefaultRestfulURI = "none://"
```

Signed-off-by: Christophe Fergeau <[email protected]>
@nirs
Copy link
Collaborator

nirs commented Jun 5, 2025

/lgtm

@openshift-ci openshift-ci bot added the lgtm label Jun 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants