Skip to content

HDDS-13877. Fix and tweak Apple silicon protobuf 2.5.0 build section#9242

Merged
jojochuang merged 7 commits intoapache:masterfrom
smengcl:HDDS-13877-doc
Dec 11, 2025
Merged

HDDS-13877. Fix and tweak Apple silicon protobuf 2.5.0 build section#9242
jojochuang merged 7 commits intoapache:masterfrom
smengcl:HDDS-13877-doc

Conversation

@smengcl
Copy link
Copy Markdown
Contributor

@smengcl smengcl commented Nov 3, 2025

What changes were proposed in this pull request?

There is a cd .. command that is not necessary. Fixed in HDDS-13931

The file modification step can be more streamlined. Along with other tweaks and fixes.

Note: Ozone 2.2.0 and on will not need the protobuf 2.5.0 build steps because protobuf 2.5.0 is no longer a dependency. Ozone 2.1.x and earlier will still need this step for devs.

What is the link to the Apache JIRA

https://issues.apache.org/jira/browse/HDDS-13877

How was this patch tested?

  • Tested manually on a fresh M4 MacBook Air.

@smengcl smengcl requested a review from Copilot November 3, 2025 21:26
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR simplifies and improves the documentation for building Ozone from source on ARM-based Apple Silicon Macs. The main focus is on streamlining the protobuf 2.5.0 setup process for macOS ARM64 systems.

  • Automated the protobuf patching process by replacing manual file editing with a sed command
  • Removed the PROTOBUF_VERSION variable in favor of hardcoded version strings for consistency with other sections
  • Updated terminology and processor model references

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread hadoop-hdds/docs/content/start/FromSource.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@smengcl smengcl requested a review from Copilot November 3, 2025 21:28
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread hadoop-hdds/docs/content/start/FromSource.md Outdated
Comment thread hadoop-hdds/docs/content/start/FromSource.md
@smengcl smengcl marked this pull request as ready for review November 3, 2025 21:30
@smengcl smengcl requested a review from jojochuang November 3, 2025 21:30
Comment thread hadoop-hdds/docs/content/start/FromSource.md Outdated
Comment thread hadoop-hdds/docs/content/start/FromSource.md Outdated
Comment thread hadoop-hdds/docs/content/start/FromSource.md Outdated
@adoroszlai adoroszlai added the documentation Improvements or additions to documentation label Nov 4, 2025
@errose28
Copy link
Copy Markdown
Contributor

Is this intended to match the steps on the new website?

@adoroszlai
Copy link
Copy Markdown
Contributor

Thanks @smengcl for the fix. Unnecessary cd .. has been removed in HDDS-13931 as a simple targeted fix. This PR can be updated for the remaining improvements.

I agree with @bdemers suggestion in #9295: sed is better than manual edits, but patch is even better.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Dec 6, 2025

This PR has been marked as stale due to 21 days of inactivity. Please comment or remove the stale label to keep it open. Otherwise, it will be automatically closed in 7 days.

@github-actions github-actions Bot added the stale label Dec 6, 2025
@smengcl smengcl removed the stale label Dec 9, 2025
Conflicts:
hadoop-hdds/docs/content/start/FromSource.md
@smengcl
Copy link
Copy Markdown
Contributor Author

smengcl commented Dec 9, 2025

Is this intended to match the steps on the new website?

ah yup, that needs to be updated as well. Will file another PR for that. Thanks for the reminder.

@smengcl smengcl marked this pull request as draft December 9, 2025 22:02
@smengcl
Copy link
Copy Markdown
Contributor Author

smengcl commented Dec 9, 2025

Thanks @smengcl for the fix. Unnecessary cd .. has been removed in HDDS-13931 as a simple targeted fix. This PR can be updated for the remaining improvements.

I agree with @bdemers suggestion in #9295: sed is better than manual edits, but patch is even better.

I like the idea. I have replaced sed with an inline patch. ptal.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread hadoop-hdds/docs/content/start/FromSource.md Outdated
@smengcl smengcl requested a review from Copilot December 9, 2025 22:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@smengcl smengcl marked this pull request as ready for review December 9, 2025 22:47
@smengcl smengcl requested a review from jojochuang December 10, 2025 19:15
@smengcl
Copy link
Copy Markdown
Contributor Author

smengcl commented Dec 10, 2025

Would you like to take a look @adoroszlai ?

Copy link
Copy Markdown
Contributor

@adoroszlai adoroszlai left a comment

Choose a reason for hiding this comment

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

Thanks @smengcl for updating the doc, LGTM. Steps for downloading and patching protobuf worked fine.

This reminds me: Protobuf 2.5 is no longer used on master, but it could be useful when working with backports or releases before 2.2.

@jojochuang
Copy link
Copy Markdown
Contributor

Let's update the v2 doc and remove the protobuf 2.5 instructions there.
v1 doc will soon be deprecated (hopefully this time for real)

@jojochuang jojochuang merged commit 6670572 into apache:master Dec 11, 2025
33 checks passed
@smengcl
Copy link
Copy Markdown
Contributor Author

smengcl commented Dec 12, 2025

Let's update the v2 doc and remove the protobuf 2.5 instructions there. v1 doc will soon be deprecated (hopefully this time for real)

We still need this for Ozone 2.1 dev. It is no longer necessary from 2.2 and onwards.

@smengcl
Copy link
Copy Markdown
Contributor Author

smengcl commented Dec 12, 2025

Thanks @jojochuang @adoroszlai for reviewing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants