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

change(docs): Update Zebra's build instructions #6273

Merged
merged 1 commit into from
Mar 8, 2023

Conversation

upbqdn
Copy link
Member

@upbqdn upbqdn commented Mar 7, 2023


Motivation

Building Zebra requires the pkg-config tool, which wasn't mentioned in the build instructions. The tool is required by the pkg-config crate here. As part of the solution, I tried to refine the build instructions.

Solution

This PR:

  • adds pkg-config to the build dependencies;
  • adds a specific example of installing dependencies for Arch;
  • renames the Build Instructions section to Building Zebra for consistency with other sections
  • moves the Optional Features subsection into the Building Zebra section, and consolidates all Zebra's build features;
  • explicitly states that users can combine the features;
  • contains a bunch of additional small edits.

Reviewer Checklist

  • Will the PR name make sense to users?
    • Does it need extra CHANGELOG info? (new features, breaking changes, large changes)
  • Are the PR labels correct?
  • Does the code do what the ticket and PR says?
    • Does it change concurrent code, unsafe code, or consensus rules?
  • How do you know it works? Does it have tests?

@upbqdn upbqdn requested a review from a team as a code owner March 7, 2023 19:00
@upbqdn upbqdn requested review from oxarbitrage and removed request for a team March 7, 2023 19:00
@github-actions github-actions bot added the C-enhancement Category: This is an improvement label Mar 7, 2023
@upbqdn upbqdn added C-bug Category: This is a bug A-docs Area: Documentation P-Low ❄️ labels Mar 7, 2023
@upbqdn upbqdn self-assigned this Mar 7, 2023
@upbqdn upbqdn removed the C-bug Category: This is a bug label Mar 7, 2023
Copy link
Contributor

@oxarbitrage oxarbitrage left a comment

Choose a reason for hiding this comment

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

Changes looks good to me, thanks!

@mergify mergify bot merged commit 36919be into main Mar 8, 2023
@mergify mergify bot deleted the update-build-instructions branch March 8, 2023 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation C-enhancement Category: This is an improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants