Page MenuHomeFreeBSD
Files F150432632

D30176.id103314.diff
No OneTemporary
Actions

D30176.id103314.diff
View Options

diff --git a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc
--- a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc
@@ -74,6 +74,12 @@
ePub file format.
|===
+[NOTE]
+====
+On macOS and Linux, GNU Make doesn't work due to the syntax difference.
+Users have to install bmake (Berkeley Make) manually.
+====
+
[[doc-build-rendering-html]]
=== Rendering to html
@@ -214,6 +220,7 @@
These are the tools used to build and install the FDP documentation.
* The primary build tool is man:make[1], specifically Berkeley Make.
+** Therefore, bmake should be installed and used on macOS and Linux.
* Hugo
* AsciiDoctor
* Git
diff --git a/documentation/content/en/books/fdp-primer/overview/_index.adoc b/documentation/content/en/books/fdp-primer/overview/_index.adoc
--- a/documentation/content/en/books/fdp-primer/overview/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/overview/_index.adoc
@@ -115,6 +115,63 @@
. Submit the diff file using the web-based https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Problem Report] system. If using the web form, enter a Summary of _[patch] short description of problem_. Select the Component `Documentation`. In the Description field, enter a short description of the changes and any important details about them. Use the btn:[Add an attachment] button to attach the diff file. Finally, use the btn:[Submit Bug] button to submit your diff to the problem report system.
====
+[[macOS-installation-process]]
+=== macOS installation process
+
+[.procedure]
+====
+[TIP]
+======
+Hugo version 0.90 or higher must be used
+======
+
+. Use Homebrew to install these packages.
++
+[source,shell]
+....
+$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+$ brew install hugo ruby git bmake asciidoctor
+$ echo 'export PATH="/usr/local/opt/ruby/bin:$PATH"' >> ~/.zshrc
+$ sudo gem install rouge
+....
++
+. Install a local working copy of the documentation from the FreeBSD repository in [.filename]#~/doc# (see crossref:working-copy[working-copy,The Working Copy]).
++
+[source,shell]
+....
+% git clone https://git.FreeBSD.org/doc.git ~/doc
+....
++
+. Edit the documentation files that require changes. If a file needs major changes, consult the mailing list for input.
++
+Review the output and edit the files to fix any problems shown, then rerun the command to find any remaining problems.
+Repeat until all of the errors are resolved.
++
+. Always build and test the changes before submitting them. Running `bmake` in the top-level directory of the documentation will generate that documentation in HTML format.
++
+[source,shell]
+....
+% bmake run LOCALBASE=/usr
+....
++
+. When changes are complete and tested, generate a diff file:
++
+[source,shell]
+....
+% cd ~/doc
+% git diff > bsdinstall.diff
+....
++
+Give the diff file a descriptive name.
++
+. Submit the diff file using the web-based https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Problem Report] system.
+If using the web form, enter a Summary of _short description of problem_.
+Select the Component `Documentation`.
+In the Description field, enter a short description of the problem in the _Summary_ field and add _patch_ to the _Keywords_ field.
+Use the btn:[Add an attachment] button to attach the diff file.
+Finally, use the btn:[Submit Bug] button to submit your diff to the problem report system.
+====
+
[[gnu-linux-installation-process]]
=== GNU/Linux installation process

File Metadata

Mime Type
text/plain
Expires
Thu, Apr 2, 4:55 AM (10 h, 21 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
30704973
Default Alt Text
D30176.id103314.diff (3 KB)

Event Timeline