aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/en/articles/committers-guide
Commit message (Collapse)AuthorAgeFilesLines
* Harmonize the cross repo advice.Warner Losh2026-07-141-5/+22
| | | | | | | | | | | The other committer's guide was written years before the cross repo commit bit stuff. Harmonize and expand a little the advice given to make it also match the tone of the new policy and our usual practices being a little more relaxed than what was documented previously. Sponsored by: Netflix Feedback by: jhb Differential Revision: https://reviews.freebsd.org/D58007
* committers-guide: Use macros for branch examplesAlexander Ziaee2026-07-121-19/+19
| | | | | | PR: 279503 Reviewed by: wosch Differential Revision: https://reviews.freebsd.org/D57937
* Move all the software license stuff to a central location.Warner Losh2026-06-261-19/+13
| | | | | | | | | | | | | | This leaves an appropriatesummary on the website pages, committer's guide and contributing pages, and augments license-guide with information that was on those pages (though the license exceptions moves to software-license). It's mostly word motion with light edits. Sponsored by: Netflix Reviewed by: ziaee, adrian Approved by: core (24 hour rule) Differential Revision: https://reviews.freebsd.org/D57340
* documentation: Remove sectnumlevelsAlexander Ziaee2026-06-181-1/+0
| | | | | | | | | | Asciidoctor documentation says sectnumlevels from 0-5 are accepted. Since every chapter sets this value to 6, it is not being parsed and does not do anything. Reviewed by: aokblast Fixes: bdf18a045832 ("handbook: Remove sectnumlevels") Differential Revision: https://reviews.freebsd.org/D57646
* committers-guide: Update website Analytics sectionAlexander Ziaee2026-05-221-6/+3
|
* committers-guide: Remove stale FreeBSD Mall linkAlexander Ziaee2026-05-121-5/+0
| | | | PR: 293468
* doc: Update source files (en .po), for translationsEdson Brandi2026-05-091-422/+400
|
* committers-guide: Remove VCS ID commentAlexander Ziaee2026-04-251-1/+0
| | | | | | Matching what we did in software-license guide. Discussed with: emaste, lwhsu
* committers-guide: Switch license to SPDX onlyAlexander Ziaee2026-04-251-22/+1
| | | | | | | Matching what we did in style(9) and license-guide. Reviewed by: emaste, imp, mhorne Differential Revision: https://reviews.freebsd.org/D54444
* documentation: Fix minor typosPo Han Chen2026-03-231-1/+1
| | | | | | | | | | - explaining-bsd: fix missing opening quote in trademarks list - committers-guide: remove duplicate word ("to to" -> "to") - jails: fix article usage ("A incomplete" -> "An incomplete") - zfs: remove redundant preposition ("in since" -> "since") Reviewed by: ziaee Closes: https://github.com/freebsd/freebsd-doc/pull/624
* doc: Update source files (en .po), for translationsEdson Brandi2026-02-221-468/+497
|
* comitters-guide: Update Submitted: by trailerAlexander Ziaee2026-02-121-3/+5
| | | | | | | Suggested by: imp Discussed with: emaste Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D55120
* committers-guide: Refer to new port name for git-arcJoseph Mingrone2026-02-071-1/+1
| | | | | | | | | The git-arc script was moved from devel/freebsd-git-devtools to devel/freebsd-git-arc. Reviewed by: ziaee Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D55131
* committers-guide: Add columns for GCC 15 external toolchainsJohn Baldwin2026-02-061-8/+13
| | | | | Reviewed by: lwhsu Differential Revision: https://reviews.freebsd.org/D55134
* committers-guide: Tidy Fixes: trailer instructionsAlexander Ziaee2026-02-051-1/+1
| | | | | | Reviewed by: jlduran Reported by: emaste, jlduran Differential Revision: https://reviews.freebsd.org/D55121
* committers-guide: Add Closes: commit msg trailerAlexander Ziaee2026-01-141-0/+5
| | | | | Reviewed by: vexeduxr Differential Revision: https://reviews.freebsd.org/D54448
* committers-guide: Tweak `Submitted by` textEd Maste2025-12-121-1/+1
| | | | | This trailer is not deprecated by Git, it's deprecated by FreeBSD's migration to Git.
* doc: Update source files (en .po), for translationsEdson Brandi2025-11-081-1235/+1393
|
* comitters-guide: Add a table of supported external toolchainsJohn Baldwin2025-10-231-3/+26
| | | | | Reviewed by: imp Differential Revision: https://reviews.freebsd.org/D53241
* new-committers: add mailmap adviceWarner Losh2025-10-171-0/+6
| | | | | | | | | Since we've started bringing in people via github, etc, they have a number of commits with a different author than the FreeBSD address. Suggest that people add their new FreeBSD address. Suggested by: srcmgr call Sponsored by: Netflix
* fix typos and wrong links in en/books and en/articlesVladlen Popolitov2025-10-141-10/+10
| | | | Differential Revision: https://reviews.freebsd.org/D52435
* committers-guide: Mention RELNOTES in a couple of placesMark Johnston2025-09-091-1/+5
| | | | | Reviewed by: imp, olce, emaste Differential Revision: https://reviews.freebsd.org/D52396
* committers guide: fix broken linkPau Amma2025-08-201-2/+1
| | | | | | Remove a line break that prevented the link markup from working properly. Reported by: jmg
* doc: Update source files (en .po), for translationsEdson Brandi2025-08-171-2185/+2547
|
* Committers guide: Fix blockVladlen Popolitov2025-08-121-0/+5
| | | | | Approved by: bcr@ Differential Revision: D51843
* committers-guide: Increase subject length limit to 67 charactersEd Maste2025-07-311-2/+2
| | | | | | | | | | | | | I originally suggested a 63-character limit "so that git log --oneline avoids wrapping." Short hashes in the tree are typically 12 characters, and a space between the hash and the subject should result in a limit of 67 characters. I think I arrived at 63 by subtracting git's typical 4-space indentation from 67, but that indent is not applicable to `git log --oneline`. Reviewed by: olce Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D48246
* committers-guide: Recommend using git arcDag-Erling Smørgrav2025-07-251-0/+3
| | | | | Reviewed by: imp Differential Revision: https://reviews.freebsd.org/D51532
* committers-guide: Suggest consistency in prefixesDag-Erling Smørgrav2025-07-251-0/+1
| | | | | Reviewed by: imp Differential Revision: https://reviews.freebsd.org/D51531
* committers-guide: Remove Jenkins from kerberos/ldap service listLi-Wen Hsu2025-07-031-1/+0
| | | | | | | | It's not very useful for non-administrator logging into the Jenkins instance and this feature has been disabled for a while. Remove it from the kerberos/ldap covering service list. Sponsored by: The FreeBSD Foundation
* doc: Update source files (en .po), for translationsEdson Brandi2025-06-291-757/+810
|
* git primer: Update info about rebasing in a few placesWarner Losh2025-06-251-6/+17
| | | | | | | Experience has shown that some of the advice in this primer is awkward and clunky. Address some of that by refining what we suggest. Sponsored by: Netflix
* Add information about jointing the FreeBSD GitHub orgWarner Losh2025-06-251-0/+8
| | | | Sponsored by: Netflix
* committers-guide; Explain why Fixes: includes the commit titleEd Maste2025-06-031-0/+1
| | | | | | | | (At least one of the reasons.) Reviewed by: markj, imp Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D50600
* committers-guide: Drop notion of reference architecturesJohn Baldwin2025-06-021-3/+1
| | | | | | | | | | | | | i386 can no longer be a reference architecture in 15.0 and later. Instead, require new portable features to work on at least one Tier 1 architecture and drop the notion of a separate set of reference architectures. While here, FreeBSD has not been i386-only for so long that the leading sentence now is outdated, so drop it. Reviewed by: imp, lwhsu Differential Revision: https://reviews.freebsd.org/D50620
* committers-guide: List srcmgr@ as responsible for src commit bitsJohn Baldwin2025-06-021-2/+2
| | | | | Reviewed by: imp, lwhsu, emaste Differential Revision: https://reviews.freebsd.org/D50619
* committers-guide: Update current compiler verisonsJohn Baldwin2025-05-301-13/+22
| | | | | | | | | | - Restructure some of the text to avoid hardcoding compiler versions when possible. - Explicitly note the naming pattern for llvm toolchain packages. Reviewed by: emaste Differential Revision: https://reviews.freebsd.org/D50618
* docs: Remove references to `make world`Ed Maste2025-05-231-1/+1
| | | | | | | | | Two of these seemed to be used in the sense of "building the system." The other one was a literal command, but was incorrect. Reviewed by: jhb Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D50471
* doc: Update source files (en .po), for translationsDanilo G. Baio2025-05-011-553/+564
|
* committers guide: permit key words more than onceBrooks Davis2025-03-211-0/+2
| | | | | | | | | | While some key words such as "MFC after:" should only appear once, others such as "PR:" or "Sponsored by:" may be clearer if each entry appears on it's own line. This is already somewhat common practice so explicitly permit it. Reviewed by: kevans, imp, emaste Differential Revision: https://reviews.freebsd.org/D49429
* license: Prequel hyphen is no longer neededAlexander Ziaee2025-02-271-1/+1
| | | | | | | | | | | | | | | | "Once, long ago, indent(3) would not touch comments starting with /*-. But not too many people used it. Fast forward to the 90s or early 2000s. I wrote a crappy tool to parse out license statements. It was super ugly perl and super slow. So I repurposed that as a marker, convinced the project to adopt it and touched almsot every file in the tree. The parser was faster, but I couldn't get it released. I think nobody else ever used it." ~imp Concludes: 9ddb49cbe (begin license clauses) Reported by: imp, jlduran Reviewed by: carlavilla, imp (previous version) Approved by: carlavilla (mentor) Differential Revision: https://reviews.freebsd.org/D48345
* Regenerate translation filesEd Maste2024-12-291-451/+469
| | | | | | | | Via `sh tools/update_translate_template.sh documentation` Reviewed by: dbaio Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D48234
* committers-guide: Update SPDX linksJose Luis Duran2024-12-291-2/+2
| | | | | Reviewed by: Alexander Ziaee <concussious@runbox.com>, dbaio Pull Request: https://github.com/freebsd/freebsd-doc/pull/428
* committers-guide: Improve "Fixes:" metadataJose Luis Duran2024-11-021-1/+1
| | | | | | | | | Use the preferred format for displaying the "Fixes:" metadata in the git commit message, as discussed in the srcmgr meeting (20241101). Reviewed by: emaste, imp, jhb Approved by: emaste (mentor) Differential Revision: https://reviews.freebsd.org/D47397
* articles/committers-guide: Document "Discussed with"Mateusz Piotrowski2024-10-111-0/+4
| | | | | | Reported by: markj Reviewed by: imp, markj Differential Revision: https://reviews.freebsd.org/D47059
* always use HTTPS linksWolfram Schneider2024-09-242-2/+2
|
* Fix links that use crossref without descriptionFernando Apesteguía2024-09-221-15/+15
| | | | | | | | | | | | | Summary: Add the anchor text to the crossref macro Test Plan: Apply patch and build the documentation A follow-up change will make the crossref macro fail if no description is used. Subscribers: delphij Differential Revision: https://reviews.freebsd.org/D46721
* doc: Update source files (en .po), for translationsDanilo G. Baio2024-09-141-1234/+1292
|
* [documentation]: Fix links in all output formatsFernando Apesteguía2024-09-071-27/+40
| | | | | | | | | | | | | Use the crossref: macro for intra-file and intra-book links. This will produce the correct link in Single HTML, Splitted HTML and PDF. Rework the macro to include the PDF special render. While here, briefly document macros. PR: 266107 Reviewed by: bcr@, dbaio@, concussious.bugzilla_runbox.com Differential Revision: https://reviews.freebsd.org/D46480
* committers-guide: apply markup to sample bad commit messageEd Maste2024-05-221-1/+1
| | | | Sponsored by: The FreeBSD Foundation
* Fix typos.Xin LI2024-04-051-4/+4
| | | | Reported by: Pau Amma <pauamma gundo com>
generated by cgit v1.3 (git 2.53.0) at 2026-09-05 13:00:27 +0000