FreeBSD/doc
1
0
Fork 0
mirror of https://git.FreeBSD.org/doc.git synced 2026-06-02 11:25:20 +00:00
Code Issues Projects Releases Wiki Activity

Makefiles: Reflow

Browse Source 
Minor grammar touch-ups to some comments as well.

Differential Revision:	https://reviews.freebsd.org/D54212
This commit is contained in:
Alexander Ziaee
2026-05-21 10:58:05 -04:00
parent c1e1241961
commit 714148a116
3 changed files with 64 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Makefile
+9 -8
View File
@@ -1,16 +1,17 @@
#
# This file is intended to drive the build of the entire doc tree. In order to
# build both the documentation and the website, one only need to execute:
# This file is intended to drive the build of the entire doc tree. In
# order to build both the documentation and the website, one only needs
# to execute:
#
# make all
#
# Here at the top-level of the repository. The same target may be executed in
# the individual directories to build just the documentation or just the
# website.
# Here at the top-level of the repository. The same target may be
# executed in the individual directories to build just the documentation
# or just the website.
#
# Note that the Makefiles within the individual components may also be used to
# spin up hugo's internal webserver for testing, by default on port 1313. This
# can be done with the `run` target.
# Note that the Makefiles within the individual components may also be
# used to spin up hugo's internal webserver for testing, by default on
# port 1313. This can be done with the `run` target.
#
SUBDIR+= documentation
documentation/Makefile
+26 -22
View File
@@ -3,24 +3,24 @@
# Copyright (c) 2020-2026, The FreeBSD Documentation Project
# Copyright (c) 2020-2026, Sergio Carlavilla <carlavilla@FreeBSD.org>
#
# Targets intended for use on the command line
# Targets intended for use on the command line:
#
# all (default) - generate books and articles without generating the
# PDFs or EPUBs
# clean - removes generated files
# run - serves the built documentation site for local browsing
# pdf - build PDF versions of the articles and books.
# html - build HTML versions of the articles and books for
# offline use.
# If variable DOC_HTML_ARCHIVE is set, all documents will be
# archived/compressed, and only these files will be kept in the
# public directory.
# epub - build EPUB versions of the articles and books (Experimental).
# all (default) - Generate books and articles without generating
# PDFs or EPUBs.
# clean - Remove generated files.
# run - Serve the built documentation site locally.
# pdf - Build PDF versions of the articles and books.
# html - Build HTML versions of the articles and books.
# If the DOC_HTML_ARCHIVE variable is set, all
# documents will be archived/compressed, and only
# these files will be kept in public/.
# epub - Build EPUB versions of the articles and books
# (Experimental).
#
# The run target uses hugo's built-in webserver to make the documentation site
# available for local browsing. The documentation should have been built prior
# to attempting to use the `run` target. By default, hugo will start its
# webserver on port 1313.
# The run target uses hugo's built-in webserver to make the doc site
# available for local browsing. The documentation should have been
# built prior to attempting to use the `run` target. By default, hugo
# will start its webserver on port 1313.
MAINTAINER=carlavilla@FreeBSD.org
@@ -30,7 +30,8 @@ ARTICLEONLY_LANGS= bn-bd da id ko tr
BOOKONLY_LANGS= mn
# List of all languages we have content for
ALL_LANGUAGES= bn-bd da de el en es fr hu id it ja ko mn nl pl pt-br ru tr zh-cn zh-tw
ALL_LANGUAGES= bn-bd da de el en es fr hu id it ja ko mn nl \
pl pt-br ru tr zh-cn zh-tw
LOCALBASE?= /usr/local
USE_RUBYGEMS?= NO
@@ -79,14 +80,14 @@ RUN_DEPENDS= ${HUGO_CMD} \
.endif
# Strip the languages with only articles from the list of languages we
# will use to build books.
# will use to build books
BOOK_LANGS= ${LANGUAGES}
.for a in ${ARTICLEONLY_LANGS}
BOOK_LANGS:= ${BOOK_LANGS:N${a}}
.endfor
# Strip the languages with only books from the list of languages we
# will use to build articles.
# will use to build articles
ARTICLE_LANGS= ${LANGUAGES}
.for a in ${BOOKONLY_LANGS}
ARTICLE_LANGS:= ${ARTICLE_LANGS:N${a}}
@@ -161,7 +162,8 @@ hugo-clean: .PHONY
#
# PDF targets
# Use DOC_LANG to choose the language, e.g., make DOC_LANG="en fr" pdf-books
# Use DOC_LANG to choose the language,
# e.g., make DOC_LANG="en fr" pdf-books
#
pdf: pdf-articles pdf-books
@@ -196,7 +198,8 @@ pdf-articles-clean:
#
# HTML targets
#
html: build-offline html-clean-global html-clean-articles html-clean-books html-archive html-archive-clean-files
html: build-offline html-clean-global html-clean-articles \
html-clean-books html-archive html-archive-clean-files
html-clean: hugo-clean
@@ -233,7 +236,8 @@ html-archive-clean-files:
#
# EPUB targets
# Use DOC_LANG to choose the language, e.g., make DOC_LANG="en fr" epub-books
# Use DOC_LANG to choose the language,
# e.g., make DOC_LANG="en fr" epub-books
#
epub: epub-articles epub-books
website/Makefile
+7 -7
View File
@@ -3,15 +3,15 @@
# Copyright (c) 2020-2026, The FreeBSD Documentation Project
# Copyright (c) 2020-2026, Sergio Carlavilla <carlavilla@FreeBSD.org>
#
# Targets intended for use on the command line
# Targets intended for use on the command line:
#
# all (default) - generate the releases.toml and compile all the website
# run - serves the built website for local browsing
# all (default) - Generate releases.toml and compile the website.
# run - Serve the built website for local browsing.
#
# The run target uses hugo's built-in webserver to make the built website
# available for local browsing. The website should have been built prior
# to attempting to use the `run` target. By default, hugo will start its
# webserver on port 1313.
# The run target uses hugo's built-in webserver to make the built
# website available for local browsing. The website should have been
# built prior to attempting to use the `run` target. By default, hugo
# will start its webserver on port 1313.
MAINTAINER=carlavilla@FreeBSD.org