When we build our documentation and website we use a hacked version
of www/gohugo that allows for arbitrary asciidoc extensions.
This was added as a patch in r562416.
The suggested pull request[1] this patch was based on was not
accepted "as is" and only allows the execution of extensions in
Ruby's $LOAD_PATH.
With these changes, we add our <docroot>shared/lib directory to
Ruby's library directory so we can load our custom extensions. This
also allows building the docs and website outsite FreeBSD using
upstream and unmodified tools.
Tested with the upcoming vanilla gohugo-0.82 provided by
gohugo's maintainer.
[1] https://github.com/gohugoio/hugo/pull/8131
Patch by: fernape@
Differential Revision: https://reviews.freebsd.org/D29410
# Uncomment and complete these metadata fields, as appropriate:
#
# PR:
# Submitted by:
# Reported by:
# Reviewed by:
# Approved by:
# Obtained from:
# MFC after:
# MFH:
# Relnotes:
# Security:
# Sponsored by:
# Pull Request:
# Differential Revision:
#
# Description of fields to fill in above: 72 columns --|
# PR: If and which Problem Report is related.
# Submitted by: If someone else sent in the change.
# Reported by: If someone else reported the issue.
# Reviewed by: If someone else reviewed your modification.
# Approved by: If you needed approval for this commit.
# Obtained from: If the change is from a third party.
# MFC after: N [day[s]|week[s]|month[s]]. Request a reminder email.
# MFH: Ports tree branch name. Request approval for merge.
# Relnotes: Set to 'yes' for mention in release notes.
# Security: Vulnerability reference (one per line) or description.
# Sponsored by: If the change was sponsored by an organization.
# Pull Request: https://github.com/freebsd/<repo>/pull/### (*full* GitHub URL needed).
# Differential Revision: https://reviews.freebsd.org/D### (*full* phabric URL needed).
Since etcupdate(8) has lived in base since 10.0 and seen plenty of use
by both committers and contributors, it's time to recommend using it.
Reviewed by: jhb (prior version)
Differential Revision: https://reviews.freebsd.org/D27848
bsdl-gpl: style line
building products: style line and fix images path
committers-guide: style line, convert some MarkDown
links to Asciidoc and upgrade some entries still making
reference to the old Docbook tech.
Document that we try to follow SPDX 2.2 for the SPDX-License-Idneitfier: tags
that are in the source. Note that they are informative only. Give pointers to
the standards and a status of the files marked in-tree.
Suggestions by: Pau Amma
Differential Revision: https://reviews.freebsd.org/D29330
Lots of wording improvements, grammar errors, punctuation error and wrong word
fixes. Also, do some limited one sentence one line (1s1l) conversion.
Submitted by: Pau Amma (though not the 1s1l stuff).
Don't say there are two options and then give only one. Update that
sentence to reflect where the project seems to have landed in terms of
how to do MFCs. The original was written prior to the transtion and the
existing practice has shifted to cherry-pick -x almost exclusively.
Highlight MFC to a branch needing approval
Rearrange a couple sections to improve document structure.
Change some enumeration lists to bulleted lists since I think that looks nicer.
Fix a few typos and reformat a few paragraphs to one line per sentence
style. Try to use repository insteast of 'repo' or even 'source of
truth'. Clarify a few places and fix some grammar errors.
Submitted by: Pau Amma
Add git commit --amend with a comment about doing a final check of the commit
message before the push. Update with some more specific guidance on a good
commit message. Add link to commit message section. Minor tweaks I noticed
while doing this as well for having one setence one line.
Submitted by cy@
Add in the git minirpimer from my github. It contains the basics that
you'll need to track the tree and/or contribute.
Contributions by: rwatson@, Rainer Hurling, jhb@, Ceri Davies, lwhsu@,
chuck@, Robert Gogolok
They haven't worked for years in the way described, and following
further advice online to enable VESA results in an unbootable system!
It can be put back when vt(4) supports them.
PR: kern/210432
Add in the migrating from the old subversion / git docs. This section
should be removed in a few months maybe.
Contributions by: lwshu@, Alexander Richardson, kib@, Ceri Davies
Use angle brackets instead of italic to denote mandatory fields after
"freebsd/developer/" blocks. "freefall name" and "NickServ name" are
also renamed to "freefall username"` and "FreeNode account".
Reviewed by: debdrup, ygy, lwhsu
Approved by: philip (mentor)
Differential Revision: https://reviews.freebsd.org/D29285
Integreate MFC procedures into the committer's handbook. This was originally in
my freebsd-git-docs repo where it was collaberatively created. The changes here
are light edits and a conversion from markdown to asciidoc.
Contributions from: jhb@, lwhsu@, delphij@, Ceri Davies, Alexandre
Fix a number of typos. Note why one would prefer publishing a repo over
phabricator. Try to minimize use of contractions. Clarify the mysterious 'source
of truth' phrase.
Noticed by: Pau Amma (except the contractions)
Vendor branch managed belongs in the comitter guide, as it is relevant to
comitters and not to the larger community of people developing for FreeBSD,
which the developer's guide more genereal development.
It is no longer relevant to the day-to-day operations of the project. It's all
done with git now. We have the old content in the doc repo should someone need
this information in the future.
Sergio Carlavilla Delgado
Chris Rees
Rene Ladan
Raphael Kubo da Costa
Dries Michiels
Ed Maste
Warner Losh
Ka Ho Ng
Benjamin Kaduk
Li-Wen Hsu