aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/en/articles/committers-guide/_index.adoc
Commit message (Collapse)AuthorAgeFilesLines
* committers guide: fix broken linkHEADmainPau Amma30 hours1-2/+1
| | | | | | Remove a line break that prevented the link markup from working properly. Reported by: jmg
* Committers guide: Fix blockVladlen Popolitov9 days1-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
* 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
* 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
* 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-241-1/+1
|
* 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
* [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>
* Document some best practices related to vendor import:Xin LI2024-04-051-2/+50
| | | | | | | | | | | | | Summary: - Verify the source code comes from a trustworthy source. - Always review the diff before importing. - Run configure scripts and alike in an isolated environment. - Perform tests inside chroot, jail or in VM first. Reviewed by: emaste, imp Differential Revision: https://reviews.freebsd.org/D44557
* documentation/content: Stop leaking secretsMuhammad Moinur Rahman2024-03-011-12/+0
| | | | Reported by: robak
* - changed authenticator to freebsd_plainJason Helfman2024-02-021-1/+2
| | | | | | | | - add client_condition to restrict it to be used ONLY on smtp.freebsd.org PR: 276603 Submitted by: Larry Rosenman <ler@FreeBSD.org>
* - spelling adjustmentLarry Rosenmane2024-01-061-1/+1
| | | | PR: 275935
* Typo fixesBenedict Reuschling2023-12-291-2/+2
|
* Remove redundancy: more complete -> completeBenedict Reuschling2023-12-291-1/+1
|
* Fix typo in the commit hash.Gordon Tetlow2023-12-011-1/+1
| | | | While we are at it, use the same hash from above for consistency.
* Committer's: Change the way to install commit template hookYasuhiro Kimura2023-09-071-2/+19
| | | | | | | | | | | | | | | | | | | Currently commit message template hook is installed as following. * The one for src repository is also used for doc and ports. * The file is downloaded through web interface (https://cgit.freebsd.org/) and installed under .git/hooks. However, * Both doc and ports repositories have their own hooks inside them. So it is obviously better to use them than using the one for src repository. * For src repository committer need to download and install hook file each time it is updated. So change the way to install commit message template hook as following. * For doc and src repository, create symbolic link under '.git/hooks' that points to real hook file. * For ports repository. set the path to look for hooks to '.hooks'. This is because ports repository also provides some other hooks and creating symbolic link for each of them is bothersome. PR: 273574
* Committer's guide: Review gpg.conf optionsMatteo Riondato2023-09-071-8/+4
| | | | | | | | Discussed by email with philip@ Changed the original patch to add the 'link' macro PR: 262174
* committers-guide: Clarify changes made in 98565318b6Ceri Davies2023-08-281-2/+2
|
* Committer's Guide: four tiers: heading levelsGraham Perrin2023-08-151-4/+4
| | | | | | | | | | | | https://docs.freebsd.org/en/articles/committers-guide/#_statement_of_general_intent Level 3 section title for tiers 1, 2, and 3, and for the unsupported tier. Reviewed-by: imp Approved-by: emaste Pull-request: https://github.com/freebsd/freebsd-doc/pull/188 Closes: https://github.com/freebsd/freebsd-doc/pull/188
* Committer's Guide: Fix a typoSoobin Rho2023-08-121-1/+1
| | | | Pull Request: https://github.com/freebsd/freebsd-doc/pull/246
* Committer's Guide: indicate that ${repo} must be expandedEd Maste2023-07-211-0/+5
| | | | | | | | Reviewed by: lwhsu Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D41065 fixup turn note into note
* Committer's Guide: suggest skipping section, not whole documentEd Maste2023-07-181-1/+1
| | | | | | | | 5.2.8. Managing Local Changes said "you can stop reading now" if one has no local changes, but later sections are still important (MFCs, Vendor Imports). Sponsored by: The FreeBSD Foundation
* Remove "either" where only one case is shownEd Maste2023-07-181-1/+1
| | | | | | PR: 264751 Fixes: 1e28a7874537 ("git primer: Fix two errors") Sponsored by: The FreeBSD Foundation
* Committer's Guide: document Co-authored-byEd Maste2023-07-171-0/+4
| | | | | | Reviewed by: imp, jhb Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D41060
* documentation/content: Replace Poudriere with poudriereMuhammad Moinur Rahman2023-07-161-2/+2
| | | | | | - poudriere authors bapt and bdrewary prefers to write it as poudriere instead of Poudriere. Update all the documentation to reflect the same. - While I am here fix EOL and trailing spaces.
* Committer's guide: add an "Approved by" case used in portsEd Maste2023-06-211-0/+1
| | | | | | PR: 259385 Reviewed by: gerald Sponsored by: The FreeBSD Foundation
* committers-guide: make it clear that `Submitted by` is deprecatedEd Maste2023-05-221-1/+2
| | | | | | | | | | | Add (deprecated) in the first column. When mentioned only in prose in the second column it may be missed. Noticed by: rmacklem Reviewed by: jrtc27, lwhsu Event: Kitchener-Waterloo Hackathon 2023 Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D40196
* Remove instances of "in order to" to ease readabilityBenedict Reuschling2023-05-181-2/+2
| | | | | | Chapter 11 of the FreeBSD Documentation Project Primer states that language should be clear, short, and simple. This phrasing rarely helps with that and can be cut to a single "to" in pretty much all instances.
* Git and related corrections and improvementsGraham Perrin2023-05-161-107/+78
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | df53ae0fdd98e9452095ac2fdaf95fcfac8c9c7f (2023-04-23): * removed portsnap * encourages use of Git. This round of Git-oriented corrections and changes is, essentially, timed to precede creation of the releng/14.0 branch. Not intended to be comprehensive. Attention to things such as: * HEAD (not a branch) and main (branch) * main (not a branch) and mainline * repositories (there are three) * ports latest, current (not CURRENT) and quarterly * FREEBSD-CURRENT and FREEBSD-STABLE * master * things that were relevant only around the time of migration to Git * markup * grammar. Under https://docs.freebsd.org/en/articles/committers-guide/#_rebasing_your_change_against_latest_freebsd_source_tree a list of items was misrepresented as a single paragraph with asterisk characters in its midst. Reviewed by: carlavilla, imp Approved by: imp Pull Request: https://github.com/freebsd/freebsd-doc/pull/182 Differential revision: https://reviews.freebsd.org/D40026
* Committer's guide: Remove email sender specificationLorenzo Salvadore2023-04-071-1/+1
| | | | | | | | | Do not specify anymore that the email granting a commit bit is from core, since such emails are not sent by core for ports and doc commit bits: they are only for src. Approved by: carlavilla (mentor) Differential Revision: https://reviews.freebsd.org/D39447
* committers-guide: minor improvements to the EnglishCeri Davies2023-04-061-3/+3
|
* Committer's Guide … Git … MFC … Examples: noneGraham Perrin2023-04-021-2/+0
| | | | | | | | | | | | | | The 'Examples' subheading that is currently at https://docs.freebsd.org/en/articles/committers-guide/#_examples has no subtext. Hiding the subheading was considered. Instead, it is deleted. https://bugs.freebsd.org/264080 PR: 264080 Approved by: imp Differential Revision: https://reviews.freebsd.org/D39384
* git-primer: Update how to rebase a vender branch mergeWarner Losh2023-03-311-36/+63
| | | | | | | | | | | | | | | Update the vendor branch merge section to include the missing commands and hopefully to make it more clear. Switch to using bogus branch names that will stand out on purpose. This rework 'play' tested on the lua branch merge, which needed dozens of rebasing... Also, indent by one space the conflict section so as to not confuse automated tools (or me) that it's a real conflict that needs to be resolved. Sponsored by: Netflix
* committers guide: remove "MFC with" tagEd Maste2023-03-211-3/+0
| | | | | | | | "Fixes" and "MFC with" are used for approximately the same purpose, but the former is standard in the Git-based deveopment world. Reviewed by: jhb Differential Revision: https://reviews.freebsd.org/D39190
* Committer guide: Correct the pacakge names of GCC12 for cross compilingLi-Wen Hsu2023-03-191-3/+3
| | | | | | | | Use the newly added syntax of the pacakge macro (in 1d899c1c6fc6). While here, fix some wording and typo spotted by Pau Amma. Differential Revision: https://reviews.freebsd.org/D39068
generated by cgit v1.2.3 (git 2.25.1) at 2025-08-21 10:35:27 +0000