Adds an example on howto configure OpenSMPTD to forward
locally sent mails to FreeBSD.org mail servers.
Approved by: crees, imp
Differential Revision: https://reviews.freebsd.org/D29574
FreeBSD committers no longer need to know how to use subversion.
Remove the subversion primer from the committer's guide.
Add a VCS history section.
Suggestions by: lwhsu@
Differential Revision: https://reviews.freebsd.org/D29610
- Remove notes that the migration is in progress
- Remove old branch names and URLs
- Remove mention of psvn
- Remove section about re-adding a deleted port, git add will do the
right thingn natively (most of the times).
- Remove section about repo-copies, git has no copy command.
- Simplify instructions for moving a port.
- Remove section about the mfh tool. Merges are now just cherry-picks.
Reviewed by: crees, emaste, imp, lwhsu, mat
Differential Revision: https://reviews.freebsd.org/D29450
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
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.
- Add `Reported by`, `Tested by`, `Fixes`, `MFH`.
- Mention that `Submitted by` is typically not used with git.
- Add more cases to `Approved by`.
- Move `Sponsored by:` to the same place it appears in the template.
Reviewed by: debdrup
Approved by: debdrup
Sponsored by: The FreeBSD Foundation
Differential Revision: https://reviews.freebsd.org/D28905
Provide some guidance on good git commit messages. Based on an article
I wrote, with further editing and feedback by imp in the temporary git
docs repo.
Reviewed by: debdrup, imp
Approved by: debdrup
Differential Revision: https://reviews.freebsd.org/D28815
Do the easy git updates for URLs and branch names. Note svn guide
is just for ports (but don't edit out the src specific bits
since we'll dump it wholesale in 2 months). Add pointer to my
draft docs until they can all be integrated.
I'm very pleased to announce the release of
our new website and documentation using
the new toolchain with Hugo and AsciiDoctor.
To get more information about the new toolchain
please read the FreeBSD Documentation Project Primer[1],
Hugo docs[2] and AsciiDoctor docs[3].
Acknowledgment:
Benedict Reuschling <bcr@>
Glen Barber <gjb@>
Hiroki Sato <hrs@>
Li-Wen Hsu <lwhsu@>
Sean Chittenden <seanc@>
The FreeBSD Foundation
[1] https://docs.FreeBSD.org/en/books/fdp-primer/
[2] https://gohugo.io/documentation/
[3] https://docs.asciidoctor.org/home/
Approved by: doceng, core
Marc Fonvieille
Fernando Apesteguía
George V. Neville-Neil
Muhammad Moinur Rahman
Warner Losh
Rene Ladan
Sergio Carlavilla Delgado
Benjamin Kaduk
Li-Wen Hsu
Ka Ho Ng
Ed Maste