Bug 269191 - Documentation primer update macOS instructions
Summary: Documentation primer update macOS instructions
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-doc (Nobody)
URL: https://docs.freebsd.org/en/books/fdp...
Keywords:
Depends on:
Blocks:
 
Reported: 2023-01-27 20:52 UTC by Ciarán Ainsworth
Modified: 2023-01-28 09:41 UTC (History)
2 users (show)

See Also:


Attachments
Update macOS documentation primer quickstart (1.26 KB, patch)
2023-01-27 20:52 UTC, Ciarán Ainsworth
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Ciarán Ainsworth 2023-01-27 20:52:36 UTC
Created attachment 239748 [details]
Update macOS documentation primer quickstart

I recently followed the instructions to set up the FreeBSD documentation repository and build tools on my MacBook. Some of the instructions don't seem to work correctly due to Homebrew paths. Specifically:

- The instruction for setting up the gem path doesn't work with the current homebrew setup and can be made less brittle by querying "gem environment gemdir"
- The LOCALBASE parameter used with bmake is incorrect for a ruby installed with homebrew
Comment 1 commit-hook freebsd_committer freebsd_triage 2023-01-28 09:39:45 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=5ca051dd3f8798bd3e43820fcf7466ece968b7a0

commit 5ca051dd3f8798bd3e43820fcf7466ece968b7a0
Author:     Ciarán Ainsworth <ciaranainsworth@posteo.net>
AuthorDate: 2023-01-28 09:38:52 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2023-01-28 09:38:52 +0000

    Upgrade macOS instructions in FDP

    PR:     269191

 documentation/content/en/books/fdp-primer/overview/_index.adoc | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Comment 2 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2023-01-28 09:41:53 UTC
Fixed. Thanks for the patch :)