multipass icon indicating copy to clipboard operation
multipass copied to clipboard
verified publisher icon canonical

Revise build instructions

Open ricab opened this issue 10 months ago • 3 comments

Description of documentation issue or suggestion Our build instructions need to be revised, improved, and updated. There are multiple aspects where they are obsolete, inconsistent, or just wrong. Comments on #4110 point out a few examples.

ricab avatar May 26 '25 15:05 ricab

Hi @ricab I would like to help out with this issue. I have looked over the discussion you cited (#4110) and I have gathered the examples pointed out in the comments:

  • Consider the build architecture when specifying the PATH environment variable
  • Consider the build architecture when specifying the path for the DCMAKE_PREFIX_PATH cmake argument
  • Remove mentions of installing QT via brew
  • Either keep "latest stable version" and remove the specific Qt6 version, or keep the version and remove remove reference to "latest stable version"
  • Provide more context in the Enable Hyper-V section since it is not strictly required

Let me know if this issue is meant to capture only the examples cited above or if the scope of this issue involves a larger overhaul of the build instructions. Either way I am happy to help!

dmora4 avatar Jun 02 '25 09:06 dmora4

Hi @dmora4, thank you for your interest! This was meant as an umbrella to cover all problems with the build instructions, but you don't need to fix everything in one go. You could submit PRs dealing with a subset of issues and mention that it "addresses" this issue (rather than "fixes"). See https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue

Of course you can also fix it all 😄 Either way, your contributions would be very welcome!

ricab avatar Jun 02 '25 12:06 ricab

@dmora4 let me know if you working on this, otherwise I can raise a PR addressing the suggested changes.

ayaankhan98 avatar Jun 16 '25 21:06 ayaankhan98

@ayaankhan98 No, I haven't gotten around to it so go right ahead!

dmora4 avatar Jun 18 '25 08:06 dmora4

Hi 👋 I'd love to contribute to this issue.

I’ve reviewed the discussion and would be happy to help by:

  • Removing the outdated Qt via Homebrew reference
  • Clarifying the Qt version requirement (Qt 6.2.4)
  • Adding architecture-specific notes for PATH and CMAKE_PREFIX_PATH
  • Improving the Hyper-V section for clarity

If no one is currently working on this, I'd be grateful for the opportunity to take it forward and will open a PR soon. Please let me know if that sounds good — thank you!

prachimaskar avatar Jun 26 '25 14:06 prachimaskar

Closing this as it was fixed in PR https://github.com/canonical/multipass/pull/4203

geoffreynyaga avatar Oct 24 '25 15:10 geoffreynyaga