diff options
Diffstat (limited to 'documentation/content/en/articles/committers-guide/_index.po')
| -rw-r--r-- | documentation/content/en/articles/committers-guide/_index.po | 2628 |
1 files changed, 1393 insertions, 1235 deletions
diff --git a/documentation/content/en/articles/committers-guide/_index.po b/documentation/content/en/articles/committers-guide/_index.po index c1f608dfab..2746286d86 100644 --- a/documentation/content/en/articles/committers-guide/_index.po +++ b/documentation/content/en/articles/committers-guide/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2025-08-17 20:53+0100\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -394,20 +394,20 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:193 +#: documentation/content/en/articles/committers-guide/_index.adoc:192 msgid "" "Committing the new key is shown in crossref:committers-guide[commit-steps, " "Steps for New Committers]." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:195 +#: documentation/content/en/articles/committers-guide/_index.adoc:194 #, no-wrap msgid "Kerberos and LDAP web Password for FreeBSD Cluster" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:200 +#: documentation/content/en/articles/committers-guide/_index.adoc:199 msgid "" "The FreeBSD cluster requires a Kerberos password to access certain " "services. The Kerberos password also serves as the LDAP web password, since " @@ -416,43 +416,43 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:202 +#: documentation/content/en/articles/committers-guide/_index.adoc:201 msgid "https://bugs.freebsd.org/bugzilla[Bugzilla]" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:204 +#: documentation/content/en/articles/committers-guide/_index.adoc:203 msgid "" "To create a new Kerberos account in the FreeBSD cluster, or to reset a " "Kerberos password for an existing account using a random password generator:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:208 +#: documentation/content/en/articles/committers-guide/_index.adoc:207 #, no-wrap msgid "% ssh kpasswd.freebsd.org\n" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:213 +#: documentation/content/en/articles/committers-guide/_index.adoc:212 msgid "This must be done from a machine outside of the FreeBSD.org cluster." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:216 +#: documentation/content/en/articles/committers-guide/_index.adoc:215 msgid "" "A Kerberos password can also be set manually by logging into " "`freefall.FreeBSD.org` and running:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:220 +#: documentation/content/en/articles/committers-guide/_index.adoc:219 #, no-wrap msgid "% kpasswd\n" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:226 +#: documentation/content/en/articles/committers-guide/_index.adoc:225 msgid "" "Unless the Kerberos-authenticated services of the FreeBSD.org cluster have " "been used previously, `Client unknown` will be shown. This error means that " @@ -461,13 +461,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:229 +#: documentation/content/en/articles/committers-guide/_index.adoc:228 #, no-wrap msgid "Commit Bit Types" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:235 +#: documentation/content/en/articles/committers-guide/_index.adoc:234 msgid "" "The FreeBSD repository has a number of components which, when combined, " "support the basic operating system source, documentation, third party " @@ -482,79 +482,79 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:241 +#: documentation/content/en/articles/committers-guide/_index.adoc:240 #, no-wrap msgid "__Committer Type__" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:242 +#: documentation/content/en/articles/committers-guide/_index.adoc:241 #, no-wrap msgid "__Responsible__" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:244 +#: documentation/content/en/articles/committers-guide/_index.adoc:243 #, no-wrap msgid "__Tree Components__" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:245 +#: documentation/content/en/articles/committers-guide/_index.adoc:244 #, no-wrap msgid "src" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:246 +#: documentation/content/en/articles/committers-guide/_index.adoc:245 #, no-wrap msgid "srcmgr@" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:248 +#: documentation/content/en/articles/committers-guide/_index.adoc:247 #, no-wrap msgid "src/" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:249 +#: documentation/content/en/articles/committers-guide/_index.adoc:248 #, no-wrap msgid "doc" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:250 +#: documentation/content/en/articles/committers-guide/_index.adoc:249 #, no-wrap msgid "doceng@" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:252 +#: documentation/content/en/articles/committers-guide/_index.adoc:251 #, no-wrap msgid "doc/, ports/, src/ documentation" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:253 +#: documentation/content/en/articles/committers-guide/_index.adoc:252 #, no-wrap msgid "ports" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:254 +#: documentation/content/en/articles/committers-guide/_index.adoc:253 #, no-wrap msgid "portmgr@" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:255 +#: documentation/content/en/articles/committers-guide/_index.adoc:254 #, no-wrap msgid "ports/" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:260 +#: documentation/content/en/articles/committers-guide/_index.adoc:259 msgid "" "Commit bits allocated prior to the development of the notion of areas of " "authority may be appropriate for use in many parts of the tree. However, " @@ -567,7 +567,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:262 +#: documentation/content/en/articles/committers-guide/_index.adoc:261 msgid "" "Committers are encouraged to seek review for their work as part of the " "normal development process, regardless of the area of the tree where the " @@ -575,13 +575,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:263 +#: documentation/content/en/articles/committers-guide/_index.adoc:262 #, no-wrap msgid "Policy for Committer Activity in Other Trees" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:266 +#: documentation/content/en/articles/committers-guide/_index.adoc:265 msgid "" "All committers may modify [.filename]#src/share/misc/committers-*.dot#, " "[.filename]#src/usr.bin/calendar/calendars/calendar.freebsd#, and " @@ -589,7 +589,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:267 +#: documentation/content/en/articles/committers-guide/_index.adoc:266 msgid "" "doc committers may commit documentation changes to [.filename]#src# files, " "such as manual pages, READMEs, fortune databases, calendar files, and " @@ -598,7 +598,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:269 +#: documentation/content/en/articles/committers-guide/_index.adoc:268 msgid "" "Any committer may make changes to any other tree with an \"Approved by\" " "from a non-mentored committer with the appropriate bit. Mentored committers " @@ -606,7 +606,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:270 +#: documentation/content/en/articles/committers-guide/_index.adoc:269 msgid "" "Committers can acquire an additional bit by the usual process of finding a " "mentor who will propose them to srcmgr, doceng, or portmgr, as appropriate. " @@ -616,13 +616,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:272 +#: documentation/content/en/articles/committers-guide/_index.adoc:271 #, no-wrap msgid "Documentation Implicit (Blanket) Approval" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:276 +#: documentation/content/en/articles/committers-guide/_index.adoc:275 msgid "" "Some types of fixes have \"blanket approval\" from the {doceng}, allowing " "any committer to fix those categories of problems on any part of the doc " @@ -631,87 +631,87 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:278 +#: documentation/content/en/articles/committers-guide/_index.adoc:277 msgid "Blanket approval applies to these types of fixes:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:280 +#: documentation/content/en/articles/committers-guide/_index.adoc:279 msgid "Typos" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:281 +#: documentation/content/en/articles/committers-guide/_index.adoc:280 msgid "Trivial fixes" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:283 +#: documentation/content/en/articles/committers-guide/_index.adoc:282 msgid "" "Punctuation, URLs, dates, paths and file names with outdated or incorrect " "information, and other common mistakes that may confound the readers." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:286 +#: documentation/content/en/articles/committers-guide/_index.adoc:285 msgid "" "Over the years, some implicit approvals were granted in the doc tree. This " "list shows the most common cases:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:288 +#: documentation/content/en/articles/committers-guide/_index.adoc:287 msgid "" "Changes in [.filename]#documentation/content/en/books/porters-handbook/" "versions/_index.adoc#" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:290 +#: documentation/content/en/articles/committers-guide/_index.adoc:289 msgid "" "extref:{porters-handbook}versions/[__FreeBSD_version Values (Porter's " "Handbook)], mainly used for src committers." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:291 +#: documentation/content/en/articles/committers-guide/_index.adoc:290 msgid "Changes in [.filename]#doc/shared/contrib-additional.adoc#" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:293 +#: documentation/content/en/articles/committers-guide/_index.adoc:292 msgid "" "extref:{contributors}[Additional FreeBSD Contributors, contrib-additional] " "maintenance." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:294 +#: documentation/content/en/articles/committers-guide/_index.adoc:293 msgid "All link:#commit-steps[Steps for New Committers], doc related" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:295 +#: documentation/content/en/articles/committers-guide/_index.adoc:294 msgid "Security advisories; Errata Notices; Releases;" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:297 +#: documentation/content/en/articles/committers-guide/_index.adoc:296 msgid "Used by {security-officer} and {re}." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:298 +#: documentation/content/en/articles/committers-guide/_index.adoc:297 msgid "Changes in [.filename]#website/content/en/donations/donors.adoc#" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:300 +#: documentation/content/en/articles/committers-guide/_index.adoc:299 msgid "Used by {donations}." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:302 +#: documentation/content/en/articles/committers-guide/_index.adoc:301 msgid "" "Before any commit, a build test is necessary; see the 'Overview' and 'The " "FreeBSD Documentation Build Process' sections of the extref:{fdp-primer}" @@ -719,19 +719,19 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:304 +#: documentation/content/en/articles/committers-guide/_index.adoc:303 #, no-wrap msgid "Git Primer" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:307 +#: documentation/content/en/articles/committers-guide/_index.adoc:306 #, no-wrap msgid "Git basics" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:314 +#: documentation/content/en/articles/committers-guide/_index.adoc:313 msgid "" "When one searches for \"Git Primer\" a number of good ones come up. Daniel " "Miessler's link:https://danielmiessler.com/study/git/[A git primer] and " @@ -746,33 +746,33 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:316 +#: documentation/content/en/articles/committers-guide/_index.adoc:315 msgid "" "This document will assume that you've read through it and will try not to " "belabor the basics (though it will cover them briefly)." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:318 +#: documentation/content/en/articles/committers-guide/_index.adoc:317 #, no-wrap msgid "Git Mini Primer" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:321 +#: documentation/content/en/articles/committers-guide/_index.adoc:320 msgid "" "This primer is less ambitiously scoped than the old Subversion Primer, but " "should cover the basics." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:322 +#: documentation/content/en/articles/committers-guide/_index.adoc:321 #, no-wrap msgid "Scope" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:328 +#: documentation/content/en/articles/committers-guide/_index.adoc:327 msgid "" "If you want to download FreeBSD, compile it from sources, and generally keep " "up to date that way, this primer is for you. It covers getting the sources, " @@ -784,7 +784,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:332 +#: documentation/content/en/articles/committers-guide/_index.adoc:331 msgid "" "The goal of this section is to highlight those bits of Git needed to track " "sources. They assume a basic understanding of Git. There are many primers " @@ -793,49 +793,49 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:334 +#: documentation/content/en/articles/committers-guide/_index.adoc:333 #, no-wrap msgid "Getting Started For Developers" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:337 +#: documentation/content/en/articles/committers-guide/_index.adoc:336 msgid "" "This section describes the read-write access for committers to push the " "commits from developers or contributors." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:339 +#: documentation/content/en/articles/committers-guide/_index.adoc:338 #, no-wrap msgid "Daily use" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:344 +#: documentation/content/en/articles/committers-guide/_index.adoc:343 msgid "" "In the examples below, replace `${repo}` with the name of the desired " "FreeBSD repository: `doc`, `ports`, or `src`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:347 +#: documentation/content/en/articles/committers-guide/_index.adoc:346 msgid "Clone the repository:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:351 +#: documentation/content/en/articles/committers-guide/_index.adoc:350 #, no-wrap msgid "% git clone -o freebsd --config remote.freebsd.fetch='+refs/notes/*:refs/notes/*' https://git.freebsd.org/${repo}.git\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:354 +#: documentation/content/en/articles/committers-guide/_index.adoc:353 msgid "Then you should have the official mirrors as your remote:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:360 +#: documentation/content/en/articles/committers-guide/_index.adoc:359 #, no-wrap msgid "" "% git remote -v\n" @@ -844,12 +844,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:363 +#: documentation/content/en/articles/committers-guide/_index.adoc:362 msgid "Configure the FreeBSD committer data:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:366 +#: documentation/content/en/articles/committers-guide/_index.adoc:365 msgid "" "The commit hook in repo.freebsd.org checks the \"Commit\" field matches the " "committer's information in FreeBSD.org. The easiest way to get the " @@ -858,7 +858,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:373 +#: documentation/content/en/articles/committers-guide/_index.adoc:372 #, no-wrap msgid "" "% gen-gitconfig.sh\n" @@ -868,25 +868,25 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:376 +#: documentation/content/en/articles/committers-guide/_index.adoc:375 msgid "Set the push URL:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:380 +#: documentation/content/en/articles/committers-guide/_index.adoc:379 #, no-wrap msgid "% git remote set-url --push freebsd git@gitrepo.freebsd.org:${repo}.git\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:383 +#: documentation/content/en/articles/committers-guide/_index.adoc:382 msgid "" "Then you should have separated fetch and push URLs as the most efficient " "setup:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:389 +#: documentation/content/en/articles/committers-guide/_index.adoc:388 #, no-wrap msgid "" "% git remote -v\n" @@ -895,24 +895,24 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:392 +#: documentation/content/en/articles/committers-guide/_index.adoc:391 msgid "" "Again, note that `gitrepo.freebsd.org` has been canonicalized to " "`repo.freebsd.org`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:394 +#: documentation/content/en/articles/committers-guide/_index.adoc:393 msgid "Install commit message template hook:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:396 +#: documentation/content/en/articles/committers-guide/_index.adoc:395 msgid "For doc repository:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:401 +#: documentation/content/en/articles/committers-guide/_index.adoc:400 #, no-wrap msgid "" "% cd .git/hooks\n" @@ -920,23 +920,23 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:404 +#: documentation/content/en/articles/committers-guide/_index.adoc:403 msgid "For ports repository:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:408 +#: documentation/content/en/articles/committers-guide/_index.adoc:407 #, no-wrap msgid "% git config --add core.hooksPath .hooks\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:411 +#: documentation/content/en/articles/committers-guide/_index.adoc:410 msgid "For src repository:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:416 +#: documentation/content/en/articles/committers-guide/_index.adoc:415 #, no-wrap msgid "" "% cd .git/hooks\n" @@ -944,27 +944,27 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:419 +#: documentation/content/en/articles/committers-guide/_index.adoc:418 #, no-wrap msgid "\"admin\" branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:422 +#: documentation/content/en/articles/committers-guide/_index.adoc:421 msgid "" "The `access` and `mentors` files are stored in an orphan branch, `internal/" "admin`, in each repository." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:424 +#: documentation/content/en/articles/committers-guide/_index.adoc:423 msgid "" "Following example is how to check out the `internal/admin` branch to a local " "branch named `admin`:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:430 +#: documentation/content/en/articles/committers-guide/_index.adoc:429 #, no-wrap msgid "" "% git config --add remote.freebsd.fetch '+refs/internal/*:refs/internal/*'\n" @@ -973,42 +973,42 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:432 +#: documentation/content/en/articles/committers-guide/_index.adoc:431 msgid "Alternatively, you can add a worktree for the `admin` branch:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:436 +#: documentation/content/en/articles/committers-guide/_index.adoc:435 #, no-wrap msgid "git worktree add -b admin ../${repo}-admin internal/admin\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:440 +#: documentation/content/en/articles/committers-guide/_index.adoc:439 msgid "" "For browsing `internal/admin` branch on web: `https://cgit.freebsd.org/$" "{repo}/log/?h=internal/admin`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:442 +#: documentation/content/en/articles/committers-guide/_index.adoc:441 msgid "For pushing, specify the full refspec:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:446 +#: documentation/content/en/articles/committers-guide/_index.adoc:445 #, no-wrap msgid "git push freebsd HEAD:refs/internal/admin\n" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:448 +#: documentation/content/en/articles/committers-guide/_index.adoc:447 #, no-wrap msgid "Keeping Current With The FreeBSD src Tree" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:455 +#: documentation/content/en/articles/committers-guide/_index.adoc:454 msgid "" "First step: cloning a tree. This downloads the entire tree. There are two " "ways to download. Most people will want to do a deep clone of the " @@ -1017,75 +1017,75 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:456 +#: documentation/content/en/articles/committers-guide/_index.adoc:455 #, no-wrap msgid "Branch Names" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:458 +#: documentation/content/en/articles/committers-guide/_index.adoc:457 msgid "FreeBSD-CURRENT uses the `main` branch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:460 +#: documentation/content/en/articles/committers-guide/_index.adoc:459 msgid "`main` is the default branch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:462 +#: documentation/content/en/articles/committers-guide/_index.adoc:461 msgid "For FreeBSD-STABLE, branch names include `stable/12` and `stable/13`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:464 +#: documentation/content/en/articles/committers-guide/_index.adoc:463 msgid "" "For FreeBSD-RELEASE, release engineering branch names include `releng/12.4` " "and `releng/13.2`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:466 +#: documentation/content/en/articles/committers-guide/_index.adoc:465 msgid "https://www.freebsd.org/releng/[] shows:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:468 +#: documentation/content/en/articles/committers-guide/_index.adoc:467 msgid "`main` and `stable/⋯` branches open" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:469 +#: documentation/content/en/articles/committers-guide/_index.adoc:468 msgid "`releng/⋯` branches, each of which is frozen when a release is tagged." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:471 +#: documentation/content/en/articles/committers-guide/_index.adoc:470 msgid "Examples:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:473 +#: documentation/content/en/articles/committers-guide/_index.adoc:472 msgid "" "tag https://cgit.freebsd.org/src/tag/?h=release/13.1.0[release/13.1.0] on " "the https://cgit.freebsd.org/src/log/?h=releng/13.1[releng/13.1] branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:474 +#: documentation/content/en/articles/committers-guide/_index.adoc:473 msgid "" "tag https://cgit.freebsd.org/src/tag/?h=release/13.2.0[release/13.2.0] on " "the https://cgit.freebsd.org/src/log/?h=releng/13.2[releng/13.2] branch." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:475 +#: documentation/content/en/articles/committers-guide/_index.adoc:474 #, no-wrap msgid "Repositories" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:478 +#: documentation/content/en/articles/committers-guide/_index.adoc:477 msgid "" "Please see the crossref:committers-guide[admin,Administrative Details] for " "the latest information on where to get FreeBSD sources. $URL below can be " @@ -1093,7 +1093,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:481 +#: documentation/content/en/articles/committers-guide/_index.adoc:480 msgid "" "Note: The project doesn't use submodules as they are a poor fit for our " "workflows and development model. How we track changes in third-party " @@ -1102,13 +1102,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:482 +#: documentation/content/en/articles/committers-guide/_index.adoc:481 #, no-wrap msgid "Deep Clone" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:486 +#: documentation/content/en/articles/committers-guide/_index.adoc:485 msgid "" "A deep clone pulls in the entire tree, as well as all the history and " "branches. It is the easiest to do. It also allows you to use Git's " @@ -1117,13 +1117,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:489 +#: documentation/content/en/articles/committers-guide/_index.adoc:488 #, no-wrap msgid "% git clone -o freebsd $URL -b branch [<directory>]\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:494 +#: documentation/content/en/articles/committers-guide/_index.adoc:493 msgid "" "will create a deep clone. `branch` should be one of the branches listed in " "the previous section. If no `branch` is given: the default (`main`) will be " @@ -1133,7 +1133,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:499 +#: documentation/content/en/articles/committers-guide/_index.adoc:498 msgid "" "You will want a deep clone if you are interested in the history, plan on " "making local changes, or plan on working on more than one branch. It is the " @@ -1145,13 +1145,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:500 +#: documentation/content/en/articles/committers-guide/_index.adoc:499 #, no-wrap msgid "Shallow Clone" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:506 +#: documentation/content/en/articles/committers-guide/_index.adoc:505 msgid "" "A shallow clone copies just the most current code, but none or little of the " "history. This can be useful when you need to build a specific revision of " @@ -1161,13 +1161,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:510 +#: documentation/content/en/articles/committers-guide/_index.adoc:509 #, no-wrap msgid "% git clone -o freebsd -b branch --depth 1 $URL [dir]\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:515 +#: documentation/content/en/articles/committers-guide/_index.adoc:514 msgid "" "This clones the repository, but only has the most recent version in the " "repository. The rest of the history is not downloaded. Should you change " @@ -1175,7 +1175,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:520 +#: documentation/content/en/articles/committers-guide/_index.adoc:519 msgid "" "When you make a shallow clone, you will lose the commit count in your uname " "output. This can make it more difficult to determine if your system needs " @@ -1183,19 +1183,19 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:522 +#: documentation/content/en/articles/committers-guide/_index.adoc:521 #, no-wrap msgid "Building" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:526 +#: documentation/content/en/articles/committers-guide/_index.adoc:525 msgid "" "Once you've downloaded, building is done as described in the handbook, e.g.:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:533 +#: documentation/content/en/articles/committers-guide/_index.adoc:532 #, no-wrap msgid "" "% cd src\n" @@ -1206,40 +1206,41 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:535 +#: documentation/content/en/articles/committers-guide/_index.adoc:534 msgid "so that won't be covered in depth here." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:538 +#: documentation/content/en/articles/committers-guide/_index.adoc:537 msgid "" -"If you want to build a custom kernel, extref:{handbook}[the kernel config " -"section, kernelconfig] of the FreeBSD Handbook recommends creating a file " -"MYKERNEL under sys/${ARCH}/conf with your changes against GENERIC. To have " -"MYKERNEL disregarded by Git, it can be added to .git/info/exclude." +"If you want to build a custom kernel, extref:{handbook}kernelconfig[the " +"kernel config section, kernelconfig] of the FreeBSD Handbook recommends " +"creating a file MYKERNEL under sys/${ARCH}/conf with your changes against " +"GENERIC. To have MYKERNEL disregarded by Git, it can be added to .git/info/" +"exclude." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:539 +#: documentation/content/en/articles/committers-guide/_index.adoc:538 #, no-wrap msgid "Updating" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:543 +#: documentation/content/en/articles/committers-guide/_index.adoc:542 msgid "" "To update both types of trees uses the same commands. This pulls in all the " "revisions since your last update." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:546 +#: documentation/content/en/articles/committers-guide/_index.adoc:545 #, no-wrap msgid "% git pull --ff-only\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:551 +#: documentation/content/en/articles/committers-guide/_index.adoc:550 msgid "" "will update the tree. In Git, a 'fast forward' merge is one that only needs " "to set a new branch pointer and doesn't need to re-create the commits. By " @@ -1249,7 +1250,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:554 +#: documentation/content/en/articles/committers-guide/_index.adoc:553 msgid "" "See below for how to manage local changes. The simplest is to use `--" "autostash` on the `git pull` command, but more sophisticated options are " @@ -1257,20 +1258,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:555 +#: documentation/content/en/articles/committers-guide/_index.adoc:554 #, no-wrap msgid "Selecting a Specific Version" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:559 +#: documentation/content/en/articles/committers-guide/_index.adoc:558 msgid "" "In Git, `git checkout` checks out both branches and specific versions. " "Git's versions are the long hashes rather than a sequential number." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:561 +#: documentation/content/en/articles/committers-guide/_index.adoc:560 msgid "" "When you checkout a specific version, just specify the hash you want on the " "command line (the git log command can help you decide which hash you might " @@ -1278,26 +1279,26 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:564 +#: documentation/content/en/articles/committers-guide/_index.adoc:563 #, no-wrap msgid "% git checkout 08b8197a74\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:567 +#: documentation/content/en/articles/committers-guide/_index.adoc:566 msgid "" "and you have that checked out. You will be greeted with a message similar " "to the following:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:570 +#: documentation/content/en/articles/committers-guide/_index.adoc:569 #, no-wrap msgid "Note: checking out '08b8197a742a96964d2924391bf9fdfeb788865d'.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:574 +#: documentation/content/en/articles/committers-guide/_index.adoc:573 #, no-wrap msgid "" "You are in a 'detached HEAD' state. You can look around, make experimental\n" @@ -1306,8 +1307,8 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:577 -#: documentation/content/en/articles/committers-guide/_index.adoc:1746 +#: documentation/content/en/articles/committers-guide/_index.adoc:576 +#: documentation/content/en/articles/committers-guide/_index.adoc:1745 #, no-wrap msgid "" "If you want to create a new branch to retain commits you create, you may\n" @@ -1315,20 +1316,20 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:579 -#: documentation/content/en/articles/committers-guide/_index.adoc:1748 +#: documentation/content/en/articles/committers-guide/_index.adoc:578 +#: documentation/content/en/articles/committers-guide/_index.adoc:1747 #, no-wrap msgid " git checkout -b <new-branch-name>\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:581 +#: documentation/content/en/articles/committers-guide/_index.adoc:580 #, no-wrap msgid "HEAD is now at 08b8197a742a hook gpiokeys.4 to the build\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:585 +#: documentation/content/en/articles/committers-guide/_index.adoc:584 msgid "" "where the last line is generated from the hash you are checking out and the " "first line of the commit message from that revision. The hash can be " @@ -1337,13 +1338,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:586 +#: documentation/content/en/articles/committers-guide/_index.adoc:585 #, no-wrap msgid "Bisecting" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:590 +#: documentation/content/en/articles/committers-guide/_index.adoc:589 msgid "" "Sometimes, things go wrong. The last version worked, but the one you just " "updated to does not. A developer may ask you to bisect the problem to track " @@ -1351,7 +1352,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:595 +#: documentation/content/en/articles/committers-guide/_index.adoc:594 msgid "" "Git makes bisecting changes easy with a powerful `git bisect` command. " "Here's a brief outline of how to use it. For more information, you can view " @@ -1363,7 +1364,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:602 +#: documentation/content/en/articles/committers-guide/_index.adoc:601 msgid "" "`git bisect start --first-parent` will start the bisection process. Next, " "you need to tell a range to go through. `git bisect good XXXXXX` will tell " @@ -1376,14 +1377,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:606 +#: documentation/content/en/articles/committers-guide/_index.adoc:605 msgid "" "If you want to know the last version you checked out, you should use `git " "reflog`:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:611 +#: documentation/content/en/articles/committers-guide/_index.adoc:610 #, no-wrap msgid "" "5ef0bd68b515 (HEAD -> main, freebsd/main, freebsd/HEAD) HEAD@{0}: pull --ff-only: Fast-forward\n" @@ -1392,7 +1393,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:615 +#: documentation/content/en/articles/committers-guide/_index.adoc:614 msgid "" "shows me moving the working tree to the `main` branch (a816...) and then " "updating from upstream (to 5ef0...). In this case, bad would be HEAD (or " @@ -1403,7 +1404,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:619 +#: documentation/content/en/articles/committers-guide/_index.adoc:618 msgid "" "Set the 'good' version first, then set the bad (though the order doesn't " "matter). When you set the bad version, it will give you some statistics on " @@ -1411,7 +1412,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:626 +#: documentation/content/en/articles/committers-guide/_index.adoc:625 #, no-wrap msgid "" "% git bisect start --first-parent\n" @@ -1422,7 +1423,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:635 +#: documentation/content/en/articles/committers-guide/_index.adoc:634 msgid "" "You would then build/install that version. If it's good you'd type `git " "bisect good` otherwise `git bisect bad`. If the version doesn't compile, " @@ -1435,13 +1436,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:637 +#: documentation/content/en/articles/committers-guide/_index.adoc:636 #, no-wrap msgid "Signing the commits, tags, and pushes, with GnuPG" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:642 +#: documentation/content/en/articles/committers-guide/_index.adoc:641 msgid "" "Git knows how to sign commits, tags, and pushes. When you sign a Git commit " "or a tag, you can prove that the code you submitted came from you and wasn't " @@ -1450,7 +1451,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:644 +#: documentation/content/en/articles/committers-guide/_index.adoc:643 msgid "" "A more in-depth documentation on signing commits and tags can be found in " "the https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work[Git Tools - " @@ -1458,7 +1459,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:646 +#: documentation/content/en/articles/committers-guide/_index.adoc:645 msgid "" "The rationale behind signing pushes can be found in the https://github.com/" "git/git/commit/a85b377d0419a9dfaca8af2320cc33b051cbed04[commit that " @@ -1466,14 +1467,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:649 +#: documentation/content/en/articles/committers-guide/_index.adoc:648 msgid "" "The best way is to simply tell Git you always want to sign commits, tags, " "and pushes. You can do this by setting a few configuration variables:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:656 +#: documentation/content/en/articles/committers-guide/_index.adoc:655 #, no-wrap msgid "" "% git config --add user.signingKey LONG-KEY-ID\n" @@ -1484,14 +1485,14 @@ msgstr "" #. push.gpgSign should probably be set to `yes` once we enable it, or be set with --global, so that it is enabled for all repositories. #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:664 +#: documentation/content/en/articles/committers-guide/_index.adoc:663 msgid "" "To avoid possible collisions, make sure you give a long key id to Git. You " "can get the long id with: `gpg --list-secret-keys --keyid-format LONG`." msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:670 +#: documentation/content/en/articles/committers-guide/_index.adoc:669 msgid "" "To use specific subkeys, and not have GnuPG to resolve the subkey to a " "primary key, attach `!` to the key. For example, to encrypt for the subkey " @@ -1499,20 +1500,20 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:672 +#: documentation/content/en/articles/committers-guide/_index.adoc:671 #, no-wrap msgid "Verifying signatures" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:675 +#: documentation/content/en/articles/committers-guide/_index.adoc:674 msgid "" "Commit signatures can be verified by running either `git verify-commit " "<commit hash>`, or `git log --show-signature`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:677 +#: documentation/content/en/articles/committers-guide/_index.adoc:676 msgid "" "Tag signatures can be verified with `git verify-tag <tag name>`, or `git tag " "-v <tag name>`." @@ -1524,43 +1525,43 @@ msgstr "" #. Git pushes are a bit different, they live in a special ref in the repository. #. TODO: write how to verify them #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:686 +#: documentation/content/en/articles/committers-guide/_index.adoc:685 #, no-wrap msgid "Ports Considerations" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:689 +#: documentation/content/en/articles/committers-guide/_index.adoc:688 msgid "" "The ports tree operates the same way. The branch names are different and " "the repositories are in different locations." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:692 +#: documentation/content/en/articles/committers-guide/_index.adoc:691 msgid "" "The cgit repository web interface for use with web browsers is at https://" "cgit.FreeBSD.org/ports/ . The production Git repository is at https://" "git.FreeBSD.org/ports.git and at ssh://anongit@git.FreeBSD.org/ports.git (or " -"anongit@git.FreeBSD.org:ports.git)." +"`anongit@git.FreeBSD.org:ports.git`)." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:696 +#: documentation/content/en/articles/committers-guide/_index.adoc:695 msgid "" -"There is also a mirror on GitHub, see extref:{handbook}/mirrors[External " +"There is also a mirror on GitHub, see extref:{handbook}mirrors[External " "mirrors, mirrors] for an overview. The _latest_ branch is `main`. The " "_quarterly_ branches are named `yyyyQn` for year 'yyyy' and quarter 'n'." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:698 +#: documentation/content/en/articles/committers-guide/_index.adoc:697 #, no-wrap msgid "Commit message formats" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:702 +#: documentation/content/en/articles/committers-guide/_index.adoc:701 msgid "" "A hook is available in the ports repository to help you write up your commit " "messages in https://cgit.freebsd.org/ports/tree/.hooks/prepare-commit-" @@ -1569,32 +1570,32 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:704 +#: documentation/content/en/articles/committers-guide/_index.adoc:703 msgid "" "The main point being that a commit message should be formatted in the " "following way:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:707 +#: documentation/content/en/articles/committers-guide/_index.adoc:706 #, no-wrap msgid "category/port: Summary.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:709 +#: documentation/content/en/articles/committers-guide/_index.adoc:708 #, no-wrap msgid "Description of why the changes where made.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:711 +#: documentation/content/en/articles/committers-guide/_index.adoc:710 #, no-wrap msgid "PR:\t 12345\n" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:717 +#: documentation/content/en/articles/committers-guide/_index.adoc:716 msgid "" "The first line is the subject of the commit, it contains what port was " "changed, and a summary of the commit. It should contain 50 characters or " @@ -1602,39 +1603,39 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:719 +#: documentation/content/en/articles/committers-guide/_index.adoc:718 msgid "A blank line should separate it from the rest of the commit message." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:721 +#: documentation/content/en/articles/committers-guide/_index.adoc:720 msgid "" "The rest of the commit message should be wrapped at the 72 characters " "boundary." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:723 +#: documentation/content/en/articles/committers-guide/_index.adoc:722 msgid "" "Another blank line should be added if there are any metadata fields, so that " "they are easily distinguishable from the commit message." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:725 +#: documentation/content/en/articles/committers-guide/_index.adoc:724 #, no-wrap msgid "Managing Local Changes" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:728 +#: documentation/content/en/articles/committers-guide/_index.adoc:727 msgid "" "This section addresses tracking local changes. If you have no local changes " "you can skip this section." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:734 +#: documentation/content/en/articles/committers-guide/_index.adoc:733 msgid "" "One item that is important for all of them: all changes are local until " "pushed. Unlike Subversion, Git uses a distributed model. For users, for " @@ -1645,13 +1646,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:735 +#: documentation/content/en/articles/committers-guide/_index.adoc:734 #, no-wrap msgid "Keeping local changes" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:742 +#: documentation/content/en/articles/committers-guide/_index.adoc:741 msgid "" "The simplest way to keep local changes (especially trivial ones) is to use " "`git stash`. In its simplest form, you use `git stash` to record the " @@ -1663,7 +1664,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:746 +#: documentation/content/en/articles/committers-guide/_index.adoc:745 msgid "" "This method is suitable when you have tiny tweaks to the tree. When you " "have anything non trivial, you'll likely be better off keeping a local " @@ -1672,13 +1673,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:747 +#: documentation/content/en/articles/committers-guide/_index.adoc:746 #, no-wrap msgid "Keeping a local branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:754 +#: documentation/content/en/articles/committers-guide/_index.adoc:753 msgid "" "It is much easier to keep a local branch with Git than Subversion. In " "Subversion you need to merge the commit, and resolve the conflicts. This is " @@ -1689,7 +1690,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:758 +#: documentation/content/en/articles/committers-guide/_index.adoc:757 msgid "" "In addition to merging, Git supports the concept of 'rebasing' which avoids " "these issues. The `git rebase` command replays all the commits of a branch " @@ -1698,12 +1699,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:760 +#: documentation/content/en/articles/committers-guide/_index.adoc:759 msgid "====== Create a branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:765 +#: documentation/content/en/articles/committers-guide/_index.adoc:764 msgid "" "Let's say you want to make a change to FreeBSD's ls command to never, ever " "do color. There are many reasons to do this, but this example will use that " @@ -1713,7 +1714,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:787 +#: documentation/content/en/articles/committers-guide/_index.adoc:786 #, no-wrap msgid "" "% cd src\n" @@ -1739,7 +1740,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:794 +#: documentation/content/en/articles/committers-guide/_index.adoc:793 msgid "" "The commit will pop you into an editor to describe what you've done. Once " "you enter that, you have your own **local** branch in the Git repo. Build " @@ -1751,12 +1752,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:796 +#: documentation/content/en/articles/committers-guide/_index.adoc:795 msgid "====== Time to update" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:801 +#: documentation/content/en/articles/committers-guide/_index.adoc:800 msgid "" "When it is time to bring in a new version, it is almost the same as w/o the " "branches. You would update like you would above, but there is one extra " @@ -1766,7 +1767,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:807 +#: documentation/content/en/articles/committers-guide/_index.adoc:806 #, no-wrap msgid "" "% git checkout main\n" @@ -1775,7 +1776,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:812 +#: documentation/content/en/articles/committers-guide/_index.adoc:811 msgid "" "This will bring up an editor that lists all the commits in it. For this " "example, do not change it at all. This is typically what you are doing " @@ -1784,14 +1785,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:814 +#: documentation/content/en/articles/committers-guide/_index.adoc:813 msgid "" "Once you are done with the above, you have to move the commits to ls.c " "forward from the old version of FreeBSD to the newer one." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:821 +#: documentation/content/en/articles/committers-guide/_index.adoc:820 msgid "" "Sometimes there are merge conflicts. That is OK. Do not panic. Instead, " "handle them the same as any other merge conflicts. To keep it simple, I " @@ -1800,7 +1801,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:824 +#: documentation/content/en/articles/committers-guide/_index.adoc:823 msgid "" "Let's say the includes changes upstream in a radical shift to terminfo as " "well as a name change for the option. When you updated, you might see " @@ -1808,7 +1809,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:834 +#: documentation/content/en/articles/committers-guide/_index.adoc:833 #, no-wrap msgid "" "Auto-merging bin/ls/ls.c\n" @@ -1822,12 +1823,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:836 +#: documentation/content/en/articles/committers-guide/_index.adoc:835 msgid "which looks scary." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:838 +#: documentation/content/en/articles/committers-guide/_index.adoc:837 msgid "" "If you bring up an editor, you will see it is a typical 3-way merge conflict " "resolution that you may be familiar with from other source code systems (the " @@ -1835,7 +1836,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:848 +#: documentation/content/en/articles/committers-guide/_index.adoc:847 #, no-wrap msgid "" " <<<<<<< HEAD\n" @@ -1849,19 +1850,19 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:851 +#: documentation/content/en/articles/committers-guide/_index.adoc:850 msgid "The new code is first, and your code is second." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:853 +#: documentation/content/en/articles/committers-guide/_index.adoc:852 msgid "" "The right fix here is to just add a #undef COLORLS_NEW before #ifdef and " "then delete the old changes:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:858 +#: documentation/content/en/articles/committers-guide/_index.adoc:857 #, no-wrap msgid "" "#undef COLORLS_NEW\n" @@ -1870,17 +1871,17 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:860 +#: documentation/content/en/articles/committers-guide/_index.adoc:859 msgid "save the file." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:862 +#: documentation/content/en/articles/committers-guide/_index.adoc:861 msgid "The rebase was interrupted, so you have to complete it:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:866 +#: documentation/content/en/articles/committers-guide/_index.adoc:865 #, no-wrap msgid "" "% git add ls.c\n" @@ -1888,7 +1889,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:871 +#: documentation/content/en/articles/committers-guide/_index.adoc:870 msgid "" "which tells Git that ls.c has been fixed and to continue the rebase " "operation. Since there was a conflict, you will get kicked into the editor " @@ -1897,7 +1898,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:876 +#: documentation/content/en/articles/committers-guide/_index.adoc:875 msgid "" "If you get stuck during the rebase, do not panic. git rebase --abort will " "take you back to a clean slate. It is important, though, to start with an " @@ -1907,7 +1908,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:879 +#: documentation/content/en/articles/committers-guide/_index.adoc:878 msgid "" "For more on this topic, https://www.freecodecamp.org/news/the-ultimate-guide-" "to-git-merge-and-git-rebase/ provides a rather extensive treatment. It is a " @@ -1916,20 +1917,20 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:880 +#: documentation/content/en/articles/committers-guide/_index.adoc:879 #, no-wrap msgid "Switching to a Different FreeBSD Branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:883 +#: documentation/content/en/articles/committers-guide/_index.adoc:882 msgid "" "If you wish to shift from stable/12 to the current branch. If you have a " "deep clone, the following will suffice:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:887 +#: documentation/content/en/articles/committers-guide/_index.adoc:886 #, no-wrap msgid "" "% git checkout main\n" @@ -1937,7 +1938,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:892 +#: documentation/content/en/articles/committers-guide/_index.adoc:891 msgid "" "If you have a local branch, though, there are one or two caveats. First, " "rebase will rewrite history, so you will likely want to do something to save " @@ -1947,7 +1948,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:897 +#: documentation/content/en/articles/committers-guide/_index.adoc:896 #, no-wrap msgid "" "% git checkout no-color-ls\n" @@ -1956,7 +1957,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:904 +#: documentation/content/en/articles/committers-guide/_index.adoc:903 msgid "" "What the above does is checkout no-color-ls. Then create a new name for it " "(no-color-ls-stable-12) in case you need to get back to it. Then you rebase " @@ -1967,19 +1968,19 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:906 +#: documentation/content/en/articles/committers-guide/_index.adoc:905 #, no-wrap msgid "MFC (Merge From Current) Procedures" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:907 +#: documentation/content/en/articles/committers-guide/_index.adoc:906 #, no-wrap msgid "Summary" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:911 +#: documentation/content/en/articles/committers-guide/_index.adoc:910 msgid "" "MFC workflow can be summarized as `git cherry-pick -x` plus `git commit --" "amend` to adjust the commit message. For multiple commits, use `git rebase " @@ -1987,13 +1988,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:912 +#: documentation/content/en/articles/committers-guide/_index.adoc:911 #, no-wrap msgid "Single commit MFC" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:918 +#: documentation/content/en/articles/committers-guide/_index.adoc:917 #, no-wrap msgid "" "% git checkout stable/X\n" @@ -2001,7 +2002,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:922 +#: documentation/content/en/articles/committers-guide/_index.adoc:921 msgid "" "For MFC commits, for example a vendor import, you would need to specify one " "parent for cherry-pick purposes. Normally, that would be the \"first " @@ -2009,7 +2010,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:927 +#: documentation/content/en/articles/committers-guide/_index.adoc:926 #, no-wrap msgid "" "% git checkout stable/X\n" @@ -2017,58 +2018,58 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:930 +#: documentation/content/en/articles/committers-guide/_index.adoc:929 msgid "" "If things go wrong, you'll either need to abort the cherry-pick with `git " "cherry-pick --abort` or fix it up and do a `git cherry-pick --continue`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:933 +#: documentation/content/en/articles/committers-guide/_index.adoc:932 msgid "" "Once the cherry-pick is finished, push with `git push`. If you get an error " "due to losing the commit race, use `git pull --rebase` and try to push again." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:934 +#: documentation/content/en/articles/committers-guide/_index.adoc:933 #, no-wrap msgid "MFC to RELENG branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:938 +#: documentation/content/en/articles/committers-guide/_index.adoc:937 msgid "" "MFCs to branches that require approval require a bit more care. The process " "is the same for either a typical merge or an exceptional direct commit." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:940 +#: documentation/content/en/articles/committers-guide/_index.adoc:939 msgid "" "Merge or direct commit to the appropriate `stable/X` branch first before " "merging to the `releng/X.Y` branch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:941 +#: documentation/content/en/articles/committers-guide/_index.adoc:940 msgid "" "Use the hash that's in the `stable/X` branch for the MFC to `releng/X.Y` " "branch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:942 +#: documentation/content/en/articles/committers-guide/_index.adoc:941 msgid "Leave both \"cherry picked from\" lines in the commit message." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:943 +#: documentation/content/en/articles/committers-guide/_index.adoc:942 msgid "Be sure to add the `Approved by:` line when you are in the editor." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:948 +#: documentation/content/en/articles/committers-guide/_index.adoc:947 #, no-wrap msgid "" "% git checkout releng/13.0\n" @@ -2076,20 +2077,20 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:951 +#: documentation/content/en/articles/committers-guide/_index.adoc:950 msgid "" "If you forget to to add the `Approved by:` line, you can do a `git commit --" "amend` to edit the commit message before you push the change." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:952 +#: documentation/content/en/articles/committers-guide/_index.adoc:951 #, no-wrap msgid "Multiple commit MFC" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:963 +#: documentation/content/en/articles/committers-guide/_index.adoc:962 #, no-wrap msgid "" "% git checkout -b tmp-branch stable/X\n" @@ -2102,12 +2103,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:966 +#: documentation/content/en/articles/committers-guide/_index.adoc:965 msgid "If the push fails due to losing the commit race, rebase and try again:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:974 +#: documentation/content/en/articles/committers-guide/_index.adoc:973 #, no-wrap msgid "" "% git checkout stable/X\n" @@ -2118,12 +2119,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:977 +#: documentation/content/en/articles/committers-guide/_index.adoc:976 msgid "Once the MFC is complete, you can delete the temporary branch:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:982 +#: documentation/content/en/articles/committers-guide/_index.adoc:981 #, no-wrap msgid "" "% git checkout stable/X\n" @@ -2131,13 +2132,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:984 +#: documentation/content/en/articles/committers-guide/_index.adoc:983 #, no-wrap msgid "MFC a vendor import" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:989 +#: documentation/content/en/articles/committers-guide/_index.adoc:988 msgid "" "Vendor imports are the only thing in the tree that creates a merge commit in " "the `main` branch. Cherry picking merge commits into stable/XX presents an " @@ -2147,20 +2148,20 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:993 +#: documentation/content/en/articles/committers-guide/_index.adoc:992 #, no-wrap msgid "% git cherry-pick -x -m 1 $HASH\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:996 +#: documentation/content/en/articles/committers-guide/_index.adoc:995 msgid "" "is typically what you want. This will tell cherry-pick to apply the correct " "diff." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1000 +#: documentation/content/en/articles/committers-guide/_index.adoc:999 msgid "" "There are some, hopefully, rare cases where it's possible that the `main` " "branch was merged backwards by the conversion script. Should that be the " @@ -2169,7 +2170,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1004 +#: documentation/content/en/articles/committers-guide/_index.adoc:1003 #, no-wrap msgid "" "% git cherry-pick --abort\n" @@ -2177,93 +2178,93 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1006 +#: documentation/content/en/articles/committers-guide/_index.adoc:1005 msgid "to do that. The `--abort` will cleanup the failed first attempt." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1007 +#: documentation/content/en/articles/committers-guide/_index.adoc:1006 #, no-wrap msgid "Redoing a MFC" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1011 +#: documentation/content/en/articles/committers-guide/_index.adoc:1010 msgid "" "If you do a MFC, and it goes horribly wrong and you want to start over, then " "the easiest way is to use `git reset --hard` like so:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1014 +#: documentation/content/en/articles/committers-guide/_index.adoc:1013 #, no-wrap msgid "% git reset --hard freebsd/stable/12\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1017 +#: documentation/content/en/articles/committers-guide/_index.adoc:1016 msgid "" "though if you have some revs you want to keep, and others you don't, using " "`git rebase -i` is better." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1018 +#: documentation/content/en/articles/committers-guide/_index.adoc:1017 #, no-wrap msgid "Considerations when MFCing" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1021 +#: documentation/content/en/articles/committers-guide/_index.adoc:1020 msgid "" "When committing source commits to stable and releng branches, we have the " "following goals:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1023 +#: documentation/content/en/articles/committers-guide/_index.adoc:1022 msgid "" "Clearly mark direct commits distinct from commits that land a change from " "another branch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1024 +#: documentation/content/en/articles/committers-guide/_index.adoc:1023 msgid "Avoid introducing known breakage into stable and releng branches." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1025 +#: documentation/content/en/articles/committers-guide/_index.adoc:1024 msgid "" "Allow developers to determine which changes have or have not been landed " "from one branch to another." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1027 +#: documentation/content/en/articles/committers-guide/_index.adoc:1026 msgid "" "With Subversion, we used the following practices to achieve these goals:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1029 +#: documentation/content/en/articles/committers-guide/_index.adoc:1028 msgid "" "Using `MFC` and `MFS` tags to mark commits that merged changes from another " "branch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1030 +#: documentation/content/en/articles/committers-guide/_index.adoc:1029 msgid "Squashing fixup commits into the main commit when merging a change." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1031 +#: documentation/content/en/articles/committers-guide/_index.adoc:1030 msgid "Recording mergeinfo so that `svn mergeinfo --show-revs` worked." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1035 +#: documentation/content/en/articles/committers-guide/_index.adoc:1034 msgid "" "With Git, we will need to use different strategies to achieve the same " "goals. This document aims to define best practices when merging source " @@ -2273,7 +2274,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1038 +#: documentation/content/en/articles/committers-guide/_index.adoc:1037 msgid "" "One general note: due to technical differences with Git, we will not be " "using Git \"merge commits\" (created via `git merge`) in stable or releng " @@ -2284,13 +2285,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1039 +#: documentation/content/en/articles/committers-guide/_index.adoc:1038 #, no-wrap msgid "Finding Eligible Hashes to MFC" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1045 +#: documentation/content/en/articles/committers-guide/_index.adoc:1044 msgid "" "Git provides some built-in support for this via the `git cherry` and `git " "log --cherry` commands. These commands compare the raw diffs of commits " @@ -2304,24 +2305,24 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1046 +#: documentation/content/en/articles/committers-guide/_index.adoc:1045 #, no-wrap msgid "Commit message standards" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1047 +#: documentation/content/en/articles/committers-guide/_index.adoc:1046 #, no-wrap msgid "Marking MFCs" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1050 +#: documentation/content/en/articles/committers-guide/_index.adoc:1049 msgid "The project has adopted the following practice for marking MFCs:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1052 +#: documentation/content/en/articles/committers-guide/_index.adoc:1051 msgid "" "Use the `-x` flag with `git cherry-pick`. This adds a line to the commit " "message that includes the hash of the original commit when merging. Since it " @@ -2330,19 +2331,19 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1054 +#: documentation/content/en/articles/committers-guide/_index.adoc:1053 msgid "" "When merging multiple commits, keep all the \"cherry picked from\" lines." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1055 +#: documentation/content/en/articles/committers-guide/_index.adoc:1054 #, no-wrap msgid "Trim Metadata?" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1059 +#: documentation/content/en/articles/committers-guide/_index.adoc:1058 msgid "" "One area that was not clearly documented with Subversion (or even CVS) is " "how to format metadata in log messages for MFC commits. Should it include " @@ -2351,7 +2352,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1068 +#: documentation/content/en/articles/committers-guide/_index.adoc:1067 msgid "" "Historical practice has varied, though some of the variance is by field. " "For example, MFCs that are relevant to a PR generally include the PR field " @@ -2370,7 +2371,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1072 +#: documentation/content/en/articles/committers-guide/_index.adoc:1071 msgid "" "For MFCs regulated by re@, new metadata fields are added, such as the " "Approved by tag for approved commits. This new metadata will have to be " @@ -2380,14 +2381,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1075 +#: documentation/content/en/articles/committers-guide/_index.adoc:1074 msgid "" "Preserving existing metadata provides a very simple workflow. Developers " "use `git cherry-pick -x` without having to edit the log message." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1078 +#: documentation/content/en/articles/committers-guide/_index.adoc:1077 msgid "" "If instead we choose to adjust metadata in MFCs, developers will have to " "edit log messages explicitly via the use of `git cherry-pick --edit` or `git " @@ -2397,38 +2398,38 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1080 +#: documentation/content/en/articles/committers-guide/_index.adoc:1079 msgid "" "The bottom line is that developers will likely need to curate their commit " "message for MFCs that are non-trivial." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:1082 +#: documentation/content/en/articles/committers-guide/_index.adoc:1081 #, no-wrap msgid "Vendor Imports with Git" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1085 +#: documentation/content/en/articles/committers-guide/_index.adoc:1084 msgid "This section describes the vendor import procedure with Git in detail." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1086 +#: documentation/content/en/articles/committers-guide/_index.adoc:1085 #, no-wrap msgid "Branch naming convention" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1089 +#: documentation/content/en/articles/committers-guide/_index.adoc:1088 msgid "" "All vendor branches and tags start with `vendor/`. These branches and tags " "are visible by default." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1094 +#: documentation/content/en/articles/committers-guide/_index.adoc:1093 msgid "" "This chapter follows the convention that the `freebsd` origin is the origin " "name for the official FreeBSD Git repository. If you use a different " @@ -2437,20 +2438,20 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1098 +#: documentation/content/en/articles/committers-guide/_index.adoc:1097 msgid "" "We will explore an example for updating NetBSD's mtree that is in our tree. " "The vendor branch for this is `vendor/NetBSD/mtree`." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1099 +#: documentation/content/en/articles/committers-guide/_index.adoc:1098 #, no-wrap msgid "Updating an old vendor import" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1105 +#: documentation/content/en/articles/committers-guide/_index.adoc:1104 msgid "" "The vendor trees usually have only the subset of the third-party software " "that is appropriate to FreeBSD. These trees are usually tiny in comparison " @@ -2460,26 +2461,26 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1109 +#: documentation/content/en/articles/committers-guide/_index.adoc:1108 #, no-wrap msgid "% git worktree add ../mtree vendor/NetBSD/mtree\n" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1111 +#: documentation/content/en/articles/committers-guide/_index.adoc:1110 #, no-wrap msgid "Update the Sources in the Vendor Branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1114 +#: documentation/content/en/articles/committers-guide/_index.adoc:1113 msgid "" "Prepare a full, clean tree of the vendor sources. Import everything but " "merge only what is needed." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1118 +#: documentation/content/en/articles/committers-guide/_index.adoc:1117 msgid "" "This example assumes the NetBSD source is checked out from their GitHub " "mirror in `~/git/NetBSD`. Note that \"upstream\" might have added or " @@ -2488,7 +2489,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1132 +#: documentation/content/en/articles/committers-guide/_index.adoc:1131 #, no-wrap msgid "" "% cd ../mtree\n" @@ -2505,7 +2506,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1145 +#: documentation/content/en/articles/committers-guide/_index.adoc:1144 msgid "" "It is critical to verify that the source code you are importing comes from a " "trustworthy source. Many open-source projects use cryptographic signatures " @@ -2521,7 +2522,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1149 +#: documentation/content/en/articles/committers-guide/_index.adoc:1148 msgid "" "Always run the `git diff` and `git status` commands and examine the results " "carefully. When in doubt, it is useful to do a `git annotate` on the vendor " @@ -2529,14 +2530,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1152 +#: documentation/content/en/articles/committers-guide/_index.adoc:1151 msgid "" "In the example above we used `-m` to illustrate, but you should compose a " "proper message in an editor (using a commit message template)." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1157 +#: documentation/content/en/articles/committers-guide/_index.adoc:1156 msgid "" "It is also important to create an annotated tag using `git tag -a`, " "otherwise the push will be rejected. Only annotated tags are allowed to be " @@ -2546,44 +2547,44 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1158 +#: documentation/content/en/articles/committers-guide/_index.adoc:1157 #, no-wrap msgid "Updating the FreeBSD Copy" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1161 +#: documentation/content/en/articles/committers-guide/_index.adoc:1160 msgid "At this point you can push the import to `vendor` into our repo." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1165 +#: documentation/content/en/articles/committers-guide/_index.adoc:1164 #, no-wrap msgid "% git push --follow-tags freebsd vendor/NetBSD/mtree\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1168 +#: documentation/content/en/articles/committers-guide/_index.adoc:1167 msgid "" "`--follow-tags` tells `git push` to also push tags associated with the " "locally committed revision." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1169 +#: documentation/content/en/articles/committers-guide/_index.adoc:1168 #, no-wrap msgid "Updating the FreeBSD source tree" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1173 +#: documentation/content/en/articles/committers-guide/_index.adoc:1172 msgid "" "Now you need to update the mtree in FreeBSD. The sources live in `contrib/" "mtree` since it is upstream software." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1179 +#: documentation/content/en/articles/committers-guide/_index.adoc:1178 msgid "" "From time to time, we may have to make changes to the contributed code to " "better satisfy FreeBSD's needs. Whenever possible, please try to contribute " @@ -2593,7 +2594,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1184 +#: documentation/content/en/articles/committers-guide/_index.adoc:1183 #, no-wrap msgid "" "% cd ../src\n" @@ -2601,7 +2602,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1194 +#: documentation/content/en/articles/committers-guide/_index.adoc:1193 msgid "" "This would generate a subtree merge commit of `contrib/mtree` against the " "local `vendor/NetBSD/mtree` branch. Examine the diff from the merge result " @@ -2614,7 +2615,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1208 +#: documentation/content/en/articles/committers-guide/_index.adoc:1207 msgid "" "Some open-source software includes a `configure` script that generates files " "used to define how the code is built; usually, these generated files like " @@ -2632,7 +2633,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1215 +#: documentation/content/en/articles/committers-guide/_index.adoc:1214 msgid "" "When testing your changes, run them in a chroot or jailed environment, or " "even within a virtual machine first, especially for kernel or library " @@ -2642,13 +2643,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1216 +#: documentation/content/en/articles/committers-guide/_index.adoc:1215 #, no-wrap msgid "Rebasing your change against latest FreeBSD source tree" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1219 +#: documentation/content/en/articles/committers-guide/_index.adoc:1218 msgid "" "Because the current policy recommends against using merges, if the upstream " "FreeBSD `main` moved forward before you get a chance to push, you would have " @@ -2656,7 +2657,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1222 +#: documentation/content/en/articles/committers-guide/_index.adoc:1221 msgid "" "Regular `git rebase` or `git pull --rebase` doesn't know how to rebase a " "merge commit **as a merge commit**, so instead of that you would have to " @@ -2664,111 +2665,111 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1224 +#: documentation/content/en/articles/committers-guide/_index.adoc:1223 msgid "" "The following steps should be taken to easily recreate the merge commit as " "if `git rebase --merge-commits` worked properly:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1226 +#: documentation/content/en/articles/committers-guide/_index.adoc:1225 msgid "cd to the top of the repo" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1227 +#: documentation/content/en/articles/committers-guide/_index.adoc:1226 msgid "Create a side branch `XXX` with the **contents** of the merged tree." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1228 +#: documentation/content/en/articles/committers-guide/_index.adoc:1227 msgid "" "Update this side branch `XXX` to be merged and up-to-date with FreeBSD's " "`main` branch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1229 +#: documentation/content/en/articles/committers-guide/_index.adoc:1228 msgid "" "In the worst case scenario, you would still have to resolve merge conflicts, " "if there was any, but this should be really rare." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1230 +#: documentation/content/en/articles/committers-guide/_index.adoc:1229 msgid "" "Resolve conflicts, and collapse multiple commits down to 1 if need be " "(without conflicts, there's no collapse needed)" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1231 +#: documentation/content/en/articles/committers-guide/_index.adoc:1230 msgid "checkout `main`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1232 +#: documentation/content/en/articles/committers-guide/_index.adoc:1231 msgid "create a branch `YYY` (allows for easier unwinding if things go wrong)" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1233 +#: documentation/content/en/articles/committers-guide/_index.adoc:1232 msgid "Re-do the subtree merge" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1234 +#: documentation/content/en/articles/committers-guide/_index.adoc:1233 msgid "" "Instead of resolving any conflicts from the subtree merge, checkout the " "contents of XXX on top of it." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1235 +#: documentation/content/en/articles/committers-guide/_index.adoc:1234 msgid "" "The trailing `.` is important, as is being at the top level of the repo." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1236 +#: documentation/content/en/articles/committers-guide/_index.adoc:1235 msgid "" "Rather than switching branches to XXX, it splats the contents of XXX on top " "of the repo" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1237 +#: documentation/content/en/articles/committers-guide/_index.adoc:1236 msgid "" "Commit the results with the prior commit message (the example assumes " "there's only one merge on the XXX branch)." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1238 +#: documentation/content/en/articles/committers-guide/_index.adoc:1237 msgid "Make sure the branches are the same." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1239 +#: documentation/content/en/articles/committers-guide/_index.adoc:1238 msgid "" "Do whatever review you need, including having others check it out if you " "think that's needed." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1240 +#: documentation/content/en/articles/committers-guide/_index.adoc:1239 msgid "" "Push the commit, if you 'lost the race' again, just redo these steps again " "(see below for a recipe)" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1241 +#: documentation/content/en/articles/committers-guide/_index.adoc:1240 msgid "Delete the branches once the commit is upstream. They are throw-a-way." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1243 +#: documentation/content/en/articles/committers-guide/_index.adoc:1242 msgid "" "The commands one would use, following the above example of mtree, would be " "like so (the `#` starts a comment to help link commands to descriptions " @@ -2776,7 +2777,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1256 +#: documentation/content/en/articles/committers-guide/_index.adoc:1255 #, no-wrap msgid "" "% cd ../src\t\t\t# CD to top of tree\n" @@ -2792,26 +2793,26 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1259 +#: documentation/content/en/articles/committers-guide/_index.adoc:1258 msgid "" "Note: if things go wrong with the commit, you can reset the `YYY` branch by " "reissuing the checkout command that created it with -B to start over:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1262 +#: documentation/content/en/articles/committers-guide/_index.adoc:1261 #, no-wrap msgid "% git checkout -B YYY freebsd/main # Create new throw-away YYY branch if starting over is just going to be easier\n" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1264 +#: documentation/content/en/articles/committers-guide/_index.adoc:1263 #, no-wrap msgid "Pushing the changes" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1269 +#: documentation/content/en/articles/committers-guide/_index.adoc:1268 msgid "" "Once you think you have a set of changes that are good, you can push it to a " "fork off GitHub or GitLab for others to review. One nice thing about Git is " @@ -2822,14 +2823,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1271 +#: documentation/content/en/articles/committers-guide/_index.adoc:1270 msgid "" "After review, when you are sure it is a good change, you can push it to the " "FreeBSD repo:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1277 +#: documentation/content/en/articles/committers-guide/_index.adoc:1276 #, no-wrap msgid "" "% git push freebsd YYY:main\t# put the commit on upstream's 'main' branch\n" @@ -2838,7 +2839,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1284 +#: documentation/content/en/articles/committers-guide/_index.adoc:1283 msgid "" "Note: I used `XXX` and `YYY` to make it obvious they are terrible names and " "should not leave your machine. If you use such names for other work, then " @@ -2850,13 +2851,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1285 +#: documentation/content/en/articles/committers-guide/_index.adoc:1284 #, no-wrap msgid "How to redo things if need be" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1289 +#: documentation/content/en/articles/committers-guide/_index.adoc:1288 msgid "" "If you've tried to do the push in the previous section and it fails, then " "you should do the following to 'redo' things. This sequence keeps the " @@ -2864,7 +2865,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1298 +#: documentation/content/en/articles/committers-guide/_index.adoc:1297 #, no-wrap msgid "" "% git checkout -B XXX YYY\t# recreate that throw-away-branch XXX and switch to it\n" @@ -2876,18 +2877,18 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1301 +#: documentation/content/en/articles/committers-guide/_index.adoc:1300 msgid "Then go check it out as above and push as above when ready." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:1302 +#: documentation/content/en/articles/committers-guide/_index.adoc:1301 #, no-wrap msgid "Creating a new vendor branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1309 +#: documentation/content/en/articles/committers-guide/_index.adoc:1308 msgid "" "There are a number of ways to create a new vendor branch. The recommended " "way is to create a new repository and then merge that with FreeBSD. If one " @@ -2898,13 +2899,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1310 +#: documentation/content/en/articles/committers-guide/_index.adoc:1309 #, no-wrap msgid "Create the repo" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1319 +#: documentation/content/en/articles/committers-guide/_index.adoc:1318 #, no-wrap msgid "" "% cd /some/where\n" @@ -2915,27 +2916,27 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1322 +#: documentation/content/en/articles/committers-guide/_index.adoc:1321 msgid "" "At this point, you have a new repo, where all new commits will go on the " "`vendor/glorbnitz` branch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1324 +#: documentation/content/en/articles/committers-guide/_index.adoc:1323 msgid "" "Git experts can also do this right in their FreeBSD clone, using `git " "checkout --orphan vendor/glorbnitz` if they are more comfortable with that." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1325 +#: documentation/content/en/articles/committers-guide/_index.adoc:1324 #, no-wrap msgid "Copy the sources in" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1329 +#: documentation/content/en/articles/committers-guide/_index.adoc:1328 msgid "" "Since this is a new import, you can just cp the sources in, or use tar or " "even rsync as shown above. And we will add everything, assuming no dot " @@ -2943,7 +2944,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1334 +#: documentation/content/en/articles/committers-guide/_index.adoc:1333 #, no-wrap msgid "" "% cp -r ~/glorbnitz/* .\n" @@ -2951,19 +2952,19 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1337 +#: documentation/content/en/articles/committers-guide/_index.adoc:1336 msgid "" "At this point, you should have a pristine copy of glorbnitz ready to commit." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1341 +#: documentation/content/en/articles/committers-guide/_index.adoc:1340 #, no-wrap msgid "% git commit -m \"Import GlorbNitz frobnosticator revision 3.1415\"\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1346 +#: documentation/content/en/articles/committers-guide/_index.adoc:1345 msgid "" "As above, I used `-m` for simplicity, but you should likely create a commit " "message that explains what a Glorb is and why you'd use a Nitz to get it. " @@ -2973,18 +2974,18 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1347 +#: documentation/content/en/articles/committers-guide/_index.adoc:1346 #, no-wrap msgid "Now import it into our repository" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1350 +#: documentation/content/en/articles/committers-guide/_index.adoc:1349 msgid "Now you need to import the branch into our repository." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1356 +#: documentation/content/en/articles/committers-guide/_index.adoc:1355 #, no-wrap msgid "" "% cd /path/to/freebsd/repo/src\n" @@ -2994,27 +2995,27 @@ msgstr "" #. perhaps the real treasure was the friends it made along the way... #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1360 +#: documentation/content/en/articles/committers-guide/_index.adoc:1359 msgid "" "Note the vendor/glorbnitz branch is in the repo. At this point the `/some/" "where/glorbnitz` can be deleted, if you like. It was only a means to an end." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1362 +#: documentation/content/en/articles/committers-guide/_index.adoc:1361 #, no-wrap msgid "Tag and push" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1365 +#: documentation/content/en/articles/committers-guide/_index.adoc:1364 msgid "" "Steps from here on out are much the same as they are in the case of updating " "a vendor branch, though without the updating the vendor branch step." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1373 +#: documentation/content/en/articles/committers-guide/_index.adoc:1372 #, no-wrap msgid "" "% git worktree add ../glorbnitz vendor/glorbnitz\n" @@ -3025,45 +3026,45 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1376 +#: documentation/content/en/articles/committers-guide/_index.adoc:1375 msgid "By 'good' we mean:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1378 +#: documentation/content/en/articles/committers-guide/_index.adoc:1377 msgid "All the right files are present" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1379 +#: documentation/content/en/articles/committers-guide/_index.adoc:1378 msgid "None of the wrong files are present" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1380 +#: documentation/content/en/articles/committers-guide/_index.adoc:1379 msgid "The vendor branch points at something sensible" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1381 +#: documentation/content/en/articles/committers-guide/_index.adoc:1380 msgid "The tag looks good, and is annotated" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1382 +#: documentation/content/en/articles/committers-guide/_index.adoc:1381 msgid "" "The commit message for the tag has a quick summary of what's new since the " "last tag" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1383 +#: documentation/content/en/articles/committers-guide/_index.adoc:1382 #, no-wrap msgid "Time to finally merge it into the base tree" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1392 +#: documentation/content/en/articles/committers-guide/_index.adoc:1391 #, no-wrap msgid "" "% cd ../src\n" @@ -3074,24 +3075,24 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1395 +#: documentation/content/en/articles/committers-guide/_index.adoc:1394 msgid "Here 'good' means:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1397 +#: documentation/content/en/articles/committers-guide/_index.adoc:1396 msgid "" "All the right files, and none of the wrong ones, were merged into contrib/" "glorbnitz." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1398 +#: documentation/content/en/articles/committers-guide/_index.adoc:1397 msgid "No other changes are in the tree." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1399 +#: documentation/content/en/articles/committers-guide/_index.adoc:1398 msgid "" "The commit messages look crossref:committers-guide[commit-log-message,good]. " "It should contain a summary of what's changed since the last merge to the " @@ -3099,14 +3100,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1400 +#: documentation/content/en/articles/committers-guide/_index.adoc:1399 msgid "" -"UPDATING should be updated if there is anything of note, such as user " -"visible changes, important upgrade concerns, etc." +"`RELNOTES` and `UPDATING` should be updated if there is anything of note, " +"such as user visible changes, important upgrade concerns, etc." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1405 +#: documentation/content/en/articles/committers-guide/_index.adoc:1404 msgid "" "This hasn't connected `glorbnitz` to the build yet. How so do that is " "specific to the software being imported and is beyond the scope of this " @@ -3114,13 +3115,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1407 +#: documentation/content/en/articles/committers-guide/_index.adoc:1406 #, no-wrap msgid "Keeping current" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1413 +#: documentation/content/en/articles/committers-guide/_index.adoc:1412 msgid "" "So, time passes. It's time now to update the tree for the latest changes " "upstream. When you checkout `main` make sure that you have no diffs. It's " @@ -3129,7 +3130,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1416 +#: documentation/content/en/articles/committers-guide/_index.adoc:1415 msgid "" "If you are used to `git pull`, we strongly recommend using the `--ff-only` " "option, and further setting it as the default option. Alternatively, `git " @@ -3137,20 +3138,20 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1420 +#: documentation/content/en/articles/committers-guide/_index.adoc:1419 #, no-wrap msgid "% git config --global pull.ff only\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1423 +#: documentation/content/en/articles/committers-guide/_index.adoc:1422 msgid "" "You may need to omit the --global if you want this setting to apply to only " "this repository." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1429 +#: documentation/content/en/articles/committers-guide/_index.adoc:1428 #, no-wrap msgid "" "% cd freebsd-src\n" @@ -3159,7 +3160,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1433 +#: documentation/content/en/articles/committers-guide/_index.adoc:1432 msgid "" "There is a common trap, that the combination command `git pull` will try to " "perform a merge, which would sometimes creates a merge commit that didn't " @@ -3167,12 +3168,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1435 +#: documentation/content/en/articles/committers-guide/_index.adoc:1434 msgid "The longer form is also recommended." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1442 +#: documentation/content/en/articles/committers-guide/_index.adoc:1441 #, no-wrap msgid "" "% cd freebsd-src\n" @@ -3182,7 +3183,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1447 +#: documentation/content/en/articles/committers-guide/_index.adoc:1446 msgid "" "These commands reset your tree to the `main` branch, and then update it from " "where you pulled the tree from originally. It's important to switch to " @@ -3191,13 +3192,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1451 +#: documentation/content/en/articles/committers-guide/_index.adoc:1450 #, no-wrap msgid "% git rebase -i main working\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1458 +#: documentation/content/en/articles/committers-guide/_index.adoc:1457 msgid "" "This will bring up an interactive screen to change the defaults. For now, " "just exit the editor. Everything should just apply. If not, then you'll " @@ -3207,51 +3208,51 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1460 +#: documentation/content/en/articles/committers-guide/_index.adoc:1459 #, no-wrap msgid "Time to push changes upstream" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1463 +#: documentation/content/en/articles/committers-guide/_index.adoc:1462 msgid "" "First, ensure that the push URL is properly configured for the upstream " "repository." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1467 +#: documentation/content/en/articles/committers-guide/_index.adoc:1466 #, no-wrap msgid "% git remote set-url --push freebsd ssh://git@gitrepo.freebsd.org/src.git\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1471 +#: documentation/content/en/articles/committers-guide/_index.adoc:1470 msgid "" "Then, verify that user name and email are configured right. We require that " "they exactly match the passwd entry in FreeBSD cluster." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1473 +#: documentation/content/en/articles/committers-guide/_index.adoc:1472 msgid "Use" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1477 +#: documentation/content/en/articles/committers-guide/_index.adoc:1476 #, no-wrap msgid "freefall% gen-gitconfig.sh\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1480 +#: documentation/content/en/articles/committers-guide/_index.adoc:1479 msgid "" "on freefall.freebsd.org to get a recipe that you can use directly, assuming /" "usr/local/bin is in the PATH." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1485 +#: documentation/content/en/articles/committers-guide/_index.adoc:1484 msgid "" "The below command merges the `working` branch into the upstream `main` " "branch. It's important that you curate your changes to be just like you " @@ -3262,20 +3263,20 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1489 +#: documentation/content/en/articles/committers-guide/_index.adoc:1488 #, no-wrap msgid "% git push freebsd working:main\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1492 +#: documentation/content/en/articles/committers-guide/_index.adoc:1491 msgid "" "If your push is rejected due to losing a commit race, rebase your branch " "before trying again:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1499 +#: documentation/content/en/articles/committers-guide/_index.adoc:1498 #, no-wrap msgid "" "% git checkout working\n" @@ -3285,13 +3286,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1502 +#: documentation/content/en/articles/committers-guide/_index.adoc:1501 #, no-wrap msgid "Time to push changes upstream (alternative)" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1507 +#: documentation/content/en/articles/committers-guide/_index.adoc:1506 msgid "" "Some people find it easier to merge their changes to their local `main` " "before pushing to the remote repository. Also, `git arc stage` moves " @@ -3300,7 +3301,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1512 +#: documentation/content/en/articles/committers-guide/_index.adoc:1511 #, no-wrap msgid "" "% git checkout main\n" @@ -3309,12 +3310,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1515 +#: documentation/content/en/articles/committers-guide/_index.adoc:1514 msgid "If you lose the race, then try again with" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1519 +#: documentation/content/en/articles/committers-guide/_index.adoc:1518 #, no-wrap msgid "" "% git pull --rebase\n" @@ -3322,7 +3323,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1522 +#: documentation/content/en/articles/committers-guide/_index.adoc:1521 msgid "" "These commands will fetch the most recent `freebsd/main` and then rebase the " "local `main` changes on top of that, which is what you want when you lose " @@ -3331,13 +3332,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1523 +#: documentation/content/en/articles/committers-guide/_index.adoc:1522 #, no-wrap msgid "Finding the Subversion Revision" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1527 +#: documentation/content/en/articles/committers-guide/_index.adoc:1526 msgid "" "You'll need to make sure that you've fetched the notes (see the " "crossref:committers-guide[git-mini-daily-use, Daily use]for details). Once " @@ -3345,44 +3346,44 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1531 +#: documentation/content/en/articles/committers-guide/_index.adoc:1530 #, no-wrap msgid "% git log\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1534 +#: documentation/content/en/articles/committers-guide/_index.adoc:1533 msgid "If you have a specific version in mind, you can use this construct:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1538 +#: documentation/content/en/articles/committers-guide/_index.adoc:1537 #, no-wrap msgid "% git log --grep revision=XXXX\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1542 +#: documentation/content/en/articles/committers-guide/_index.adoc:1541 msgid "" "to find the specific revision. The hex number after 'commit' is the hash " "you can use to refer to this commit." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:1544 +#: documentation/content/en/articles/committers-guide/_index.adoc:1543 #, no-wrap msgid "Git FAQ" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1547 +#: documentation/content/en/articles/committers-guide/_index.adoc:1546 msgid "" "This section provides a number of targeted answers to questions that are " "likely to come up often for users and developers." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1552 +#: documentation/content/en/articles/committers-guide/_index.adoc:1551 msgid "" "We use the common convention of having the origin for the FreeBSD repository " "being 'freebsd' rather than the default 'origin' to allow people to use that " @@ -3391,19 +3392,19 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1554 +#: documentation/content/en/articles/committers-guide/_index.adoc:1553 #, no-wrap msgid "Users" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1556 +#: documentation/content/en/articles/committers-guide/_index.adoc:1555 #, no-wrap msgid "How do I track -current and -stable with only one copy of the repository?" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1561 +#: documentation/content/en/articles/committers-guide/_index.adoc:1560 #, no-wrap msgid "" "**Q:** Although disk space is not a huge issue, it's more efficient to use only one copy of the repository.\n" @@ -3412,7 +3413,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1565 +#: documentation/content/en/articles/committers-guide/_index.adoc:1564 #, no-wrap msgid "" "**A:** You can use Git worktrees.\n" @@ -3421,7 +3422,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1568 +#: documentation/content/en/articles/committers-guide/_index.adoc:1567 msgid "" "First, you need to clone the FreeBSD repository, shown here cloning into " "`freebsd-current` to reduce confusion. $URL is whatever mirror works best " @@ -3429,18 +3430,18 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1572 +#: documentation/content/en/articles/committers-guide/_index.adoc:1571 #, no-wrap msgid "% git clone -o freebsd --config remote.freebsd.fetch='+refs/notes/*:refs/notes/*' $URL freebsd-current\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1575 +#: documentation/content/en/articles/committers-guide/_index.adoc:1574 msgid "then once that's cloned, you can simply create a worktree from it:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1580 +#: documentation/content/en/articles/committers-guide/_index.adoc:1579 #, no-wrap msgid "" "% cd freebsd-current\n" @@ -3448,7 +3449,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1584 +#: documentation/content/en/articles/committers-guide/_index.adoc:1583 msgid "" "this will checkout `stable/12` into a directory named `freebsd-stable-12` " "that's a peer to the `freebsd-current` directory. Once created, it's " @@ -3456,7 +3457,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1594 +#: documentation/content/en/articles/committers-guide/_index.adoc:1593 #, no-wrap msgid "" "% cd freebsd-current\n" @@ -3469,7 +3470,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1597 +#: documentation/content/en/articles/committers-guide/_index.adoc:1596 msgid "" "I recommend using `--ff-only` because it's safer and you avoid accidentally " "getting into a 'merge nightmare' where you have an extra change in your " @@ -3477,52 +3478,52 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1599 +#: documentation/content/en/articles/committers-guide/_index.adoc:1598 msgid "" "Here's https://adventurist.me/posts/00296[a good writeup] that goes into " "more detail." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1600 +#: documentation/content/en/articles/committers-guide/_index.adoc:1599 #, no-wrap msgid "Developers" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1602 +#: documentation/content/en/articles/committers-guide/_index.adoc:1601 #, no-wrap msgid "Ooops! I committed to `main`, instead of another branch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1605 +#: documentation/content/en/articles/committers-guide/_index.adoc:1604 #, no-wrap msgid "**Q:** From time to time, I goof up and mistakenly commit to the `main` branch. What do I do?\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1607 +#: documentation/content/en/articles/committers-guide/_index.adoc:1606 #, no-wrap msgid "**A:** First, don't panic.\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1611 +#: documentation/content/en/articles/committers-guide/_index.adoc:1610 msgid "" "Second, don't push. In fact, you can fix almost anything if you haven't " "pushed. All the answers in this section assume no push has happened." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1613 +#: documentation/content/en/articles/committers-guide/_index.adoc:1612 msgid "" "The following answer assumes you committed to `main` and want to create a " "branch called `issue`:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1619 +#: documentation/content/en/articles/committers-guide/_index.adoc:1618 #, no-wrap msgid "" "% git checkout -b issue # Create the 'issue' branch\n" @@ -3531,13 +3532,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1621 +#: documentation/content/en/articles/committers-guide/_index.adoc:1620 #, no-wrap msgid "Ooops! I committed something to the wrong branch!" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1625 +#: documentation/content/en/articles/committers-guide/_index.adoc:1624 #, no-wrap msgid "" "**Q:** I was working on feature on the `wilma` branch, but accidentally committed a change relevant to the `fred` branch in 'wilma'.\n" @@ -3545,7 +3546,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1629 +#: documentation/content/en/articles/committers-guide/_index.adoc:1628 #, no-wrap msgid "" "**A:** The answer is similar to the previous one, but with cherry picking.\n" @@ -3554,7 +3555,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1637 +#: documentation/content/en/articles/committers-guide/_index.adoc:1636 #, no-wrap msgid "" "# We're on branch wilma\n" @@ -3565,14 +3566,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1640 +#: documentation/content/en/articles/committers-guide/_index.adoc:1639 msgid "" "If it is not the last commit, you can cherry-pick that one change from wilma " "onto fred, then use `git rebase -i` to remove the change from wilma." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1647 +#: documentation/content/en/articles/committers-guide/_index.adoc:1646 #, no-wrap msgid "" "# We're on branch wilma\n" @@ -3582,13 +3583,13 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1650 +#: documentation/content/en/articles/committers-guide/_index.adoc:1649 #, no-wrap msgid "**Q:** But what if I want to commit a few changes to `main`, but keep the rest in `wilma` for some reason?\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1656 +#: documentation/content/en/articles/committers-guide/_index.adoc:1655 #, no-wrap msgid "" "**A:** The same technique above also works if you are wanting to 'land' parts of the branch you are working on into `main` before the rest of the branch is ready (say you noticed an unrelated typo, or fixed an incidental bug).\n" @@ -3599,13 +3600,13 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1658 +#: documentation/content/en/articles/committers-guide/_index.adoc:1657 #, no-wrap msgid "**Q:** I want to split off some changes from branch `wilma` into branch `fred`\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1664 +#: documentation/content/en/articles/committers-guide/_index.adoc:1663 #, no-wrap msgid "" "**A:** The more general answer would be the same as the previous.\n" @@ -3616,7 +3617,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1669 +#: documentation/content/en/articles/committers-guide/_index.adoc:1668 msgid "" "The other way to do this would be to checkout `wilma` and then create the " "branch `fred` to point to the same point in the tree. You can then `git " @@ -3628,7 +3629,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1676 +#: documentation/content/en/articles/committers-guide/_index.adoc:1675 #, no-wrap msgid "" "% git checkout pre-split\t# Go back\n" @@ -3638,14 +3639,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1680 +#: documentation/content/en/articles/committers-guide/_index.adoc:1679 msgid "" "The last step is optional. If you are going to try again to split, you'd " "omit it." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1684 +#: documentation/content/en/articles/committers-guide/_index.adoc:1683 #, no-wrap msgid "" "**Q:** But I did things as I read along and didn't see your advice at the end to create a branch, and now `fred` and `wilma` are all screwed up.\n" @@ -3654,13 +3655,13 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1686 +#: documentation/content/en/articles/committers-guide/_index.adoc:1685 #, no-wrap msgid "**A:** All is not lost. You can figure out it, so long as it hasn't been too long, or too many commits (hundreds).\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1690 +#: documentation/content/en/articles/committers-guide/_index.adoc:1689 msgid "" "So I created a wilma branch and committed a couple of things to it, then " "decided I wanted to split it into fred and wilma. Nothing weird happened " @@ -3669,7 +3670,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1705 +#: documentation/content/en/articles/committers-guide/_index.adoc:1704 #, no-wrap msgid "" "% git reflog\n" @@ -3687,7 +3688,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1713 +#: documentation/content/en/articles/committers-guide/_index.adoc:1712 msgid "" "Here we see the changes I've made. You can use it to figure out where " "things went wrong. I'll just point out a few things here. The first one is " @@ -3697,7 +3698,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1721 +#: documentation/content/en/articles/committers-guide/_index.adoc:1720 msgid "" "Next, 'Encourage contributions' was the last commit I made to `wilma` before " "I decided to split things up. You can also see the same hash is there when " @@ -3710,7 +3711,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1726 +#: documentation/content/en/articles/committers-guide/_index.adoc:1725 #, no-wrap msgid "" "% git checkout -B wilma 869cbd3\n" @@ -3718,7 +3719,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1733 +#: documentation/content/en/articles/committers-guide/_index.adoc:1732 msgid "" "and you are ready to try again. The `checkout -B` with the hash combines " "checking out and creating a branch for it. The `-B` instead of `-b` forces " @@ -3730,7 +3731,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1739 +#: documentation/content/en/articles/committers-guide/_index.adoc:1738 #, no-wrap msgid "" "% git checkout 869cbd3\n" @@ -3739,7 +3740,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1743 +#: documentation/content/en/articles/committers-guide/_index.adoc:1742 #, no-wrap msgid "" "You are in 'detached HEAD' state. You can look around, make experimental\n" @@ -3748,7 +3749,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1751 +#: documentation/content/en/articles/committers-guide/_index.adoc:1750 #, no-wrap msgid "" "HEAD is now at 869cbd3 Encourage contributions\n" @@ -3756,20 +3757,20 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1754 +#: documentation/content/en/articles/committers-guide/_index.adoc:1753 msgid "" "this produces the same effect, but I have to read a lot more and severed " "heads aren't an image I like to contemplate." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1755 +#: documentation/content/en/articles/committers-guide/_index.adoc:1754 #, no-wrap msgid "Ooops! I did a `git pull` and it created a merge commit, what do I do?" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1759 +#: documentation/content/en/articles/committers-guide/_index.adoc:1758 #, no-wrap msgid "" "**Q:** I was on autopilot and did a `git pull` for my development tree and that created a merge commit on `main`.\n" @@ -3777,25 +3778,25 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1761 +#: documentation/content/en/articles/committers-guide/_index.adoc:1760 #, no-wrap msgid "**A:** This can happen when you invoke the pull with your development branch checked out.\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1763 +#: documentation/content/en/articles/committers-guide/_index.adoc:1762 msgid "Many developers use `git pull --rebase` to avoid this situation." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1766 +#: documentation/content/en/articles/committers-guide/_index.adoc:1765 msgid "" "Right after the pull, you will have the new merge commit checked out. Git " "supports a `HEAD^#` syntax to examine the parents of a merge commit:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1771 +#: documentation/content/en/articles/committers-guide/_index.adoc:1770 #, no-wrap msgid "" "git log --oneline HEAD^1 # Look at the first parent's commits\n" @@ -3803,33 +3804,33 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1775 +#: documentation/content/en/articles/committers-guide/_index.adoc:1774 msgid "" "From those logs, you can easily identify which commit is your development " "work. Then you simply reset your branch to the corresponding `HEAD^#`:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1779 +#: documentation/content/en/articles/committers-guide/_index.adoc:1778 #, no-wrap msgid "git reset --hard HEAD^1\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1782 +#: documentation/content/en/articles/committers-guide/_index.adoc:1781 msgid "" "In addition, a `git pull --rebase` at this stage will rebase your changes to " "'main' to the latest 'freebsd/main'." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1784 +#: documentation/content/en/articles/committers-guide/_index.adoc:1783 #, no-wrap msgid "**Q:** But I also need to fix my `main` branch. How do I do that?\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1787 +#: documentation/content/en/articles/committers-guide/_index.adoc:1786 #, no-wrap msgid "" "**A:** Git keeps track of the remote repository branches in a `freebsd/` namespace.\n" @@ -3837,13 +3838,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1791 +#: documentation/content/en/articles/committers-guide/_index.adoc:1790 #, no-wrap msgid "git branch -f main freebsd/main\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1796 +#: documentation/content/en/articles/committers-guide/_index.adoc:1795 msgid "" "There's nothing magical about branches in Git: they are just labels on a " "graph that are automatically moved forward by making commits. So the above " @@ -3852,13 +3853,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1797 +#: documentation/content/en/articles/committers-guide/_index.adoc:1796 #, no-wrap msgid "Mixing and matching branches" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1801 +#: documentation/content/en/articles/committers-guide/_index.adoc:1800 #, no-wrap msgid "" "**Q:** So I have two branches `worker` and `async` that I'd like to combine into one branch called `feature`\n" @@ -3866,13 +3867,13 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1803 +#: documentation/content/en/articles/committers-guide/_index.adoc:1802 #, no-wrap msgid "**A:** This is a job for cherry pick.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1809 +#: documentation/content/en/articles/committers-guide/_index.adoc:1808 #, no-wrap msgid "" "% git checkout worker\n" @@ -3881,20 +3882,20 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1814 +#: documentation/content/en/articles/committers-guide/_index.adoc:1813 msgid "" "You now have a new branch called `feature`. This branch combines commits " "from both branches. You can further curate it with `git rebase`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1816 +#: documentation/content/en/articles/committers-guide/_index.adoc:1815 #, no-wrap msgid "**Q:** I have a branch called `driver` and I'd like to break it up into `kernel` and `userland` so I can evolve them separately and commit each branch as it becomes ready.\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1819 +#: documentation/content/en/articles/committers-guide/_index.adoc:1818 #, no-wrap msgid "" "**A:** This takes a little bit of prep work, but `git rebase` will do the heavy\n" @@ -3902,7 +3903,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1825 +#: documentation/content/en/articles/committers-guide/_index.adoc:1824 #, no-wrap msgid "" "% git checkout driver\t\t# Checkout the driver\n" @@ -3911,7 +3912,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1830 +#: documentation/content/en/articles/committers-guide/_index.adoc:1829 msgid "" "Now you have two identical branches. So, it's time to separate out the " "commits. We'll assume first that all the commits in `driver` go into either " @@ -3919,13 +3920,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1834 +#: documentation/content/en/articles/committers-guide/_index.adoc:1833 #, no-wrap msgid "% git rebase -i main kernel\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1837 +#: documentation/content/en/articles/committers-guide/_index.adoc:1836 msgid "" "and just include the changes you want (with a 'p' or 'pick' line) and just " "delete the commits you don't (this sounds scary, but if worse comes to " @@ -3934,18 +3935,18 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1841 +#: documentation/content/en/articles/committers-guide/_index.adoc:1840 #, no-wrap msgid "% git rebase -i main userland\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1844 +#: documentation/content/en/articles/committers-guide/_index.adoc:1843 msgid "and do the same thing you did with the `kernel` branch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1847 +#: documentation/content/en/articles/committers-guide/_index.adoc:1846 #, no-wrap msgid "" "**Q:** Oh great! I followed the above and forgot a commit in the `kernel` branch.\n" @@ -3953,7 +3954,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1850 +#: documentation/content/en/articles/committers-guide/_index.adoc:1849 #, no-wrap msgid "" "**A:** You can use the `driver` branch to find the hash of the commit is missing and\n" @@ -3961,7 +3962,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1856 +#: documentation/content/en/articles/committers-guide/_index.adoc:1855 #, no-wrap msgid "" "% git checkout kernel\n" @@ -3970,7 +3971,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1862 +#: documentation/content/en/articles/committers-guide/_index.adoc:1861 #, no-wrap msgid "" "**Q:** OK. I have the same situation as the above, but my commits are all mixed up.\n" @@ -3980,7 +3981,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1865 +#: documentation/content/en/articles/committers-guide/_index.adoc:1864 #, no-wrap msgid "" "**A:** In this situation, you'd be better off to curate the original branch to separate\n" @@ -3988,7 +3989,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1870 +#: documentation/content/en/articles/committers-guide/_index.adoc:1869 msgid "" "So let's assume that there's just one commit with a clean tree. You can " "either use `git rebase` with an `edit` line, or you can use this with the " @@ -3998,20 +3999,20 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1874 +#: documentation/content/en/articles/committers-guide/_index.adoc:1873 #, no-wrap msgid "% git reset HEAD^\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1877 +#: documentation/content/en/articles/committers-guide/_index.adoc:1876 msgid "" "Note: Do not, repeat do not, add `--hard` here since that also removes the " "changes from your tree." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1881 +#: documentation/content/en/articles/committers-guide/_index.adoc:1880 msgid "" "Now, if you are lucky, the change needing to be split up falls entirely " "along file lines. In that case you can just do the usual `git add` for the " @@ -4021,20 +4022,20 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1884 +#: documentation/content/en/articles/committers-guide/_index.adoc:1883 msgid "" "If you are not lucky, you'll need to split apart files. There's another " "tool to do that which you can apply one file at a time." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1888 +#: documentation/content/en/articles/committers-guide/_index.adoc:1887 #, no-wrap msgid "git add -i foo/bar.c\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1894 +#: documentation/content/en/articles/committers-guide/_index.adoc:1893 msgid "" "will step through the diffs, prompting you, one at time, whether to include " "or exclude the hunk. Once you're done, `git commit` and you'll have the " @@ -4044,19 +4045,19 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1895 +#: documentation/content/en/articles/committers-guide/_index.adoc:1894 #, no-wrap msgid "Joining the FreeBSD GitHub oranization." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1898 +#: documentation/content/en/articles/committers-guide/_index.adoc:1897 #, no-wrap msgid "**Q:** How do I join the FreeBSD GitHub organization?\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1902 +#: documentation/content/en/articles/committers-guide/_index.adoc:1901 #, no-wrap msgid "" "**A:** Please see https://wiki.freebsd.org/GitHub#Joining_the_Organisation[our GitHub Wiki Info] page for details.\n" @@ -4065,38 +4066,38 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1903 +#: documentation/content/en/articles/committers-guide/_index.adoc:1902 #, no-wrap msgid "Cloning and Mirroring" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1906 +#: documentation/content/en/articles/committers-guide/_index.adoc:1905 #, no-wrap msgid "**Q:** I'd like to mirror the entire Git repository, how do I do that?\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1908 +#: documentation/content/en/articles/committers-guide/_index.adoc:1907 #, no-wrap msgid "**A:** If all you want to do is mirror, then\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1912 +#: documentation/content/en/articles/committers-guide/_index.adoc:1911 #, no-wrap msgid "% git clone --mirror $URL\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1916 +#: documentation/content/en/articles/committers-guide/_index.adoc:1915 msgid "" "will do the trick. However, there are two disadvantages to this if you want " "to use it for anything other than a mirror you'll reclone." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1920 +#: documentation/content/en/articles/committers-guide/_index.adoc:1919 msgid "" "First, this is a 'bare repository' which has the repository database, but no " "checked out worktree. This is great for mirroring, but terrible for day to " @@ -4104,7 +4105,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1928 +#: documentation/content/en/articles/committers-guide/_index.adoc:1927 #, no-wrap msgid "" "% git clone --mirror https://git.freebsd.org/ports.git ports.git\n" @@ -4115,14 +4116,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1931 +#: documentation/content/en/articles/committers-guide/_index.adoc:1930 msgid "" "But if you aren't using your mirror for further local clones, then it's a " "poor match." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1934 +#: documentation/content/en/articles/committers-guide/_index.adoc:1933 msgid "" "The second disadvantage is that Git normally rewrites the refs (branch name, " "tags, etc) from upstream so that your local refs can evolve independently of " @@ -4131,13 +4132,13 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1936 +#: documentation/content/en/articles/committers-guide/_index.adoc:1935 #, no-wrap msgid "**Q:** So what can I do instead?\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1939 +#: documentation/content/en/articles/committers-guide/_index.adoc:1938 #, no-wrap msgid "" "**A:** Well, you can stuff all of the upstream repository's refs into a private namespace in your local repository.\n" @@ -4145,18 +4146,18 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1943 +#: documentation/content/en/articles/committers-guide/_index.adoc:1942 #, no-wrap msgid " fetch = +refs/heads/*:refs/remotes/freebsd/*\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1946 +#: documentation/content/en/articles/committers-guide/_index.adoc:1945 msgid "which says just fetch the branch refs." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1950 +#: documentation/content/en/articles/committers-guide/_index.adoc:1949 msgid "" "However, the FreeBSD repository has a number of other things in it. To see " "those, you can add explicit refspecs for each ref namespace, or you can " @@ -4164,13 +4165,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1954 +#: documentation/content/en/articles/committers-guide/_index.adoc:1953 #, no-wrap msgid "git config --add remote.freebsd.fetch '+refs/*:refs/freebsd/*'\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1958 +#: documentation/content/en/articles/committers-guide/_index.adoc:1957 msgid "" "which will put everything in the upstream repository into your local " "repository's `refs/freebsd/` namespace. Please note, that this also grabs " @@ -4179,32 +4180,32 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1960 +#: documentation/content/en/articles/committers-guide/_index.adoc:1959 msgid "" "You'll need to refer to these 'refs' with their full name because they " "aren't in and of Git's regular namespaces." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1964 +#: documentation/content/en/articles/committers-guide/_index.adoc:1963 #, no-wrap msgid "git log refs/freebsd/vendor/zlib/1.2.10\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1967 +#: documentation/content/en/articles/committers-guide/_index.adoc:1966 msgid "" "would look at the log for the vendor branch for zlib starting at 1.2.10." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:1968 +#: documentation/content/en/articles/committers-guide/_index.adoc:1967 #, no-wrap msgid "Collaborating with others" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1972 +#: documentation/content/en/articles/committers-guide/_index.adoc:1971 msgid "" "One of the keys to good software development on a project as large as " "FreeBSD is the ability to collaborate with others before you push your " @@ -4216,29 +4217,31 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1974 +#: documentation/content/en/articles/committers-guide/_index.adoc:1973 msgid "" "The following instructions show how to set up a user-generated branch, based " "on the FreeBSD `main` branch, and push it to GitHub." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1977 +#: documentation/content/en/articles/committers-guide/_index.adoc:1976 msgid "" "Before you begin, make sure that your local Git repo is up to date and has " "the correct origins set crossref:committers-guide[keeping_current,as shown " "above]." msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1984 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1982 +#, no-wrap msgid "" -"```` % git remote -v freebsd https://git.freebsd.org/src.git (fetch) " -"freebsd ssh://git@gitrepo.freebsd.org/src.git (push) ````" +"% git remote -v\n" +"freebsd https://git.freebsd.org/src.git (fetch)\n" +"freebsd ssh://git@gitrepo.freebsd.org/src.git (push)\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1987 +#: documentation/content/en/articles/committers-guide/_index.adoc:1986 msgid "" "The first step is to create a fork of https://github.com/freebsd/freebsd-" "src[FreeBSD] on GitHub following these https://docs.github.com/en/github/" @@ -4247,12 +4250,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1989 +#: documentation/content/en/articles/committers-guide/_index.adoc:1988 msgid "Now add a remote on your local system that points to your fork:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1997 +#: documentation/content/en/articles/committers-guide/_index.adoc:1996 #, no-wrap msgid "" "% git remote add github git@github.com:gvnn3/freebsd-src.git\n" @@ -4264,20 +4267,20 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2000 +#: documentation/content/en/articles/committers-guide/_index.adoc:1999 msgid "" "With this in place you can create a branch crossref:committers-" "guide[keeping_a_local_branch,as shown above]." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2004 +#: documentation/content/en/articles/committers-guide/_index.adoc:2003 #, no-wrap msgid "% git checkout -b gnn-pr2001-fix\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2008 +#: documentation/content/en/articles/committers-guide/_index.adoc:2007 msgid "" "Make whatever modifications you wish in your branch. Build, test, and once " "you're ready to collaborate with others it's time to push your changes into " @@ -4287,7 +4290,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2014 +#: documentation/content/en/articles/committers-guide/_index.adoc:2013 #, no-wrap msgid "" "% git push github\n" @@ -4296,18 +4299,18 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2016 +#: documentation/content/en/articles/committers-guide/_index.adoc:2015 #, no-wrap msgid " git push --set-upstream github gnn-pr2001-fix\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2019 +#: documentation/content/en/articles/committers-guide/_index.adoc:2018 msgid "Setting the push as +git+ advises allows it to succeed:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2037 +#: documentation/content/en/articles/committers-guide/_index.adoc:2036 #, no-wrap msgid "" "% git push --set-upstream github gnn-feature\n" @@ -4328,12 +4331,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2040 +#: documentation/content/en/articles/committers-guide/_index.adoc:2039 msgid "Subsequent changes to the same branch will push correctly by default:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2053 +#: documentation/content/en/articles/committers-guide/_index.adoc:2052 #, no-wrap msgid "" "% git push\n" @@ -4349,20 +4352,20 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2057 +#: documentation/content/en/articles/committers-guide/_index.adoc:2056 msgid "" "At this point your work is now in your branch on +GitHub+ and you can share " "the link with other collaborators." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2059 +#: documentation/content/en/articles/committers-guide/_index.adoc:2058 #, no-wrap msgid "Landing a github pull request" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2064 +#: documentation/content/en/articles/committers-guide/_index.adoc:2063 msgid "" "This section documents how to land a GitHub pull request that's submitted " "against the FreeBSD Git mirrors at GitHub. While this is not an official " @@ -4375,7 +4378,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2068 +#: documentation/content/en/articles/committers-guide/_index.adoc:2067 msgid "" "Before beginning, make sure that the local Git repo is up to date and has " "the correct origins set crossref:committers-guide[keeping_current,as shown " @@ -4383,7 +4386,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2075 +#: documentation/content/en/articles/committers-guide/_index.adoc:2074 #, no-wrap msgid "" "% git remote -v\n" @@ -4394,7 +4397,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2090 +#: documentation/content/en/articles/committers-guide/_index.adoc:2089 msgid "" "Often pull requests are simple: requests that contain only a single commit. " "In this case, a streamlined approach may be used, though the approach in the " @@ -4421,20 +4424,20 @@ msgid "" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:2094 +#: documentation/content/en/articles/committers-guide/_index.adoc:2093 msgid "" "In addition, please check to make sure that the pull request author name is " "not anonymous. Github's web editing interface generates names like:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2097 +#: documentation/content/en/articles/committers-guide/_index.adoc:2096 #, no-wrap msgid "Author: github-user <38923459+github-user@users.noreply.github.com>\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2100 +#: documentation/content/en/articles/committers-guide/_index.adoc:2099 msgid "" "A polite request to the author for a better name and/or email should be " "made. Extra care should be taken to ensure no style issue or malicious code " @@ -4442,7 +4445,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2113 +#: documentation/content/en/articles/committers-guide/_index.adoc:2112 #, no-wrap msgid "" "% git fetch github pull/$PR/head:staging\n" @@ -4457,58 +4460,58 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2118 +#: documentation/content/en/articles/committers-guide/_index.adoc:2117 msgid "" "For complicated pull requests that have multiple commits with conflicts, " "follow the following outline." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2120 +#: documentation/content/en/articles/committers-guide/_index.adoc:2119 msgid "checkout the pull request `git checkout github/pull/XXX`" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2121 +#: documentation/content/en/articles/committers-guide/_index.adoc:2120 msgid "create a branch to rebase `git checkout -b staging`" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2122 +#: documentation/content/en/articles/committers-guide/_index.adoc:2121 msgid "" "rebase the `staging` branch to the latest `main` with `git rebase -i main " "staging`" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2123 +#: documentation/content/en/articles/committers-guide/_index.adoc:2122 msgid "resolve conflicts and do whatever testing is needed" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2124 +#: documentation/content/en/articles/committers-guide/_index.adoc:2123 msgid "fast forward the `staging` branch into `main` as above" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2125 +#: documentation/content/en/articles/committers-guide/_index.adoc:2124 msgid "final sanity check of changes to make sure all is well" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2126 +#: documentation/content/en/articles/committers-guide/_index.adoc:2125 msgid "push to FreeBSD's Git repository." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2128 +#: documentation/content/en/articles/committers-guide/_index.adoc:2127 msgid "" "This will also work when bringing branches developed elsewhere into the " "local tree for committing." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2131 +#: documentation/content/en/articles/committers-guide/_index.adoc:2130 msgid "" "Once finished with the pull request, close it using GitHub's web interface. " "It is worth noting that if your `github` origin uses `https://`, the only " @@ -4516,18 +4519,18 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2133 +#: documentation/content/en/articles/committers-guide/_index.adoc:2132 #, no-wrap msgid "Version Control History" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2136 +#: documentation/content/en/articles/committers-guide/_index.adoc:2135 msgid "The project has moved to crossref:committers-guide[git-primer,git]." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2142 +#: documentation/content/en/articles/committers-guide/_index.adoc:2141 msgid "" "The FreeBSD source repository switched from CVS to Subversion on May 31st, " "2008. The first real SVN commit is __r179447__. The source repository " @@ -4537,7 +4540,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2148 +#: documentation/content/en/articles/committers-guide/_index.adoc:2147 msgid "" "The FreeBSD `doc/www` repository switched from CVS to Subversion on May " "19th, 2012. The first real SVN commit is __r38821__. The documentation " @@ -4547,7 +4550,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2154 +#: documentation/content/en/articles/committers-guide/_index.adoc:2153 msgid "" "The FreeBSD `ports` repository switched from CVS to Subversion on July 14th, " "2012. The first real SVN commit is __r300894__. The ports repository " @@ -4557,13 +4560,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2156 +#: documentation/content/en/articles/committers-guide/_index.adoc:2155 #, no-wrap msgid "Setup, Conventions, and Traditions" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2161 +#: documentation/content/en/articles/committers-guide/_index.adoc:2160 msgid "" "There are a number of things to do as a new developer. The first set of " "steps is specific to committers only. These steps must be done by a mentor " @@ -4571,25 +4574,25 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2163 +#: documentation/content/en/articles/committers-guide/_index.adoc:2162 #, no-wrap msgid "For New Committers" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2166 +#: documentation/content/en/articles/committers-guide/_index.adoc:2165 msgid "" "Those who have been given commit rights to the FreeBSD repositories must " "follow these steps." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2168 +#: documentation/content/en/articles/committers-guide/_index.adoc:2167 msgid "Get mentor approval before committing each of these changes!" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2169 +#: documentation/content/en/articles/committers-guide/_index.adoc:2168 msgid "" "All [.filename]#src# commits go to FreeBSD-CURRENT first before being merged " "to FreeBSD-STABLE. The FreeBSD-STABLE branch must maintain ABI and API " @@ -4598,18 +4601,18 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2174 +#: documentation/content/en/articles/committers-guide/_index.adoc:2173 #, no-wrap msgid "*Steps for New Committers*\n" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2176 +#: documentation/content/en/articles/committers-guide/_index.adoc:2175 msgid "Add an Author Entity" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2178 +#: documentation/content/en/articles/committers-guide/_index.adoc:2177 msgid "" "[.filename]#doc/shared/authors.adoc# - Add an author entity. Later steps " "depend on this entity, and missing this step will cause the [.filename]#doc/" @@ -4618,12 +4621,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2179 +#: documentation/content/en/articles/committers-guide/_index.adoc:2178 msgid "Update the List of Developers and Contributors" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2181 +#: documentation/content/en/articles/committers-guide/_index.adoc:2180 msgid "" "[.filename]#doc/shared/contrib-committers.adoc# - Add an entry, which will " "then appear in the \"Developers\" section of the extref:{contributors}" @@ -4631,19 +4634,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2183 +#: documentation/content/en/articles/committers-guide/_index.adoc:2182 msgid "" "[.filename]#doc/shared/contrib-additional.adoc# - _Remove_ the entry. " "Entries are sorted by first name." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2184 +#: documentation/content/en/articles/committers-guide/_index.adoc:2183 msgid "Add a News Item" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2186 +#: documentation/content/en/articles/committers-guide/_index.adoc:2185 msgid "" "[.filename]#doc/website/data/en/news/news.toml# - Add an entry. Look for the " "other entries that announce new committers and follow the format. Use the " @@ -4651,12 +4654,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2187 +#: documentation/content/en/articles/committers-guide/_index.adoc:2186 msgid "Add a PGP Key" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2189 +#: documentation/content/en/articles/committers-guide/_index.adoc:2188 msgid "" "`{des}` has written a shell script ([.filename]#doc/documentation/tools/" "addkey.sh#) to make this easier. See the https://cgit.freebsd.org/doc/plain/" @@ -4664,21 +4667,21 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2191 +#: documentation/content/en/articles/committers-guide/_index.adoc:2190 msgid "" "Use [.filename]#doc/documentation/tools/checkkey.sh# to verify that keys " "meet minimal best-practices standards." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2193 +#: documentation/content/en/articles/committers-guide/_index.adoc:2192 msgid "" "After adding and checking a key, add both updated files to source control " "and then commit them. Entries in this file are sorted by last name." msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:2197 +#: documentation/content/en/articles/committers-guide/_index.adoc:2196 msgid "" "It is very important to have a current PGP/GnuPG key in the repository. The " "key may be required for positive identification of a committer. For example, " @@ -4689,12 +4692,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2199 +#: documentation/content/en/articles/committers-guide/_index.adoc:2198 msgid "Update Mentor and Mentee Information" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2201 +#: documentation/content/en/articles/committers-guide/_index.adoc:2200 msgid "" "[.filename]#src/share/misc/committers-<repository>.dot# - Add an entry to " "the current committers section, where _repository_ is `doc`, `ports`, or " @@ -4702,19 +4705,40 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2203 +#: documentation/content/en/articles/committers-guide/_index.adoc:2202 msgid "" "Add an entry for each additional mentor/mentee relationship in the bottom " "section." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2204 +#: documentation/content/en/articles/committers-guide/_index.adoc:2203 +msgid "Update git mailmap file" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2205 +msgid "" +"[.filename]#src/.mailmap#, [.filename]#doc/.mailmap#, and " +"[.filename]#ports/.mailmap# - Add an entry for commits you created prior to " +"becoming a FreeBSD committer." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2208 +msgid "" +"Mapping to your FreeBSD address allows us to track external committers who " +"may be ready for a commit bit more easily. You can also use this to correct " +"old names, mispelled names, etc in the default `git log` output." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2209 msgid "Generate a Kerberos Password" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2206 +#: documentation/content/en/articles/committers-guide/_index.adoc:2211 msgid "" "See crossref:committers-guide[kerberos-ldap, Kerberos and LDAP web Password " "for FreeBSD Cluster] to generate or set a Kerberos account for use with " @@ -4723,12 +4747,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2207 +#: documentation/content/en/articles/committers-guide/_index.adoc:2212 msgid "Optional: Enable Wiki Account" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2211 +#: documentation/content/en/articles/committers-guide/_index.adoc:2216 msgid "" "link:https://wiki.freebsd.org[FreeBSD Wiki] Account - A wiki account allows " "sharing projects and ideas. Those who do not yet have an account can follow " @@ -4738,12 +4762,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2212 +#: documentation/content/en/articles/committers-guide/_index.adoc:2217 msgid "Optional: Update Wiki Information" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2214 +#: documentation/content/en/articles/committers-guide/_index.adoc:2219 msgid "" "Wiki Information - After gaining access to the wiki, some people add entries " "to the https://wiki.freebsd.org/HowWeGotHere[How We Got Here], https://" @@ -4753,12 +4777,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2215 +#: documentation/content/en/articles/committers-guide/_index.adoc:2220 msgid "Optional: Update Ports with Personal Information" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2217 +#: documentation/content/en/articles/committers-guide/_index.adoc:2222 msgid "" "[.filename]#ports/astro/xearth/files/freebsd.committers.markers# and " "[.filename]#src/usr.bin/calendar/calendars/calendar.freebsd# - Some people " @@ -4767,12 +4791,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2218 +#: documentation/content/en/articles/committers-guide/_index.adoc:2223 msgid "Optional: Prevent Duplicate Mailings" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2220 +#: documentation/content/en/articles/committers-guide/_index.adoc:2225 msgid "" "Subscribers to {dev-commits-doc-all}, {dev-commits-ports-all} or {dev-" "commits-src-all} might wish to unsubscribe to avoid receiving duplicate " @@ -4780,13 +4804,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2223 +#: documentation/content/en/articles/committers-guide/_index.adoc:2228 #, no-wrap msgid "For Everyone" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2229 +#: documentation/content/en/articles/committers-guide/_index.adoc:2234 msgid "" "Introduce yourself to the other developers, otherwise no one will have any " "idea who you are or what you are working on. The introduction need not be a " @@ -4796,7 +4820,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2230 +#: documentation/content/en/articles/committers-guide/_index.adoc:2235 msgid "" "Log into `freefall.FreeBSD.org` and create a [.filename]#/var/forward/user# " "(where _user_ is your username) file containing the e-mail address where you " @@ -4809,14 +4833,14 @@ msgid "" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:2234 +#: documentation/content/en/articles/committers-guide/_index.adoc:2239 msgid "" "If your e-mail system uses SPF with strict rules, you should exclude " "`mx2.FreeBSD.org` from SPF checks." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2237 +#: documentation/content/en/articles/committers-guide/_index.adoc:2242 msgid "" "Due to the severe load dealing with SPAM places on the central mail servers " "that do the mailing list processing, the front-end server does do some basic " @@ -4828,7 +4852,7 @@ msgid "" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:2241 +#: documentation/content/en/articles/committers-guide/_index.adoc:2246 msgid "" "Those who are developers but not committers will not be subscribed to the " "committers or developers mailing lists. The subscriptions are derived from " @@ -4836,35 +4860,35 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:2245 +#: documentation/content/en/articles/committers-guide/_index.adoc:2250 #, no-wrap msgid "SMTP Access Setup" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2248 +#: documentation/content/en/articles/committers-guide/_index.adoc:2253 msgid "" "For those willing to send e-mail messages through the FreeBSD.org " "infrastructure, follow the instructions below:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2252 +#: documentation/content/en/articles/committers-guide/_index.adoc:2257 msgid "Point your mail client at `smtp.FreeBSD.org:587`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2253 +#: documentation/content/en/articles/committers-guide/_index.adoc:2258 msgid "Enable STARTTLS." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2254 +#: documentation/content/en/articles/committers-guide/_index.adoc:2259 msgid "Ensure your `From:` address is set to `_yourusername_@FreeBSD.org`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2256 +#: documentation/content/en/articles/committers-guide/_index.adoc:2261 msgid "" "For authentication, you can use your FreeBSD Kerberos username and password " "(see crossref:committers-guide[kerberos-ldap, Kerberos and LDAP web Password " @@ -4873,57 +4897,57 @@ msgid "" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:2260 +#: documentation/content/en/articles/committers-guide/_index.adoc:2265 msgid "Do not include `@FreeBSD.org` when entering in your username." msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2262 +#: documentation/content/en/articles/committers-guide/_index.adoc:2267 #, no-wrap msgid "Additional Notes" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:2266 +#: documentation/content/en/articles/committers-guide/_index.adoc:2271 msgid "" "Will only accept mail from `_yourusername_@FreeBSD.org`. If you are " "authenticated as one user, you are not permitted to send mail from another." msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:2267 +#: documentation/content/en/articles/committers-guide/_index.adoc:2272 msgid "" "A header will be appended with the SASL username: (`Authenticated sender: " "_username_`)." msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:2268 +#: documentation/content/en/articles/committers-guide/_index.adoc:2273 msgid "" "Host has various rate limits in place to cut down on brute force attempts." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:2272 +#: documentation/content/en/articles/committers-guide/_index.adoc:2277 #, no-wrap msgid "Using a Local MTA to Forward Emails to the FreeBSD.org SMTP Service" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2275 +#: documentation/content/en/articles/committers-guide/_index.adoc:2280 msgid "" "It is also possible to use a local MTA to forward locally sent emails to the " "FreeBSD.org SMTP servers." msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2277 +#: documentation/content/en/articles/committers-guide/_index.adoc:2282 #, no-wrap msgid "Using Postfix" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2282 +#: documentation/content/en/articles/committers-guide/_index.adoc:2287 msgid "" "To tell a local Postfix instance that anything from " "`_yourusername_@FreeBSD.org` should be forwarded to the FreeBSD.org servers, " @@ -4931,7 +4955,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2290 +#: documentation/content/en/articles/committers-guide/_index.adoc:2295 #, no-wrap msgid "" "sender_dependent_relayhost_maps = hash:/usr/local/etc/postfix/relayhost_maps\n" @@ -4942,33 +4966,33 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2293 +#: documentation/content/en/articles/committers-guide/_index.adoc:2298 msgid "" "Create [.filename]#/usr/local/etc/postfix/relayhost_maps# with the following " "content:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2297 +#: documentation/content/en/articles/committers-guide/_index.adoc:2302 #, no-wrap msgid "yourusername@FreeBSD.org [smtp.freebsd.org]:587\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2300 +#: documentation/content/en/articles/committers-guide/_index.adoc:2305 msgid "" "Create [.filename]#/usr/local/etc/postfix/sasl_passwd# with the following " "content:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2304 +#: documentation/content/en/articles/committers-guide/_index.adoc:2309 #, no-wrap msgid "[smtp.freebsd.org]:587 yourusername:yourpassword\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2307 +#: documentation/content/en/articles/committers-guide/_index.adoc:2312 msgid "" "If the email server is used by other people, you may want to prevent them " "from sending e-mails from your address. To achieve this, add this to your " @@ -4976,7 +5000,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2312 +#: documentation/content/en/articles/committers-guide/_index.adoc:2317 #, no-wrap msgid "" "smtpd_sender_login_maps = hash:/usr/local/etc/postfix/sender_login_maps\n" @@ -4984,33 +5008,33 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2315 +#: documentation/content/en/articles/committers-guide/_index.adoc:2320 msgid "" "Create [.filename]#/usr/local/etc/postfix/sender_login_maps# with the " "following content:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2319 +#: documentation/content/en/articles/committers-guide/_index.adoc:2324 #, no-wrap msgid "yourusername@FreeBSD.org yourlocalusername\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2322 +#: documentation/content/en/articles/committers-guide/_index.adoc:2327 msgid "" "Where _yourlocalusername_ is the SASL username used to connect to the local " "instance of Postfix." msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2325 +#: documentation/content/en/articles/committers-guide/_index.adoc:2330 #, no-wrap msgid "Using OpenSMTPD" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2330 +#: documentation/content/en/articles/committers-guide/_index.adoc:2335 msgid "" "To tell a local OpenSMTPD instance that anything from " "`_yourusername_@FreeBSD.org` should be forwarded to the FreeBSD.org servers, " @@ -5018,7 +5042,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2335 +#: documentation/content/en/articles/committers-guide/_index.adoc:2340 #, no-wrap msgid "" "action \"freebsd\" relay host smtp+tls://freebsd@smtp.freebsd.org:587 auth <secrets>\n" @@ -5026,32 +5050,32 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2338 +#: documentation/content/en/articles/committers-guide/_index.adoc:2343 msgid "" "Where _yourlocalusername_ is the SASL username used to connect to the local " "instance of OpenSMTPD." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2340 +#: documentation/content/en/articles/committers-guide/_index.adoc:2345 msgid "" "Create [.filename]#/usr/local/etc/mail/secrets# with the following content:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2344 +#: documentation/content/en/articles/committers-guide/_index.adoc:2349 #, no-wrap msgid "freebsd\tyourusername:yourpassword\n" msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2348 +#: documentation/content/en/articles/committers-guide/_index.adoc:2353 #, no-wrap msgid "Using Exim" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2354 +#: documentation/content/en/articles/committers-guide/_index.adoc:2359 #, no-wrap msgid "" "To direct a local Exim instance to forward all mail from `_example_@FreeBSD.org`\n" @@ -5059,7 +5083,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2363 +#: documentation/content/en/articles/committers-guide/_index.adoc:2368 #, no-wrap msgid "" "Routers section: (at the top of the list):\n" @@ -5071,7 +5095,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2375 +#: documentation/content/en/articles/committers-guide/_index.adoc:2380 #, no-wrap msgid "" "Transport Section:\n" @@ -5088,7 +5112,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2382 +#: documentation/content/en/articles/committers-guide/_index.adoc:2387 #, no-wrap msgid "" "Authenticators:\n" @@ -5100,26 +5124,26 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2385 +#: documentation/content/en/articles/committers-guide/_index.adoc:2390 msgid "" "Create [.filename]#/usr/local/etc/exim/freebsd_send# with the following " "content:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2389 +#: documentation/content/en/articles/committers-guide/_index.adoc:2394 #, no-wrap msgid "example@freebsd.org:smtp.freebsd.org::587\n" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2394 +#: documentation/content/en/articles/committers-guide/_index.adoc:2399 #, no-wrap msgid "Mentors" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2399 +#: documentation/content/en/articles/committers-guide/_index.adoc:2404 msgid "" "All new developers have a mentor assigned to them for the first few months. " "A mentor is responsible for teaching the mentee the rules and conventions of " @@ -5129,7 +5153,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2402 +#: documentation/content/en/articles/committers-guide/_index.adoc:2407 msgid "" "For committers: do not commit anything without first getting mentor " "approval. Document that approval with an `Approved by:` line in the commit " @@ -5137,7 +5161,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2407 +#: documentation/content/en/articles/committers-guide/_index.adoc:2412 msgid "" "When the mentor decides that a mentee has learned the ropes and is ready to " "commit on their own, the mentor announces it with a commit to " @@ -5147,13 +5171,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2409 +#: documentation/content/en/articles/committers-guide/_index.adoc:2414 #, no-wrap msgid "Pre-Commit Review" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2414 +#: documentation/content/en/articles/committers-guide/_index.adoc:2419 msgid "" "Code review is one way to increase the quality of software. The following " "guidelines apply to commits to the `main` (-CURRENT) branch of the `src` " @@ -5163,28 +5187,28 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2416 +#: documentation/content/en/articles/committers-guide/_index.adoc:2421 msgid "" "All non-trivial changes should be reviewed before they are committed to the " "repository." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2417 +#: documentation/content/en/articles/committers-guide/_index.adoc:2422 msgid "" "Reviews may be conducted by email, in Bugzilla, in Phabricator, or by " "another mechanism. Where possible, reviews should be public." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2418 +#: documentation/content/en/articles/committers-guide/_index.adoc:2423 msgid "" "The developer responsible for a code change is also responsible for making " "all necessary review-related changes." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2419 +#: documentation/content/en/articles/committers-guide/_index.adoc:2424 msgid "" "Code review can be an iterative process, which continues until the patch is " "ready to be committed. Specifically, once a patch is sent out for review, it " @@ -5194,12 +5218,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2420 +#: documentation/content/en/articles/committers-guide/_index.adoc:2425 msgid "Timeouts are not a substitute for review." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2422 +#: documentation/content/en/articles/committers-guide/_index.adoc:2427 msgid "" "Sometimes code reviews will take longer than you would hope for, especially " "for larger features. Accepted ways to speed up review times for your patches " @@ -5207,14 +5231,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2424 +#: documentation/content/en/articles/committers-guide/_index.adoc:2429 msgid "" "Review other people's patches. If you help out, everybody will be more " "willing to do the same for you; goodwill is our currency." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2425 +#: documentation/content/en/articles/committers-guide/_index.adoc:2430 msgid "" "Ping the patch. If it is urgent, provide reasons why it is important to you " "to get this patch landed and ping it every couple of days. If it is not " @@ -5223,14 +5247,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2426 +#: documentation/content/en/articles/committers-guide/_index.adoc:2431 msgid "" "Ask for help on mailing lists, IRC, etc. Others may be able to either help " "you directly, or suggest a reviewer." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2427 +#: documentation/content/en/articles/committers-guide/_index.adoc:2432 msgid "" "Split your patch into multiple smaller patches that build on each other. The " "smaller your patch, the higher the probability that somebody will take a " @@ -5238,7 +5262,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2429 +#: documentation/content/en/articles/committers-guide/_index.adoc:2434 msgid "" "When making large changes, it is helpful to keep this in mind from the " "beginning of the effort as breaking large changes into smaller ones is often " @@ -5246,7 +5270,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2434 +#: documentation/content/en/articles/committers-guide/_index.adoc:2439 msgid "" "Developers should participate in code reviews as both reviewers and " "reviewees. If someone is kind enough to review your code, you should return " @@ -5257,7 +5281,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2437 +#: documentation/content/en/articles/committers-guide/_index.adoc:2442 msgid "" "In some cases, no subject-matter expert may be available. In those cases, a " "review by an experienced developer is sufficient when coupled with " @@ -5265,26 +5289,26 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2439 +#: documentation/content/en/articles/committers-guide/_index.adoc:2444 #, no-wrap msgid "Commit Log Messages" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2442 +#: documentation/content/en/articles/committers-guide/_index.adoc:2447 msgid "" "This section contains some suggestions and traditions for how commit logs " "are formatted." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2443 +#: documentation/content/en/articles/committers-guide/_index.adoc:2448 #, no-wrap msgid "Why are commit messages important?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2447 +#: documentation/content/en/articles/committers-guide/_index.adoc:2452 msgid "" "When you commit a change in Git, Subversion, or another version control " "system (VCS), you're prompted to write some text describing the commit -- a " @@ -5294,7 +5318,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2450 +#: documentation/content/en/articles/committers-guide/_index.adoc:2455 msgid "" "Most projects have more than one developer and last for some length of " "time. Commit messages are a very important method of communicating with " @@ -5302,7 +5326,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2453 +#: documentation/content/en/articles/committers-guide/_index.adoc:2458 msgid "" "FreeBSD has hundreds of active developers and hundreds of thousands of " "commits spanning decades of history. Over that time the developer community " @@ -5311,17 +5335,17 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2455 +#: documentation/content/en/articles/committers-guide/_index.adoc:2460 msgid "Commit messages serve at least three purposes:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2457 +#: documentation/content/en/articles/committers-guide/_index.adoc:2462 msgid "Communicating with other developers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2462 +#: documentation/content/en/articles/committers-guide/_index.adoc:2467 msgid "" "FreeBSD commits generate email to various mailing lists. These include the " "commit message along with a copy of the patch itself. Commit messages are " @@ -5333,12 +5357,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2464 +#: documentation/content/en/articles/committers-guide/_index.adoc:2469 msgid "Making Changes Discoverable" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2468 +#: documentation/content/en/articles/committers-guide/_index.adoc:2473 msgid "" "In a large project with a long history it may be difficult to find changes " "of interest when investigating an issue or change in behaviour. Verbose, " @@ -5347,12 +5371,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2470 +#: documentation/content/en/articles/committers-guide/_index.adoc:2475 msgid "Providing historical documentation" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2474 +#: documentation/content/en/articles/committers-guide/_index.adoc:2479 msgid "" "Commit messages serve to document changes for future developers, perhaps " "years or decades later. This future developer may even be you, the original " @@ -5361,27 +5385,27 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2476 +#: documentation/content/en/articles/committers-guide/_index.adoc:2481 msgid "" "The `git blame` command annotates each line of a source file with the change " "(hash and subject line) that brought it in." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2478 +#: documentation/content/en/articles/committers-guide/_index.adoc:2483 msgid "" "Having established the importance, here are elements of a good FreeBSD " "commit message:" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2479 +#: documentation/content/en/articles/committers-guide/_index.adoc:2484 #, no-wrap msgid "Start with a subject line" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2483 +#: documentation/content/en/articles/committers-guide/_index.adoc:2488 msgid "" "Commit messages should start with a single-line subject that briefly " "summarizes the change. The subject should, by itself, allow the reader to " @@ -5389,13 +5413,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2484 +#: documentation/content/en/articles/committers-guide/_index.adoc:2489 #, no-wrap msgid "Keep subject lines short" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2489 +#: documentation/content/en/articles/committers-guide/_index.adoc:2494 msgid "" "The subject line should be as short as possible while still retaining the " "required information. This is to make browsing Git log more efficient, and " @@ -5405,13 +5429,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2490 +#: documentation/content/en/articles/committers-guide/_index.adoc:2495 #, no-wrap msgid "Prefix the subject line with a component, if applicable" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2494 +#: documentation/content/en/articles/committers-guide/_index.adoc:2499 msgid "" "If the change relates to a specific component the subject line may be " "prefixed with that component name and a colon (:). If applicable, try to " @@ -5419,73 +5443,73 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2496 +#: documentation/content/en/articles/committers-guide/_index.adoc:2501 msgid "✓ `foo: Add -k option to keep temporary data`" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2498 +#: documentation/content/en/articles/committers-guide/_index.adoc:2503 msgid "" "Include the prefix in the 67-character limit suggested above, so that `git " "log --oneline` avoids wrapping." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2499 +#: documentation/content/en/articles/committers-guide/_index.adoc:2504 #, no-wrap msgid "Capitalize the first letter of the subject" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2503 +#: documentation/content/en/articles/committers-guide/_index.adoc:2508 msgid "" "Capitalize the first letter of the subject itself. The prefix, if any, is " "not capitalized unless necessary (e.g., `USB:` is capitalized)." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2504 +#: documentation/content/en/articles/committers-guide/_index.adoc:2509 #, no-wrap msgid "Do not end the subject line with punctuation" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2508 +#: documentation/content/en/articles/committers-guide/_index.adoc:2513 msgid "" "Do not end with a period or other punctuation. In this regard the subject " "line is like a newspaper headline." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2509 +#: documentation/content/en/articles/committers-guide/_index.adoc:2514 #, no-wrap msgid "Separate the subject and body with a blank line" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2512 +#: documentation/content/en/articles/committers-guide/_index.adoc:2517 msgid "Separate the body from the subject with a blank line." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2514 +#: documentation/content/en/articles/committers-guide/_index.adoc:2519 msgid "" "Some trivial commits do not require a body, and will have only a subject." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2516 +#: documentation/content/en/articles/committers-guide/_index.adoc:2521 msgid "✓ `ls: Fix typo in usage text`" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2517 +#: documentation/content/en/articles/committers-guide/_index.adoc:2522 #, no-wrap msgid "Limit messages to 72 columns" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2523 +#: documentation/content/en/articles/committers-guide/_index.adoc:2528 msgid "" "`git log` and `git format-patch` indent the commit message by four spaces. " "Wrapping at 72 columns provides a matching margin on the right edge. " @@ -5496,13 +5520,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2524 +#: documentation/content/en/articles/committers-guide/_index.adoc:2529 #, no-wrap msgid "Use the present tense, imperative mood" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2529 +#: documentation/content/en/articles/committers-guide/_index.adoc:2534 msgid "" "This facilitates short subject lines and provides consistency, including " "with automatically generated commit messages (e.g., as generated by git " @@ -5512,7 +5536,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2534 +#: documentation/content/en/articles/committers-guide/_index.adoc:2539 #, no-wrap msgid "" "✓ `foo: Implement the -k (keep) option`\n" @@ -5522,20 +5546,20 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2535 +#: documentation/content/en/articles/committers-guide/_index.adoc:2540 #, no-wrap msgid "Focus on what and why, not how" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2538 +#: documentation/content/en/articles/committers-guide/_index.adoc:2543 msgid "" "Explain what the change accomplishes and why it is being done, rather than " "how." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2542 +#: documentation/content/en/articles/committers-guide/_index.adoc:2547 msgid "" "Do not assume that the reader is familiar with the issue. Explain the " "background and motivation for the change. Include benchmark data if you " @@ -5543,20 +5567,20 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2544 +#: documentation/content/en/articles/committers-guide/_index.adoc:2549 msgid "" "If there are limitations or incomplete aspects of the change, describe them " "in the commit message." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2545 +#: documentation/content/en/articles/committers-guide/_index.adoc:2550 #, no-wrap msgid "Consider whether parts of the commit message could be code comments instead" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2548 +#: documentation/content/en/articles/committers-guide/_index.adoc:2553 msgid "" "Sometimes while writing a commit message you may find yourself writing a " "sentence or two explaining some tricky or confusing aspect of the change. " @@ -5565,13 +5589,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2549 +#: documentation/content/en/articles/committers-guide/_index.adoc:2554 #, no-wrap msgid "Write commit messages for your future self" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2553 +#: documentation/content/en/articles/committers-guide/_index.adoc:2558 msgid "" "While writing the commit message for a change you have all of the context in " "mind - what prompted the change, alternate approaches that were considered " @@ -5581,13 +5605,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2554 +#: documentation/content/en/articles/committers-guide/_index.adoc:2559 #, no-wrap msgid "Commit messages should stand alone" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2558 +#: documentation/content/en/articles/committers-guide/_index.adoc:2563 msgid "" "You may include references to mailing list postings, benchmark result web " "sites, or code review links. However, the commit message should contain all " @@ -5596,7 +5620,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2562 +#: documentation/content/en/articles/committers-guide/_index.adoc:2567 msgid "" "Similarly, a commit may refer to a previous commit, for example in the case " "of a bug fix or revert. In addition to the commit identifier (revision or " @@ -5607,27 +5631,27 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2563 +#: documentation/content/en/articles/committers-guide/_index.adoc:2568 #, no-wrap msgid "Include appropriate metadata in a footer" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2566 +#: documentation/content/en/articles/committers-guide/_index.adoc:2571 msgid "" "As well as including an informative message with each commit, some " "additional information may be needed." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2568 +#: documentation/content/en/articles/committers-guide/_index.adoc:2573 msgid "" "This information consists of one or more lines containing the key word or " "phrase, a colon, tabs for formatting, and then the additional information." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2570 +#: documentation/content/en/articles/committers-guide/_index.adoc:2575 msgid "" "For key words where multiple values make sense (e.g., `PR:` with a comma-" "separated list of PRs), it is permitted to use the same keyword multiple " @@ -5635,30 +5659,30 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2572 +#: documentation/content/en/articles/committers-guide/_index.adoc:2577 msgid "The key words or phrases are:" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2578 +#: documentation/content/en/articles/committers-guide/_index.adoc:2583 #, no-wrap msgid "`PR:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2580 +#: documentation/content/en/articles/committers-guide/_index.adoc:2585 #, no-wrap msgid "The problem report (if any) which is affected (typically, by being closed) by this commit. Multiple PRs may be specified on one line, separated by commas or spaces." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2581 +#: documentation/content/en/articles/committers-guide/_index.adoc:2586 #, no-wrap msgid "`Reported by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2585 +#: documentation/content/en/articles/committers-guide/_index.adoc:2590 #, no-wrap msgid "" "The name and e-mail address of the person that reported the issue; for developers, just the username on the FreeBSD cluster.\n" @@ -5667,7 +5691,7 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2587 +#: documentation/content/en/articles/committers-guide/_index.adoc:2592 #, no-wrap msgid "" "`Submitted by:` +\n" @@ -5675,19 +5699,19 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2589 +#: documentation/content/en/articles/committers-guide/_index.adoc:2594 #, no-wrap msgid "This has been deprecated with git; submitted patches should have the author set by using `git commit --author` with a full name and valid email." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2590 +#: documentation/content/en/articles/committers-guide/_index.adoc:2595 #, no-wrap msgid "`Reviewed by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2605 +#: documentation/content/en/articles/committers-guide/_index.adoc:2610 #, no-wrap msgid "" "The name and e-mail address of the person or people that reviewed the change; for developers, just the username on the FreeBSD cluster. If a patch was submitted to a mailing list for review, and the review was favorable, then just include the list name. If the reviewer is not a member of the project, provide the name, email, and if ports an external role like maintainer:\n" @@ -5706,25 +5730,25 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2606 +#: documentation/content/en/articles/committers-guide/_index.adoc:2611 #, no-wrap msgid "`Tested by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2608 +#: documentation/content/en/articles/committers-guide/_index.adoc:2613 #, no-wrap msgid "The name and e-mail address of the person or people that tested the change; for developers, just the username on the FreeBSD cluster." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2609 +#: documentation/content/en/articles/committers-guide/_index.adoc:2614 #, no-wrap msgid "`Discussed with:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2612 +#: documentation/content/en/articles/committers-guide/_index.adoc:2617 #, no-wrap msgid "" "The name and e-mail address of the person or people that contributed to the patch by providing meaningful feedback; for developers, just the username on the FreeBSD cluster.\n" @@ -5732,13 +5756,13 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2613 +#: documentation/content/en/articles/committers-guide/_index.adoc:2618 #, no-wrap msgid "`Approved by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2639 +#: documentation/content/en/articles/committers-guide/_index.adoc:2644 #, no-wrap msgid "" "The name and e-mail address of the person or people that approved the change; for developers, just the username on the FreeBSD cluster.\n" @@ -5767,25 +5791,25 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2640 +#: documentation/content/en/articles/committers-guide/_index.adoc:2645 #, no-wrap msgid "`Obtained from:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2642 +#: documentation/content/en/articles/committers-guide/_index.adoc:2647 #, no-wrap msgid "The name of the project (if any) from which the code was obtained. Do not use this line for the name of an individual person." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2643 +#: documentation/content/en/articles/committers-guide/_index.adoc:2648 #, no-wrap msgid "`Fixes:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2646 +#: documentation/content/en/articles/committers-guide/_index.adoc:2651 #, no-wrap msgid "" "The Git short hash and the title line of a commit that is fixed by this change as returned by `git log -n 1 --pretty=format:'%h (\"%s\")' GIT-COMMIT-HASH`.\n" @@ -5793,97 +5817,121 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2647 +#: documentation/content/en/articles/committers-guide/_index.adoc:2652 #, no-wrap msgid "`MFC after:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2649 +#: documentation/content/en/articles/committers-guide/_index.adoc:2654 #, no-wrap msgid "To receive an e-mail reminder to MFC at a later date, specify the number of days, weeks, or months after which an MFC is planned." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2650 +#: documentation/content/en/articles/committers-guide/_index.adoc:2655 #, no-wrap msgid "`MFC to:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2652 +#: documentation/content/en/articles/committers-guide/_index.adoc:2657 #, no-wrap msgid "If the commit should be merged to a subset of stable branches, specify the branch names." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2653 +#: documentation/content/en/articles/committers-guide/_index.adoc:2658 #, no-wrap msgid "`MFH:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2655 +#: documentation/content/en/articles/committers-guide/_index.adoc:2660 #, no-wrap msgid "If the commit is to be merged into a ports quarterly branch name, specify the quarterly branch. For example `2021Q2`." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2656 +#: documentation/content/en/articles/committers-guide/_index.adoc:2661 #, no-wrap msgid "`Relnotes:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2658 +#: documentation/content/en/articles/committers-guide/_index.adoc:2662 #, no-wrap msgid "If the change is a candidate for inclusion in the release notes for the next release from the branch, set to `yes`." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2659 +#: documentation/content/en/articles/committers-guide/_index.adoc:2663 +#, no-wrap +msgid "Candidates are user-visible changes, new features, compatibility breaks, etc.." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2664 +#, no-wrap +msgid "If you forget to set this line, or want to provide more details, add an entry to the `RELNOTES` file in the root of the src tree." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2665 +#, no-wrap +msgid "The `RELNOTES` file is used to generate release notes for the next release." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2667 +#, no-wrap +msgid "Do not use the `Relnotes:` line to describe the change: its only valid value is `yes`." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2668 #, no-wrap msgid "`Security:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2661 +#: documentation/content/en/articles/committers-guide/_index.adoc:2670 #, no-wrap msgid "If the change is related to a security vulnerability or security exposure, include one or more references or a description of the issue. If possible, include a VuXML URL or a CVE ID." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2662 +#: documentation/content/en/articles/committers-guide/_index.adoc:2671 #, no-wrap msgid "`Event:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2664 +#: documentation/content/en/articles/committers-guide/_index.adoc:2673 #, no-wrap msgid "The description for the event where this commit was made. If this is a recurring event, add the year or even the month to it. For example, this could be `FooBSDcon 2019`. The idea behind this line is to put recognition to conferences, gatherings, and other types of meetups and to show that these are useful to have. Please do not use the `Sponsored by:` line for this as that is meant for organizations sponsoring certain features or developers working on them." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2665 +#: documentation/content/en/articles/committers-guide/_index.adoc:2674 #, no-wrap msgid "`Sponsored by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2667 +#: documentation/content/en/articles/committers-guide/_index.adoc:2676 #, no-wrap msgid "Sponsoring organizations for this change, if any. Separate multiple organizations with commas. If only a portion of the work was sponsored, or different amounts of sponsorship were provided to different authors, please give appropriate credit in parentheses after each sponsor name. For example, `Example.com (alice, code refactoring), Wormulon (bob), Momcorp (cindy)` shows that Alice was sponsored by Example.com to do code refactoring, while Wormulon sponsored Bob's work and Momcorp sponsored Cindy's work. Other authors were either not sponsored or chose not to list sponsorship." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2668 +#: documentation/content/en/articles/committers-guide/_index.adoc:2677 #, no-wrap msgid "`Pull Request:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2672 +#: documentation/content/en/articles/committers-guide/_index.adoc:2681 #, no-wrap msgid "" "This change was submitted as a pull request or merge request against one of FreeBSD's public read-only Git repositories.\n" @@ -5892,13 +5940,13 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2673 +#: documentation/content/en/articles/committers-guide/_index.adoc:2682 #, no-wrap msgid "`Co-authored-by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2676 +#: documentation/content/en/articles/committers-guide/_index.adoc:2685 #, no-wrap msgid "" "The name and email address of an additional author of the commit.\n" @@ -5906,73 +5954,73 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2677 +#: documentation/content/en/articles/committers-guide/_index.adoc:2686 #, no-wrap msgid "`Signed-off-by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2679 +#: documentation/content/en/articles/committers-guide/_index.adoc:2688 #, no-wrap msgid "ID certifies compliance with https://developercertificate.org/" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2680 +#: documentation/content/en/articles/committers-guide/_index.adoc:2689 #, no-wrap msgid "`Differential Revision:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2682 +#: documentation/content/en/articles/committers-guide/_index.adoc:2691 #, no-wrap msgid "The full URL of the Phabricator review. This line __must be the last line__. For example: `https://reviews.freebsd.org/D1708`." msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2684 +#: documentation/content/en/articles/committers-guide/_index.adoc:2693 #, no-wrap msgid "Commit Log for a Commit Based on a PR" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2690 +#: documentation/content/en/articles/committers-guide/_index.adoc:2699 msgid "" "The commit is based on a patch from a PR submitted by John Smith. The " "commit message \"PR\" field is filled." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2694 -#: documentation/content/en/articles/committers-guide/_index.adoc:2712 -#: documentation/content/en/articles/committers-guide/_index.adoc:2727 -#: documentation/content/en/articles/committers-guide/_index.adoc:2743 -#: documentation/content/en/articles/committers-guide/_index.adoc:2758 +#: documentation/content/en/articles/committers-guide/_index.adoc:2703 +#: documentation/content/en/articles/committers-guide/_index.adoc:2721 +#: documentation/content/en/articles/committers-guide/_index.adoc:2736 +#: documentation/content/en/articles/committers-guide/_index.adoc:2752 +#: documentation/content/en/articles/committers-guide/_index.adoc:2767 #, no-wrap msgid "...\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2696 +#: documentation/content/en/articles/committers-guide/_index.adoc:2705 #, no-wrap msgid "PR:\t\t12345\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2699 +#: documentation/content/en/articles/committers-guide/_index.adoc:2708 msgid "" "The committer sets the author of the patch with `git commit --author \"John " "Smith <John.Smith@example.com>\"`." msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2702 +#: documentation/content/en/articles/committers-guide/_index.adoc:2711 #, no-wrap msgid "Commit Log for a Commit Needing Review" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2708 +#: documentation/content/en/articles/committers-guide/_index.adoc:2717 msgid "" "The virtual memory system is being changed. After posting patches to the " "appropriate mailing list (in this case, `freebsd-arch`) and the changes have " @@ -5980,73 +6028,73 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2714 +#: documentation/content/en/articles/committers-guide/_index.adoc:2723 #, no-wrap msgid "Reviewed by:\t-arch\n" msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2718 +#: documentation/content/en/articles/committers-guide/_index.adoc:2727 #, no-wrap msgid "Commit Log for a Commit Needing Approval" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2723 +#: documentation/content/en/articles/committers-guide/_index.adoc:2732 msgid "" "Commit a port, after working with the listed MAINTAINER, who said to go " "ahead and commit." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2729 +#: documentation/content/en/articles/committers-guide/_index.adoc:2738 #, no-wrap msgid "Approved by:\tabc (maintainer)\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2732 +#: documentation/content/en/articles/committers-guide/_index.adoc:2741 msgid "Where _abc_ is the account name of the person who approved." msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2734 +#: documentation/content/en/articles/committers-guide/_index.adoc:2743 #, no-wrap msgid "Commit Log for a Commit Bringing in Code from OpenBSD" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2739 +#: documentation/content/en/articles/committers-guide/_index.adoc:2748 msgid "Committing some code based on work done in the OpenBSD project." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2745 +#: documentation/content/en/articles/committers-guide/_index.adoc:2754 #, no-wrap msgid "Obtained from:\tOpenBSD\n" msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2749 +#: documentation/content/en/articles/committers-guide/_index.adoc:2758 #, no-wrap msgid "Commit Log for a Change to FreeBSD-CURRENT with a Planned Commit to FreeBSD-STABLE to Follow at a Later Date." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2754 +#: documentation/content/en/articles/committers-guide/_index.adoc:2763 msgid "" "Committing some code which will be merged from FreeBSD-CURRENT into the " "FreeBSD-STABLE branch after two weeks." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2760 +#: documentation/content/en/articles/committers-guide/_index.adoc:2769 #, no-wrap msgid "MFC after:\t2 weeks\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2763 +#: documentation/content/en/articles/committers-guide/_index.adoc:2772 msgid "" "Where _2_ is the number of days, weeks, or months after which an MFC is " "planned. The _weeks_ option may be `day`, `days`, `week`, `weeks`, `month`, " @@ -6054,12 +6102,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2766 +#: documentation/content/en/articles/committers-guide/_index.adoc:2775 msgid "It is often necessary to combine these." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2770 +#: documentation/content/en/articles/committers-guide/_index.adoc:2779 msgid "" "Consider the situation where a user has submitted a PR containing code from " "the NetBSD project. Looking at the PR, the developer sees it is not an area " @@ -6069,19 +6117,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2772 +#: documentation/content/en/articles/committers-guide/_index.adoc:2781 msgid "" "The extra information to include in the commit would look something like" msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2773 +#: documentation/content/en/articles/committers-guide/_index.adoc:2782 #, no-wrap msgid "Example Combined Commit Log" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2784 +#: documentation/content/en/articles/committers-guide/_index.adoc:2793 #, no-wrap msgid "" "PR:\t\t54321\n" @@ -6092,13 +6140,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2789 +#: documentation/content/en/articles/committers-guide/_index.adoc:2798 #, no-wrap msgid "Preferred License for New Files" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2795 +#: documentation/content/en/articles/committers-guide/_index.adoc:2804 msgid "" "The FreeBSD Project's full license policy can be found at link:https://" "www.FreeBSD.org/internal/software-license/[https://www.FreeBSD.org/internal/" @@ -6108,14 +6156,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2797 +#: documentation/content/en/articles/committers-guide/_index.adoc:2806 msgid "" "The FreeBSD Project suggests and uses this text as the preferred license " "scheme:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2828 +#: documentation/content/en/articles/committers-guide/_index.adoc:2837 #, no-wrap msgid "" "/*\n" @@ -6149,7 +6197,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2834 +#: documentation/content/en/articles/committers-guide/_index.adoc:2843 msgid "" "The FreeBSD project strongly discourages the so-called \"advertising " "clause\" in new code. Due to the large number of contributors to the " @@ -6160,7 +6208,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2838 +#: documentation/content/en/articles/committers-guide/_index.adoc:2847 msgid "" "The FreeBSD project discourages completely new licenses and variations on " "the standard licenses. New licenses require the approval of {core-email} to " @@ -6171,7 +6219,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2842 +#: documentation/content/en/articles/committers-guide/_index.adoc:2851 msgid "" "Project policy dictates that code under some non-BSD licenses must be placed " "only in specific sections of the repository, and in some cases, compilation " @@ -6182,7 +6230,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2845 +#: documentation/content/en/articles/committers-guide/_index.adoc:2854 msgid "" "Developers are reminded that in open source, getting \"open\" right is just " "as important as getting \"source\" right, as improper handling of " @@ -6191,13 +6239,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2847 +#: documentation/content/en/articles/committers-guide/_index.adoc:2856 #, no-wrap msgid "Keeping Track of Licenses Granted to the FreeBSD Project" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2852 +#: documentation/content/en/articles/committers-guide/_index.adoc:2861 msgid "" "Various software or data exist in the repositories where the FreeBSD project " "has been granted a special license to be able to use them. A case in point " @@ -6208,7 +6256,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2857 +#: documentation/content/en/articles/committers-guide/_index.adoc:2866 msgid "" "It is clearly sensible to keep a record of any such license grants. To that " "end, the {core-email} has decided to keep an archive of them. Whenever the " @@ -6218,13 +6266,13 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2859 +#: documentation/content/en/articles/committers-guide/_index.adoc:2868 msgid "" "Contact details for people or organizations granting the special license." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2860 +#: documentation/content/en/articles/committers-guide/_index.adoc:2869 msgid "" "What files, directories etc. in the repositories are covered by the license " "grant including the revision numbers where any specially licensed material " @@ -6232,7 +6280,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2861 +#: documentation/content/en/articles/committers-guide/_index.adoc:2870 msgid "" "The date the license comes into effect from. Unless otherwise agreed, this " "will be the date the license was issued by the authors of the software in " @@ -6240,24 +6288,24 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2862 +#: documentation/content/en/articles/committers-guide/_index.adoc:2871 msgid "The license text." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2863 +#: documentation/content/en/articles/committers-guide/_index.adoc:2872 msgid "" "A note of any restrictions, limitations or exceptions that apply " "specifically to FreeBSD's usage of the licensed material." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2864 +#: documentation/content/en/articles/committers-guide/_index.adoc:2873 msgid "Any other relevant information." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2867 +#: documentation/content/en/articles/committers-guide/_index.adoc:2876 msgid "" "Once the {core-email} is satisfied that all the necessary details have been " "gathered and are correct, the secretary will send a PGP-signed " @@ -6267,7 +6315,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2870 +#: documentation/content/en/articles/committers-guide/_index.adoc:2879 msgid "" "The license archive should contain only details of license grants; this is " "not the place for any discussions around licensing or other subjects. " @@ -6276,13 +6324,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2872 +#: documentation/content/en/articles/committers-guide/_index.adoc:2881 #, no-wrap msgid "SPDX Tags in the tree" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2883 +#: documentation/content/en/articles/committers-guide/_index.adoc:2892 msgid "" "The project uses https://spdx.dev[SPDX] tags in our source base. At " "present, these tags are indented to help automated tools reconstruct license " @@ -6301,20 +6349,20 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2885 +#: documentation/content/en/articles/committers-guide/_index.adoc:2894 msgid "" "As of March 2021, approximately 25,000 out of 90,000 files in the tree have " "been marked." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2886 +#: documentation/content/en/articles/committers-guide/_index.adoc:2895 #, no-wrap msgid "Developer Relations" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2892 +#: documentation/content/en/articles/committers-guide/_index.adoc:2901 msgid "" "When working directly on your own code or on code which is already well " "established as your responsibility, then there is probably little need to " @@ -6327,7 +6375,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2896 +#: documentation/content/en/articles/committers-guide/_index.adoc:2905 msgid "" "To determine if an area of the tree is maintained, check the MAINTAINERS " "file at the root of the tree. If nobody is listed, scan the revision " @@ -6338,27 +6386,27 @@ msgid "" msgstr "" #. type: delimited block - 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2900 +#: documentation/content/en/articles/committers-guide/_index.adoc:2909 #, no-wrap msgid "% git -C /path/to/repo shortlog -sne --since=\"2 years\" -- relative/path/to/file\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2903 +#: documentation/content/en/articles/committers-guide/_index.adoc:2912 msgid "" "If queries go unanswered or the committer otherwise indicates a lack of " "interest in the area affected, go ahead and commit it." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2908 +#: documentation/content/en/articles/committers-guide/_index.adoc:2917 msgid "" "Avoid sending private emails to maintainers. Other people might be " "interested in the conversation, not just the final output." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2914 +#: documentation/content/en/articles/committers-guide/_index.adoc:2923 msgid "" "If there is any doubt about a commit for any reason at all, have it reviewed " "before committing. Better to have it flamed then and there rather than when " @@ -6369,7 +6417,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2918 +#: documentation/content/en/articles/committers-guide/_index.adoc:2927 msgid "" "Do not impugn the intentions of others. If they see a different solution to " "a problem, or even a different problem, it is probably not because they are " @@ -6379,7 +6427,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2921 +#: documentation/content/en/articles/committers-guide/_index.adoc:2930 msgid "" "Disagree honestly. Argue your position from its merits, be honest about any " "shortcomings it may have, and be open to seeing their solution, or even " @@ -6387,7 +6435,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2927 +#: documentation/content/en/articles/committers-guide/_index.adoc:2936 msgid "" "Accept correction. We are all fallible. When you have made a mistake, " "apologize and get on with life. Do not beat up yourself, and certainly do " @@ -6396,7 +6444,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2931 +#: documentation/content/en/articles/committers-guide/_index.adoc:2940 msgid "" "Ask for help. Seek out (and give) peer reviews. One of the ways open " "source software is supposed to excel is in the number of eyeballs applied to " @@ -6404,20 +6452,20 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2933 +#: documentation/content/en/articles/committers-guide/_index.adoc:2942 #, no-wrap msgid "If in Doubt..." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2937 +#: documentation/content/en/articles/committers-guide/_index.adoc:2946 msgid "" "When unsure about something, whether it be a technical issue or a project " "convention be sure to ask. If you stay silent you will never make progress." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2941 +#: documentation/content/en/articles/committers-guide/_index.adoc:2950 msgid "" "If it relates to a technical issue ask on the public mailing lists. Avoid " "the temptation to email the individual person that knows the answer. This " @@ -6425,32 +6473,32 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2943 +#: documentation/content/en/articles/committers-guide/_index.adoc:2952 msgid "For project specific or administrative questions ask, in order:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2945 +#: documentation/content/en/articles/committers-guide/_index.adoc:2954 msgid "Your mentor or former mentor." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2946 +#: documentation/content/en/articles/committers-guide/_index.adoc:2955 msgid "An experienced committer on IRC, email, etc." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2947 +#: documentation/content/en/articles/committers-guide/_index.adoc:2956 msgid "Any team with a \"hat\", as they can give you a definitive answer." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2948 +#: documentation/content/en/articles/committers-guide/_index.adoc:2957 msgid "If still not sure, ask on {developers-name}." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2950 +#: documentation/content/en/articles/committers-guide/_index.adoc:2959 msgid "" "Once your question is answered, if no one pointed you to documentation that " "spelled out the answer to your question, document it, as others will have " @@ -6458,13 +6506,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2952 +#: documentation/content/en/articles/committers-guide/_index.adoc:2961 #, no-wrap msgid "Bugzilla" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2957 +#: documentation/content/en/articles/committers-guide/_index.adoc:2966 msgid "" "The FreeBSD Project utilizes Bugzilla for tracking bugs and change " "requests. If you commit a fix or suggestion found in the PR database, be " @@ -6473,26 +6521,26 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2959 +#: documentation/content/en/articles/committers-guide/_index.adoc:2968 msgid "" "Committers with non-``FreeBSD.org`` Bugzilla accounts can have the old " "account merged with the `FreeBSD.org` account by following these steps:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2963 +#: documentation/content/en/articles/committers-guide/_index.adoc:2972 msgid "Log in using your old account." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2964 +#: documentation/content/en/articles/committers-guide/_index.adoc:2973 msgid "" "Open new bug. Choose `Services` as the Product, and `Bug Tracker` as the " "Component. In bug description list accounts you wish to be merged." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2966 +#: documentation/content/en/articles/committers-guide/_index.adoc:2975 msgid "" "Log in using `FreeBSD.org` account and post comment to newly opened bug to " "confirm ownership. See crossref:committers-guide[kerberos-ldap, Kerberos and " @@ -6501,35 +6549,35 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2967 +#: documentation/content/en/articles/committers-guide/_index.adoc:2976 msgid "" "If there are more than two accounts to merge, post comments from each of " "them." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2970 +#: documentation/content/en/articles/committers-guide/_index.adoc:2979 msgid "You can find out more about Bugzilla at:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2972 +#: documentation/content/en/articles/committers-guide/_index.adoc:2981 msgid "extref:{pr-guidelines}[FreeBSD Problem Report Handling Guidelines]" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2973 +#: documentation/content/en/articles/committers-guide/_index.adoc:2982 msgid "link:https://www.FreeBSD.org/support/[https://www.FreeBSD.org/support]" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2975 +#: documentation/content/en/articles/committers-guide/_index.adoc:2984 #, no-wrap msgid "Phabricator" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2979 +#: documentation/content/en/articles/committers-guide/_index.adoc:2988 msgid "" "The FreeBSD Project utilizes https://reviews.freebsd.org[Phabricator] for " "code review requests. See the https://wiki.freebsd.org/" @@ -6537,7 +6585,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2982 +#: documentation/content/en/articles/committers-guide/_index.adoc:2991 msgid "" "Please use the `git arc` command provided by `devel/freebsd-git-devtools` " "(install the port or package, then type `git help arc` for documentation) to " @@ -6546,19 +6594,19 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2984 +#: documentation/content/en/articles/committers-guide/_index.adoc:2993 msgid "" "Committers with non-``FreeBSD.org`` Phabricator accounts can have the old " "account renamed to the ``FreeBSD.org`` account by following these steps:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2988 +#: documentation/content/en/articles/committers-guide/_index.adoc:2997 msgid "Change your Phabricator account email to your `FreeBSD.org` email." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2990 +#: documentation/content/en/articles/committers-guide/_index.adoc:2999 msgid "" "Open new bug on our bug tracker using your `FreeBSD.org` account, see " "crossref:committers-guide[bugzilla, Bugzilla] for more information. Choose " @@ -6569,19 +6617,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2995 +#: documentation/content/en/articles/committers-guide/_index.adoc:3004 msgid "" "Phabricator accounts cannot be merged, please do not open a new account." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2998 +#: documentation/content/en/articles/committers-guide/_index.adoc:3007 #, no-wrap msgid "Who's Who" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3001 +#: documentation/content/en/articles/committers-guide/_index.adoc:3010 msgid "" "Besides the repository meisters, there are other FreeBSD project members and " "teams whom you will probably get to know in your role as a committer. " @@ -6589,13 +6637,13 @@ msgid "" msgstr "" #. type: Labeled list -#: documentation/content/en/articles/committers-guide/_index.adoc:3002 +#: documentation/content/en/articles/committers-guide/_index.adoc:3011 #, no-wrap msgid "`{doceng}`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3008 +#: documentation/content/en/articles/committers-guide/_index.adoc:3017 msgid "" "doceng is the group responsible for the documentation build infrastructure, " "approving new documentation committers, and ensuring that the FreeBSD " @@ -6609,13 +6657,13 @@ msgid "" msgstr "" #. type: Labeled list -#: documentation/content/en/articles/committers-guide/_index.adoc:3009 +#: documentation/content/en/articles/committers-guide/_index.adoc:3018 #, no-wrap msgid "`{re-members}`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3014 +#: documentation/content/en/articles/committers-guide/_index.adoc:3023 msgid "" "These are the members of the `{re}`. This team is responsible for setting " "release deadlines and controlling the release process. During code freezes, " @@ -6626,20 +6674,20 @@ msgid "" msgstr "" #. type: Labeled list -#: documentation/content/en/articles/committers-guide/_index.adoc:3015 +#: documentation/content/en/articles/committers-guide/_index.adoc:3024 #, no-wrap msgid "`{so}`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3017 +#: documentation/content/en/articles/committers-guide/_index.adoc:3026 msgid "" "`{so-name}` is the link:https://www.FreeBSD.org/security/[FreeBSD Security " "Officer] and oversees the `{security-officer}`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3022 +#: documentation/content/en/articles/committers-guide/_index.adoc:3031 msgid "" "{committers-name}:: {dev-src-all}, {dev-ports-all} and {dev-doc-all} are the " "mailing lists that the version control system uses to send commit messages " @@ -6648,7 +6696,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3027 +#: documentation/content/en/articles/committers-guide/_index.adoc:3036 msgid "" "{developers-name}:: All committers are subscribed to -developers. This list " "was created to be a forum for the committers \"community\" issues. Examples " @@ -6656,7 +6704,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3031 +#: documentation/content/en/articles/committers-guide/_index.adoc:3040 msgid "" "The {developers-name} is for the exclusive use of FreeBSD committers. To " "develop FreeBSD, committers must have the ability to openly discuss matters " @@ -6666,7 +6714,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3035 +#: documentation/content/en/articles/committers-guide/_index.adoc:3044 msgid "" "All FreeBSD committers are expected not to not publish or forward messages " "from the {developers-name} outside the list membership without permission of " @@ -6676,7 +6724,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3041 +#: documentation/content/en/articles/committers-guide/_index.adoc:3050 msgid "" "This list is _not_ intended as a place for code reviews or for any technical " "discussion. In fact using it as such hurts the FreeBSD Project as it gives " @@ -6689,13 +6737,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3042 +#: documentation/content/en/articles/committers-guide/_index.adoc:3051 #, no-wrap msgid "SSH Quick-Start Guide" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3047 +#: documentation/content/en/articles/committers-guide/_index.adoc:3056 msgid "" "If you do not wish to type your password in every time you use man:ssh[1], " "and you use keys to authenticate, man:ssh-agent[1] is there for your " @@ -6706,19 +6754,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3048 +#: documentation/content/en/articles/committers-guide/_index.adoc:3057 msgid "" "Generate a key pair using man:ssh-keygen[1]. The key pair will wind up in " "your [.filename]#$HOME/.ssh/# directory." msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3052 +#: documentation/content/en/articles/committers-guide/_index.adoc:3061 msgid "Only ECDSA, Ed25519 or RSA keys are supported." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3054 +#: documentation/content/en/articles/committers-guide/_index.adoc:3063 msgid "" "Send your public key ([.filename]#$HOME/.ssh/id_ecdsa.pub#, " "[.filename]#$HOME/.ssh/id_ed25519.pub#, or [.filename]#$HOME/.ssh/" @@ -6727,7 +6775,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3059 +#: documentation/content/en/articles/committers-guide/_index.adoc:3068 msgid "" "Now man:ssh-add[1] can be used for authentication once per session. It " "prompts for the private key's pass phrase, and then stores it in the " @@ -6736,32 +6784,32 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3061 +#: documentation/content/en/articles/committers-guide/_index.adoc:3070 msgid "Test with a simple remote command: `ssh freefall.FreeBSD.org ls /usr`." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3063 +#: documentation/content/en/articles/committers-guide/_index.adoc:3072 msgid "" "For more information, see package:security/openssh-portable[], man:ssh[1], " "man:ssh-add[1], man:ssh-agent[1], man:ssh-keygen[1], and man:scp[1]." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3065 +#: documentation/content/en/articles/committers-guide/_index.adoc:3074 msgid "" "For information on adding, changing, or removing man:ssh[1] keys, see " "https://wiki.freebsd.org/clusteradm/ssh-keys[this article]." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3067 +#: documentation/content/en/articles/committers-guide/_index.adoc:3076 #, no-wrap msgid "Coverity(R) Availability for FreeBSD Committers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3071 +#: documentation/content/en/articles/committers-guide/_index.adoc:3080 msgid "" "All FreeBSD developers can obtain access to Coverity analysis results of all " "FreeBSD Project software. All who are interested in obtaining access to the " @@ -6770,7 +6818,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3074 +#: documentation/content/en/articles/committers-guide/_index.adoc:3083 msgid "" "The FreeBSD wiki includes a mini-guide for developers who are interested in " "working with the Coverity(R) analysis reports: https://wiki.freebsd.org/" @@ -6781,7 +6829,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3076 +#: documentation/content/en/articles/committers-guide/_index.adoc:3085 msgid "" "Finally, all FreeBSD developers who are going to use Coverity(R) are always " "encouraged to ask for more details and usage information, by posting any " @@ -6789,13 +6837,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3078 +#: documentation/content/en/articles/committers-guide/_index.adoc:3087 #, no-wrap msgid "The FreeBSD Committers' Big List of Rules" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3083 +#: documentation/content/en/articles/committers-guide/_index.adoc:3092 msgid "" "Everyone involved with the FreeBSD project is expected to abide by the _Code " "of Conduct_ available from link:https://www.FreeBSD.org/internal/code-of-" @@ -6806,25 +6854,25 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3085 -#: documentation/content/en/articles/committers-guide/_index.adoc:3115 +#: documentation/content/en/articles/committers-guide/_index.adoc:3094 +#: documentation/content/en/articles/committers-guide/_index.adoc:3124 msgid "Respect other committers." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3086 -#: documentation/content/en/articles/committers-guide/_index.adoc:3131 +#: documentation/content/en/articles/committers-guide/_index.adoc:3095 +#: documentation/content/en/articles/committers-guide/_index.adoc:3140 msgid "Respect other contributors." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3087 -#: documentation/content/en/articles/committers-guide/_index.adoc:3146 +#: documentation/content/en/articles/committers-guide/_index.adoc:3096 +#: documentation/content/en/articles/committers-guide/_index.adoc:3155 msgid "Discuss any significant change _before_ committing." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3088 +#: documentation/content/en/articles/committers-guide/_index.adoc:3097 msgid "" "Respect existing maintainers (if listed in the `MAINTAINER` field in " "[.filename]#Makefile# or in [.filename]#MAINTAINER# in the top-level " @@ -6832,8 +6880,8 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3089 -#: documentation/content/en/articles/committers-guide/_index.adoc:3161 +#: documentation/content/en/articles/committers-guide/_index.adoc:3098 +#: documentation/content/en/articles/committers-guide/_index.adoc:3170 msgid "" "Any disputed change must be backed out pending resolution of the dispute if " "requested by a maintainer. Security related changes may override a " @@ -6841,7 +6889,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3090 +#: documentation/content/en/articles/committers-guide/_index.adoc:3099 msgid "" "Changes go to FreeBSD-CURRENT before FreeBSD-STABLE unless specifically " "permitted by the release engineer or unless they are not applicable to " @@ -6853,40 +6901,40 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3091 -#: documentation/content/en/articles/committers-guide/_index.adoc:3176 +#: documentation/content/en/articles/committers-guide/_index.adoc:3100 +#: documentation/content/en/articles/committers-guide/_index.adoc:3185 msgid "Do not fight in public with other committers; it looks bad." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3092 +#: documentation/content/en/articles/committers-guide/_index.adoc:3101 msgid "" "Respect all code freezes and read the `committers` and `developers` mailing " "lists in a timely manner so you know when a code freeze is in effect." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3093 -#: documentation/content/en/articles/committers-guide/_index.adoc:3191 +#: documentation/content/en/articles/committers-guide/_index.adoc:3102 +#: documentation/content/en/articles/committers-guide/_index.adoc:3200 msgid "When in doubt on any procedure, ask first!" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3094 -#: documentation/content/en/articles/committers-guide/_index.adoc:3196 +#: documentation/content/en/articles/committers-guide/_index.adoc:3103 +#: documentation/content/en/articles/committers-guide/_index.adoc:3205 msgid "Test your changes before committing them." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3095 -#: documentation/content/en/articles/committers-guide/_index.adoc:3206 +#: documentation/content/en/articles/committers-guide/_index.adoc:3104 +#: documentation/content/en/articles/committers-guide/_index.adoc:3215 msgid "" "Do not commit to contributed software without _explicit_ approval from the " "respective maintainers." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3106 +#: documentation/content/en/articles/committers-guide/_index.adoc:3115 msgid "" "As noted, breaking some of these rules can be grounds for suspension or, " "upon repeated offense, permanent removal of commit privileges. Individual " @@ -6912,7 +6960,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3110 +#: documentation/content/en/articles/committers-guide/_index.adoc:3119 msgid "" "In all other aspects of project operation, core is a subset of committers " "and is bound by the __same rules__. Just because someone is in core this " @@ -6923,13 +6971,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3111 +#: documentation/content/en/articles/committers-guide/_index.adoc:3120 #, no-wrap msgid "Details" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3119 +#: documentation/content/en/articles/committers-guide/_index.adoc:3128 msgid "" "This means that you need to treat other committers as the peer-group " "developers that they are. Despite our occasional attempts to prove the " @@ -6941,7 +6989,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3121 +#: documentation/content/en/articles/committers-guide/_index.adoc:3130 msgid "" "Being able to work together long term is this project's greatest asset, one " "far more important than any set of changes to the code, and turning " @@ -6951,7 +6999,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3127 +#: documentation/content/en/articles/committers-guide/_index.adoc:3136 msgid "" "To comply with this rule, do not send email when you are angry or otherwise " "behave in a manner which is likely to strike others as needlessly " @@ -6970,7 +7018,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3130 +#: documentation/content/en/articles/committers-guide/_index.adoc:3139 msgid "" "All of this is never an option which the project's leadership enjoys in the " "slightest, but unity comes first. No amount of code or good advice is worth " @@ -6978,7 +7026,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3143 +#: documentation/content/en/articles/committers-guide/_index.adoc:3152 msgid "" "You were not always a committer. At one time you were a contributor. " "Remember that at all times. Remember what it was like trying to get help " @@ -6992,14 +7040,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3145 +#: documentation/content/en/articles/committers-guide/_index.adoc:3154 msgid "" "Consider the points raised under crossref:committers-guide[respect,Respect " "other committers] and apply them also to contributors." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3152 +#: documentation/content/en/articles/committers-guide/_index.adoc:3161 msgid "" "The repository is not where changes are initially submitted for correctness " "or argued over, that happens first in the mailing lists or by use of the " @@ -7015,25 +7063,25 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3154 +#: documentation/content/en/articles/committers-guide/_index.adoc:3163 msgid "When in doubt, ask for review!" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3155 +#: documentation/content/en/articles/committers-guide/_index.adoc:3164 msgid "Respect existing maintainers if listed." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3160 +#: documentation/content/en/articles/committers-guide/_index.adoc:3169 msgid "" "Many parts of FreeBSD are not \"owned\" in the sense that any specific " "individual will jump up and yell if you commit a change to \"their\" area, " "but it still pays to check first. One convention we use is to put a " "maintainer line in the [.filename]#Makefile# for any package or subtree " "which is being actively maintained by one or more people; see extref:" -"{developers-handbook}[Source Tree Guidelines and Policies, policies] for " -"documentation on this. Where sections of code have several maintainers, " +"{developers-handbook}policies[Source Tree Guidelines and Policies, policies] " +"for documentation on this. Where sections of code have several maintainers, " "commits to affected areas by one maintainer need to be reviewed by at least " "one other maintainer. In cases where the \"maintainer-ship\" of something " "is not clear, look at the repository logs for the files in question and see " @@ -7041,7 +7089,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3166 +#: documentation/content/en/articles/committers-guide/_index.adoc:3175 msgid "" "This may be hard to swallow in times of conflict (when each side is " "convinced that they are in the right, of course) but a version control " @@ -7059,7 +7107,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3167 +#: documentation/content/en/articles/committers-guide/_index.adoc:3176 msgid "" "Changes go to FreeBSD-CURRENT before FreeBSD-STABLE unless specifically " "permitted by the release engineer or unless they are not applicable to " @@ -7070,7 +7118,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3173 +#: documentation/content/en/articles/committers-guide/_index.adoc:3182 msgid "" "This is another \"do not argue about it\" issue since it is the release " "engineer who is ultimately responsible (and gets beaten up) if a change " @@ -7089,7 +7137,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3175 +#: documentation/content/en/articles/committers-guide/_index.adoc:3184 msgid "" "Changes to the security branches (for example, `releng/9.3`) must be " "approved by a member of the `{security-officer}`, or in some cases, by a " @@ -7097,7 +7145,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3186 +#: documentation/content/en/articles/committers-guide/_index.adoc:3195 msgid "" "This project has a public image to uphold and that image is very important " "to all of us, especially if we are to continue to attract new members. " @@ -7122,14 +7170,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3187 +#: documentation/content/en/articles/committers-guide/_index.adoc:3196 msgid "" "Respect all code freezes and read the `committers` and `developers` mailing " "list on a timely basis so you know when a code freeze is in effect." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3190 +#: documentation/content/en/articles/committers-guide/_index.adoc:3199 msgid "" "Committing unapproved changes during a code freeze is a really big mistake " "and committers are expected to keep up-to-date on what is going on before " @@ -7140,7 +7188,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3195 +#: documentation/content/en/articles/committers-guide/_index.adoc:3204 msgid "" "Many mistakes are made because someone is in a hurry and just assumes they " "know the right way of doing something. If you have not done it before, " @@ -7152,7 +7200,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3205 +#: documentation/content/en/articles/committers-guide/_index.adoc:3214 msgid "" "If your changes are to the kernel, make sure you can still compile both " "GENERIC and LINT. If your changes are anywhere else, make sure you can " @@ -7168,14 +7216,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3208 +#: documentation/content/en/articles/committers-guide/_index.adoc:3217 msgid "" "Contributed software is anything under the [.filename]#src/contrib#, " "[.filename]#src/crypto#, or [.filename]#src/sys/contrib# trees." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3213 +#: documentation/content/en/articles/committers-guide/_index.adoc:3222 msgid "" "The trees mentioned above are for contributed software usually imported onto " "a vendor branch. Committing something there may cause unnecessary headaches " @@ -7185,7 +7233,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3217 +#: documentation/content/en/articles/committers-guide/_index.adoc:3226 msgid "" "Reasons for modifying upstream software range from wanting strict control " "over a tightly coupled dependency to lack of portability in the canonical " @@ -7197,7 +7245,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3220 +#: documentation/content/en/articles/committers-guide/_index.adoc:3229 msgid "" "If a particular piece of software lacks a maintainer, you are encouraged to " "take up ownership. If you are unsure of the current maintainership email " @@ -7205,27 +7253,27 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3221 +#: documentation/content/en/articles/committers-guide/_index.adoc:3230 #, no-wrap msgid "Policy on Multiple Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3224 +#: documentation/content/en/articles/committers-guide/_index.adoc:3233 msgid "" "In an effort to make it easier to keep FreeBSD portable across the platforms " "we support, core has developed this mandate:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3227 +#: documentation/content/en/articles/committers-guide/_index.adoc:3236 msgid "" "Major design work (including major API and ABI changes) must prove itself on " "at least one Tier 1 platform before it may be committed to the source tree." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3231 +#: documentation/content/en/articles/committers-guide/_index.adoc:3240 msgid "" "Developers should also be aware of our Tier Policy for the long term support " "of hardware architectures. The rules here are intended to provide guidance " @@ -7236,13 +7284,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3233 +#: documentation/content/en/articles/committers-guide/_index.adoc:3242 #, no-wrap msgid "Policy on Multiple Compilers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3247 +#: documentation/content/en/articles/committers-guide/_index.adoc:3256 msgid "" "The FreeBSD base system builds with both Clang and GCC. The project does " "this in a careful and controlled way to maximize benefits from this extra " @@ -7269,7 +7317,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3252 +#: documentation/content/en/articles/committers-guide/_index.adoc:3261 msgid "" "The FreeBSD base system includes an in-tree Clang compiler. Due to being in " "the tree, this compiler is the most supported compiler. All changes must " @@ -7278,7 +7326,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3267 +#: documentation/content/en/articles/committers-guide/_index.adoc:3276 msgid "" "The FreeBSD base system also supports various versions of Clang and GCC as " "out-of-tree compilers. For large or risky changes, committers should do a " @@ -7299,7 +7347,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3271 +#: documentation/content/en/articles/committers-guide/_index.adoc:3280 msgid "" "The FreeBSD project also has some CI pipelines on github. For pull requests " "on github and some branches pushed to github forks, a number of cross " @@ -7308,7 +7356,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3277 +#: documentation/content/en/articles/committers-guide/_index.adoc:3286 msgid "" "The FreeBSD project is also upgrading compilers. Both Clang and GCC are " "fast moving targets. Some work to change things in the tree, for example " @@ -7321,7 +7369,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3281 +#: documentation/content/en/articles/committers-guide/_index.adoc:3290 msgid "" "In addition to the compiler, LLVM's LLD and GNU's binutils are used " "indirectly by the compiler. Committers should be mindful of variations in " @@ -7331,7 +7379,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3287 +#: documentation/content/en/articles/committers-guide/_index.adoc:3296 msgid "" "The FreeBSD project provides headers and libraries that allow other " "compilers to be used to build software not in the base system. These " @@ -7346,7 +7394,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3292 +#: documentation/content/en/articles/committers-guide/_index.adoc:3301 msgid "" "The FreeBSD build system currently accommodates these different " "environments. As new warnings are added to compilers, the project tries to " @@ -7358,13 +7406,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3293 +#: documentation/content/en/articles/committers-guide/_index.adoc:3302 #, no-wrap msgid "Current Compiler Versions" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3296 +#: documentation/content/en/articles/committers-guide/_index.adoc:3305 msgid "" "The versions of supported compilers for a given branch such as `main` or " "`stable/X` varies over time. The authoritative source for supported " @@ -7372,30 +7420,139 @@ msgid "" "actions and Jenkins." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3300 +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3309 +#, no-wrap +msgid "Branch" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3310 +#, no-wrap +msgid "In-tree Compiler" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3310 +#, no-wrap +msgid "llvm12" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3310 +#, no-wrap +msgid "llvm13" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3310 +#, no-wrap +msgid "llvm14" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3310 +#, no-wrap +msgid "llvm15" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3311 +#, no-wrap +msgid "llvm18" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3311 +#, no-wrap +msgid "amd64-gcc12" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3311 +#, no-wrap +msgid "amd64-gcc13" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3313 +#, no-wrap +msgid "amd64-gcc14" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3313 +#, no-wrap +msgid "main" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3314 +#: documentation/content/en/articles/committers-guide/_index.adoc:3318 +#: documentation/content/en/articles/committers-guide/_index.adoc:3322 +#: documentation/content/en/articles/committers-guide/_index.adoc:3326 +#, no-wrap +msgid "llvm 19" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3314 +#: documentation/content/en/articles/committers-guide/_index.adoc:3315 +#: documentation/content/en/articles/committers-guide/_index.adoc:3317 +#: documentation/content/en/articles/committers-guide/_index.adoc:3318 +#: documentation/content/en/articles/committers-guide/_index.adoc:3319 +#: documentation/content/en/articles/committers-guide/_index.adoc:3321 +#: documentation/content/en/articles/committers-guide/_index.adoc:3322 +#: documentation/content/en/articles/committers-guide/_index.adoc:3323 +#: documentation/content/en/articles/committers-guide/_index.adoc:3325 +#: documentation/content/en/articles/committers-guide/_index.adoc:3326 +#: documentation/content/en/articles/committers-guide/_index.adoc:3327 +#: documentation/content/en/articles/committers-guide/_index.adoc:3328 +#, no-wrap +msgid "Y" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3317 +#, no-wrap +msgid "stable/15" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3321 +#, no-wrap +msgid "stable/14" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3325 +#, no-wrap +msgid "stable/13" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3332 msgid "" -"For `main`, the in-tree compiler is currently Clang 19. Currently, GCC 12, " -"13, and 14 are tested for amd64 via CI jobs in Jenkins. Clang 14 and 18 are " -"tested for aarch64 and arm64 in GitHub's cross-build actions." +"GCC toolchains are tested for amd64 via CI jobs in Jenkins. LLVM toolchains " +"are tested for aarch64 and arm64 in GitHub's cross-build actions." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3301 +#: documentation/content/en/articles/committers-guide/_index.adoc:3333 #, no-wrap msgid "Other Suggestions" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3305 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3337 msgid "" "When committing documentation changes, use a spell checker before " "committing. For all XML docs, verify that the formatting directives are " "correct by running `make lint` and package:textproc/igor[]." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3307 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3339 msgid "" "For manual pages, run package:sysutils/manck[] and package:textproc/igor[] " "over the manual page to verify all of the cross references and file " @@ -7403,8 +7560,8 @@ msgid "" "`MLINKS` installed." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3314 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3346 msgid "" "Do not mix style fixes with new functionality. A style fix is any change " "which does not modify the functionality of the code. Mixing the changes " @@ -7417,35 +7574,35 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3315 +#: documentation/content/en/articles/committers-guide/_index.adoc:3347 #, no-wrap msgid "Deprecating Features" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3318 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3350 msgid "" "When it is necessary to remove functionality from software in the base " "system, follow these guidelines whenever possible:" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3320 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3352 msgid "" "Mention is made in the manual page and possibly the release notes that the " "option, utility, or interface is deprecated. Use of the deprecated feature " "generates a warning." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3321 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3353 msgid "" "The option, utility, or interface is preserved until the next major (point " "zero) release." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3322 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3354 msgid "" "The option, utility, or interface is removed and no longer documented. It is " "now obsolete. It is also generally a good idea to note its removal in the " @@ -7453,31 +7610,31 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3323 +#: documentation/content/en/articles/committers-guide/_index.adoc:3355 #, no-wrap msgid "Privacy and Confidentiality" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3326 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3358 msgid "Most FreeBSD business is done in public." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3329 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3361 msgid "" "FreeBSD is an _open_ project. Which means that not only can anyone use the " "source code, but that most of the development process is open to public " "scrutiny." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3330 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3362 msgid "Certain sensitive matters must remain private or held under embargo." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3336 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3368 msgid "" "There unfortunately cannot be complete transparency. As a FreeBSD developer " "you will have a certain degree of privileged access to information. " @@ -7487,15 +7644,15 @@ msgid "" "of not releasing private communications." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3337 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3369 msgid "" "The Security Officer has sole control over the release of security " "advisories." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3342 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3374 msgid "" "Where there are security problems that affect many different operating " "systems, FreeBSD frequently depends on early access to be able to prepare " @@ -7507,14 +7664,14 @@ msgid "" "developer with relevant knowledge to prepare security fixes." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3343 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3375 msgid "" "Communications with Core are kept confidential for as long as necessary." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3348 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3380 msgid "" "Communications to core will initially be treated as confidential. " "Eventually however, most of Core's business will be summarized into the " @@ -7524,28 +7681,28 @@ msgid "" "archives." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3349 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3381 msgid "" "Non-disclosure Agreements may be required for access to certain commercially " "sensitive data." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3352 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3384 msgid "" "Access to certain commercially sensitive data may only be available under a " "Non-Disclosure Agreement. The FreeBSD Foundation legal staff must be " "consulted before any binding agreements are entered into." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3353 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3385 msgid "Private communications must not be made public without permission." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3356 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3388 msgid "" "Beyond the specific requirements above there is a general expectation not to " "publish private communications between developers without the consent of all " @@ -7554,15 +7711,15 @@ msgid "" "other than the original correspondents." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3357 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3389 msgid "" "Communications on project-only or restricted access channels must be kept " "private." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3360 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3392 msgid "" "Similarly to personal communications, certain internal communications " "channels, including FreeBSD Committer only mailing lists and restricted " @@ -7570,13 +7727,13 @@ msgid "" "required to publish material from these sources." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3361 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3393 msgid "Core may approve publication." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3363 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3395 msgid "" "Where it is impractical to obtain permission due to the number of " "correspondents or where permission to publish is unreasonably withheld, Core " @@ -7585,13 +7742,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3365 +#: documentation/content/en/articles/committers-guide/_index.adoc:3397 #, no-wrap msgid "Support for Multiple Architectures" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3372 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3404 msgid "" "FreeBSD is a highly portable operating system intended to function on many " "different types of hardware architectures. Maintaining clean separation of " @@ -7607,13 +7764,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3373 +#: documentation/content/en/articles/committers-guide/_index.adoc:3405 #, no-wrap msgid "Statement of General Intent" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3378 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3410 msgid "" "The FreeBSD Project targets \"production quality commercial off-the-shelf " "(COTS) workstation, server, and high-end embedded systems\". By retaining a " @@ -7628,8 +7785,8 @@ msgid "" "support." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3385 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3417 msgid "" "The FreeBSD Project differentiates platform targets into four tiers. Each " "tier includes a list of guarantees consumers may rely on as well as " @@ -7643,13 +7800,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3386 +#: documentation/content/en/articles/committers-guide/_index.adoc:3418 #, no-wrap msgid "Platform Targets" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3393 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3425 msgid "" "Support for a hardware platform consists of two components: kernel support " "and userland Application Binary Interfaces (ABIs). Kernel platform support " @@ -7663,8 +7820,8 @@ msgid "" "objects or calling conventions for C functions." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3395 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3427 msgid "" "A FreeBSD kernel also uses an ABI (sometimes referred to as the Kernel " "Binary Interface (KBI)) which includes the semantics and layouts of public " @@ -7672,8 +7829,8 @@ msgid "" "functions within the kernel itself." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3400 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3432 msgid "" "A FreeBSD kernel may support multiple userland ABIs. For example, FreeBSD's " "amd64 kernel supports FreeBSD amd64 and i386 userland ABIs as well as Linux " @@ -7683,21 +7840,21 @@ msgid "" "basic types, etc." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3402 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3434 msgid "" "Tiers are defined for both kernels and userland ABIs. In the common case, a " "platform's kernel and FreeBSD ABIs are assigned to the same tier." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3403 +#: documentation/content/en/articles/committers-guide/_index.adoc:3435 #, no-wrap msgid "Tier 1: Fully-Supported Architectures" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3408 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3440 msgid "" "Tier 1 platforms are the most mature FreeBSD platforms. They are supported " "by the security officer, release engineering, and Ports Management Team. " @@ -7706,43 +7863,43 @@ msgid "" "development environments." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3410 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3442 msgid "" "The FreeBSD Project provides the following guarantees to consumers of Tier 1 " "platforms:" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3412 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3444 msgid "" "Official FreeBSD release images will be provided by the release engineering " "team." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3413 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3445 msgid "" "Binary updates and source patches for Security Advisories and Errata Notices " "will be provided for supported releases." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3414 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3446 msgid "" "Source patches for Security Advisories will be provided for supported " "branches." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3415 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3447 msgid "" "Binary updates and source patches for cross-platform Security Advisories " "will typically be provided at the time of the announcement." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3416 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3448 msgid "" "Changes to userland ABIs will generally include compatibility shims to " "ensure correct operation of binaries compiled against any stable branch " @@ -7751,8 +7908,8 @@ msgid "" "the lack of shims will be clearly documented in the release notes." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3417 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3449 msgid "" "Changes to certain portions of the kernel ABI will include compatibility " "shims to ensure correct operation of kernel modules compiled against the " @@ -7760,65 +7917,65 @@ msgid "" "kernel ABI are protected." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3418 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3450 msgid "" "Official binary packages for third party software will be provided by the " "ports team. For embedded architectures, these packages may be cross-built " "from a different architecture." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3419 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3451 msgid "" "Most relevant ports should either build or have the appropriate filters to " "prevent inappropriate ones from building." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3420 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3452 msgid "" "New features which are not inherently platform-specific will be fully " "functional on all Tier 1 architectures." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3421 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3453 msgid "" "Features and compatibility shims used by binaries compiled against older " "stable branches may be removed in newer major versions. Such removals will " "be clearly documented in the release notes." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3422 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3454 msgid "" "Tier 1 platforms should be fully documented. Basic operations will be " "documented in the FreeBSD Handbook." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3423 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3455 msgid "Tier 1 platforms will be included in the source tree." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3424 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3456 msgid "" "Tier 1 platforms should be self-hosting either via the in-tree toolchain or " "an external toolchain. If an external toolchain is required, official binary " "packages for an external toolchain will be provided." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3426 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3458 msgid "" "To maintain maturity of Tier 1 platforms, the FreeBSD Project will maintain " "the following resources to support development:" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3428 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3460 msgid "" "Build and test automation support either in the FreeBSD.org cluster or some " "other location easily available for all developers. Embedded platforms may " @@ -7826,42 +7983,42 @@ msgid "" "hardware." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3429 -#: documentation/content/en/articles/committers-guide/_index.adoc:3459 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3461 +#: documentation/content/en/articles/committers-guide/_index.adoc:3491 msgid "Inclusion in the `make universe` and `make tinderbox` targets." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3430 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3462 msgid "" "Dedicated hardware in one of the FreeBSD clusters for package building " "(either natively or via qemu-user)." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3432 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3464 msgid "" "Collectively, developers are required to provide the following to maintain " "the Tier 1 status of a platform:" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3434 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3466 msgid "" "Changes to the source tree should not knowingly break the build of a Tier 1 " "platform." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3435 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3467 msgid "" "Tier 1 architectures must have a mature, healthy ecosystem of users and " "active developers." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3436 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3468 msgid "" "Developers should be able to build packages on commonly available, non-" "embedded Tier 1 systems. This can mean either native builds if non-embedded " @@ -7869,16 +8026,16 @@ msgid "" "cross-builds hosted on some other Tier 1 architecture." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3437 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3469 msgid "" "Changes cannot break the userland ABI. If an ABI change is required, ABI " "compatibility for existing binaries should be provided via use of symbol " "versioning or shared library version bumps." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3438 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3470 msgid "" "Changes merged to stable branches cannot break the protected portions of the " "kernel ABI. If a kernel ABI change is required, the change should be " @@ -7886,21 +8043,21 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3439 +#: documentation/content/en/articles/committers-guide/_index.adoc:3471 #, no-wrap msgid "Tier 2: Developmental and Niche Architectures" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3443 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3475 msgid "" "Tier 2 platforms are functional, but less mature FreeBSD platforms. They " "are not supported by the security officer, release engineering, and Ports " "Management Team." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3447 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3479 msgid "" "Tier 2 platforms may be Tier 1 platform candidates that are still under " "active development. Architectures reaching end of life may also be moved " @@ -7909,15 +8066,15 @@ msgid "" "Well-supported niche architectures may also be Tier 2." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3449 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3481 msgid "" "The FreeBSD Project provides the following guarantees to consumers of Tier 2 " "platforms:" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3451 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3483 msgid "" "The ports infrastructure should include basic support for Tier 2 " "architectures sufficient to support building ports and packages. This " @@ -7925,91 +8082,91 @@ msgid "" "guarantee that arbitrary ports will be buildable or functional." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3452 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3484 msgid "" "New features which are not inherently platform-specific should be feasible " "on all Tier 2 architectures if not implemented." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3453 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3485 msgid "Tier 2 platforms will be included in the source tree." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3454 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3486 msgid "" "Tier 2 platforms should be self-hosting either via the in-tree toolchain or " "an external toolchain. If an external toolchain is required, official binary " "packages for an external toolchain will be provided." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3455 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3487 msgid "" "Tier 2 platforms should provide functional kernels and userlands even if an " "official release distribution is not provided." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3457 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3489 msgid "" "To maintain maturity of Tier 2 platforms, the FreeBSD Project will maintain " "the following resources to support development:" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3461 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3493 msgid "" "Collectively, developers are required to provide the following to maintain " "the Tier 2 status of a platform:" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3463 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3495 msgid "" "Changes to the source tree should not knowingly break the build of a Tier 2 " "platform." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3464 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3496 msgid "" "Tier 2 architectures must have an active ecosystem of users and developers." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3465 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3497 msgid "" "While changes are permitted to break the userland ABI, the ABI should not be " "broken gratuitously. Significant userland ABI changes should be restricted " "to major versions." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3466 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3498 msgid "" "New features that are not yet implemented on Tier 2 architectures should " "provide a means of disabling them on those architectures." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3467 +#: documentation/content/en/articles/committers-guide/_index.adoc:3499 #, no-wrap msgid "Tier 3: Experimental Architectures" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3471 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3503 msgid "" "Tier 3 platforms have at least partial FreeBSD support. They are _not_ " "supported by the security officer, release engineering, and Ports Management " "Team." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3474 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3506 msgid "" "Tier 3 platforms are architectures in the early stages of development, for " "non-mainstream hardware platforms, or which are considered legacy systems " @@ -8017,8 +8174,8 @@ msgid "" "exist in a separate repository rather than the main source repository." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3477 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3509 msgid "" "The FreeBSD Project provides no guarantees to consumers of Tier 3 platforms " "and is not committed to maintaining resources to support development. Tier " @@ -8027,20 +8184,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3478 +#: documentation/content/en/articles/committers-guide/_index.adoc:3510 #, no-wrap msgid "Unsupported Architectures" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3482 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3514 msgid "" "Other platforms are not supported in any form by the project. The project " "previously described these as Tier 4 systems." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3485 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3517 msgid "" "After a platform transitions to unsupported, all support for the platform is " "removed from the source, ports and documentation trees. Note that ports " @@ -8049,13 +8206,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3486 +#: documentation/content/en/articles/committers-guide/_index.adoc:3518 #, no-wrap msgid "Policy on Changing the Tier of an Architecture" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3490 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3522 msgid "" "Systems may only be moved from one tier to another by approval of the " "FreeBSD Core Team, which shall make that decision in collaboration with the " @@ -8065,25 +8222,25 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3492 +#: documentation/content/en/articles/committers-guide/_index.adoc:3524 #, no-wrap msgid "Ports Specific FAQ" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3495 +#: documentation/content/en/articles/committers-guide/_index.adoc:3527 #, no-wrap msgid "Adding a New Port" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3498 +#: documentation/content/en/articles/committers-guide/_index.adoc:3530 #, no-wrap msgid "How do I add a new port?" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3503 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3535 msgid "" "Adding a port to the tree is relatively simple. Once the port is ready to be " "added, as explained later crossref:committers-guide[ports-qa-add-new-" @@ -8093,20 +8250,20 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3507 +#: documentation/content/en/articles/committers-guide/_index.adoc:3539 #, no-wrap msgid "\tSUBDIR += newport\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3510 +#: documentation/content/en/articles/committers-guide/_index.adoc:3542 msgid "" "Once the port and its category's Makefile are ready, the new port can be " "committed:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3515 +#: documentation/content/en/articles/committers-guide/_index.adoc:3547 #, no-wrap msgid "" "% git add category/Makefile category/newport\n" @@ -8115,7 +8272,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3519 +#: documentation/content/en/articles/committers-guide/_index.adoc:3551 msgid "" "Don't forget to crossref:committers-guide[port-commit-message-formats,setup " "git hooks for the ports tree as explained here]; a specific hook has been " @@ -8123,19 +8280,19 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3522 +#: documentation/content/en/articles/committers-guide/_index.adoc:3554 #, no-wrap msgid "Any other things I need to know when I add a new port?" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3525 +#: documentation/content/en/articles/committers-guide/_index.adoc:3557 msgid "" "Check the port, preferably to make sure it compiles and packages correctly." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3528 +#: documentation/content/en/articles/committers-guide/_index.adoc:3560 msgid "" "The extref:{porters-handbook}testing[Porters Handbook's Testing Chapter] " "contains more detailed instructions. See the extref:{porters-handbook}" @@ -8144,14 +8301,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3530 +#: documentation/content/en/articles/committers-guide/_index.adoc:3562 msgid "" "You do not necessarily have to eliminate all warnings but make sure you have " "fixed the simple ones." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3532 +#: documentation/content/en/articles/committers-guide/_index.adoc:3564 msgid "" "If the port came from a submitter who has not contributed to the Project " "before, add that person's name to the extref:{contributors}[Additional " @@ -8159,14 +8316,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3535 +#: documentation/content/en/articles/committers-guide/_index.adoc:3567 msgid "" "Close the PR if the port came in as a PR. To close a PR, change the state " "to `Issue Resolved` and the resolution as `Fixed`." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3539 +#: documentation/content/en/articles/committers-guide/_index.adoc:3571 msgid "" "If for some reason using extref:{porters-handbook}testing[poudriere, testing-" "poudriere] to test the new port is not possible, the bare minimum of testing " @@ -8174,7 +8331,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3549 +#: documentation/content/en/articles/committers-guide/_index.adoc:3581 #, no-wrap msgid "" "# make install\n" @@ -8187,85 +8344,85 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3552 +#: documentation/content/en/articles/committers-guide/_index.adoc:3584 msgid "" "Note that poudriere is the reference for package building, it the port does " "not build in poudriere, it will be removed." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3555 +#: documentation/content/en/articles/committers-guide/_index.adoc:3587 #, no-wrap msgid "Removing an Existing Port" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3558 +#: documentation/content/en/articles/committers-guide/_index.adoc:3590 #, no-wrap msgid "How do I remove an existing port?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3561 +#: documentation/content/en/articles/committers-guide/_index.adoc:3593 msgid "" "First, please read the section about repository copies. Before you remove " "the port, you have to verify there are no other ports depending on it." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3563 +#: documentation/content/en/articles/committers-guide/_index.adoc:3595 msgid "Make sure there is no dependency on the port in the ports collection:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3564 +#: documentation/content/en/articles/committers-guide/_index.adoc:3596 msgid "The port's PKGNAME appears in exactly one line in a recent INDEX file." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3565 +#: documentation/content/en/articles/committers-guide/_index.adoc:3597 msgid "" "No other ports contains any reference to the port's directory or PKGNAME in " "their Makefiles" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3569 +#: documentation/content/en/articles/committers-guide/_index.adoc:3601 msgid "" "When using Git, consider using man:git-grep[1], it is much faster than `grep " "-r`." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3572 +#: documentation/content/en/articles/committers-guide/_index.adoc:3604 msgid "Then, remove the port:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3576 +#: documentation/content/en/articles/committers-guide/_index.adoc:3608 msgid "Remove the port's files and directory with `git rm`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3577 +#: documentation/content/en/articles/committers-guide/_index.adoc:3609 msgid "" "Remove the `SUBDIR` listing of the port in the parent directory " "[.filename]#Makefile#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3578 -#: documentation/content/en/articles/committers-guide/_index.adoc:3593 +#: documentation/content/en/articles/committers-guide/_index.adoc:3610 +#: documentation/content/en/articles/committers-guide/_index.adoc:3625 msgid "Add an entry to [.filename]#ports/MOVED#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3579 +#: documentation/content/en/articles/committers-guide/_index.adoc:3611 msgid "Remove the port from [.filename]#ports/LEGAL# if it is there." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3584 +#: documentation/content/en/articles/committers-guide/_index.adoc:3616 msgid "" "Alternatively, you can use the rmport script, from [.filename]#ports/Tools/" "scripts#. This script was written by {vd}. When sending questions about " @@ -8274,13 +8431,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3586 +#: documentation/content/en/articles/committers-guide/_index.adoc:3618 #, no-wrap msgid "How do I move a port to a new location?" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3591 +#: documentation/content/en/articles/committers-guide/_index.adoc:3623 msgid "" "Perform a thorough check of the ports collection for any dependencies on the " "old port location/name, and update them. Running `grep` on " @@ -8290,14 +8447,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3592 +#: documentation/content/en/articles/committers-guide/_index.adoc:3624 msgid "" "Remove the `SUBDIR` entry from the old category Makefile and add a `SUBDIR` " "entry to the new category Makefile." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3594 +#: documentation/content/en/articles/committers-guide/_index.adoc:3626 msgid "" "Search for entries in xml files inside [.filename]#ports/security/vuxml# and " "adjust them accordingly. In particular, check for previous packages with the " @@ -8305,51 +8462,51 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3595 +#: documentation/content/en/articles/committers-guide/_index.adoc:3627 msgid "Move the port with `git mv`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3596 -#: documentation/content/en/articles/committers-guide/_index.adoc:3607 +#: documentation/content/en/articles/committers-guide/_index.adoc:3628 +#: documentation/content/en/articles/committers-guide/_index.adoc:3639 msgid "Commit the changes." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3599 +#: documentation/content/en/articles/committers-guide/_index.adoc:3631 #, no-wrap msgid "How do I copy a port to a new location?" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3604 +#: documentation/content/en/articles/committers-guide/_index.adoc:3636 msgid "Copy port with `cp -R old-cat/old-port new-cat/new-port`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3605 +#: documentation/content/en/articles/committers-guide/_index.adoc:3637 msgid "Add the new port to the [.filename]#new-cat/Makefile#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3606 +#: documentation/content/en/articles/committers-guide/_index.adoc:3638 msgid "Change stuff in [.filename]#new-cat/new-port#." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3610 +#: documentation/content/en/articles/committers-guide/_index.adoc:3642 #, no-wrap msgid "Ports Freeze" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3613 +#: documentation/content/en/articles/committers-guide/_index.adoc:3645 #, no-wrap msgid "What is a “ports freeze”?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3620 +#: documentation/content/en/articles/committers-guide/_index.adoc:3652 msgid "" "A “ports freeze” was a restricted state the ports tree was put in before a " "release. It was used to ensure a higher quality for the packages shipped " @@ -8360,7 +8517,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3623 +#: documentation/content/en/articles/committers-guide/_index.adoc:3655 msgid "" "For more information on how to merge commits to the quarterly branch, see " "crossref:committers-guide[ports-qa-misc-request-mfh, What is the procedure " @@ -8368,32 +8525,32 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3625 +#: documentation/content/en/articles/committers-guide/_index.adoc:3657 #, no-wrap msgid "Quarterly Branches" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3628 +#: documentation/content/en/articles/committers-guide/_index.adoc:3660 #, no-wrap msgid "What is the procedure to request authorization for merging a commit to the quarterly branch?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3631 +#: documentation/content/en/articles/committers-guide/_index.adoc:3663 msgid "" "As of November 30, 2020, there is no need to seek explicit approval to " "commit to the quarterly branch." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3633 +#: documentation/content/en/articles/committers-guide/_index.adoc:3665 #, no-wrap msgid "What is the procedure for merging commits to the quarterly branch?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3636 +#: documentation/content/en/articles/committers-guide/_index.adoc:3668 msgid "" "Merging commits to the quarterly branch (a process we call MFH for a " "historical reason) is very similar to MFC'ing a commit in the src " @@ -8401,7 +8558,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3642 +#: documentation/content/en/articles/committers-guide/_index.adoc:3674 #, no-wrap msgid "" "% git checkout 2021Q2\n" @@ -8411,7 +8568,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3646 +#: documentation/content/en/articles/committers-guide/_index.adoc:3678 msgid "" "where `$HASH` is the hash of the commit you want to copy over to the " "quarterly branch. The `-x` parameter ensures the hash `$HASH` of the `main` " @@ -8419,63 +8576,64 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3648 +#: documentation/content/en/articles/committers-guide/_index.adoc:3680 #, no-wrap msgid "Creating a New Category" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3651 +#: documentation/content/en/articles/committers-guide/_index.adoc:3683 #, no-wrap msgid "What is the procedure for creating a new category?" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3656 +#: documentation/content/en/articles/committers-guide/_index.adoc:3688 msgid "" -"Please see extref:{porters-handbook}[Proposing a New Category, proposing-" -"categories] in the Porter's Handbook. Once that procedure has been followed " -"and the PR has been assigned to the {portmgr}, it is their decision whether " -"or not to approve it. If they do, it is their responsibility to:" +"Please see extref:{porters-handbook}makefiles[Proposing a New Category, " +"proposing-categories] in the Porter's Handbook. Once that procedure has " +"been followed and the PR has been assigned to the {portmgr}, it is their " +"decision whether or not to approve it. If they do, it is their " +"responsibility to:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3660 +#: documentation/content/en/articles/committers-guide/_index.adoc:3692 msgid "Perform any needed moves. (This only applies to physical categories.)" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3661 +#: documentation/content/en/articles/committers-guide/_index.adoc:3693 msgid "" "Update the `VALID_CATEGORIES` definition in [.filename]#ports/Mk/" "bsd.port.mk#." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3662 +#: documentation/content/en/articles/committers-guide/_index.adoc:3694 msgid "Assign the PR back to you." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3665 +#: documentation/content/en/articles/committers-guide/_index.adoc:3697 #, no-wrap msgid "What do I need to do to implement a new physical category?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3670 +#: documentation/content/en/articles/committers-guide/_index.adoc:3702 msgid "" "Upgrade each moved port's [.filename]#Makefile#. Do not connect the new " "category to the build yet." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3672 +#: documentation/content/en/articles/committers-guide/_index.adoc:3704 msgid "To do this, you will need to:" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3676 +#: documentation/content/en/articles/committers-guide/_index.adoc:3708 msgid "" "Change the port's `CATEGORIES` (this was the point of the exercise, " "remember?) The new category is listed first. This will help to ensure that " @@ -8483,7 +8641,7 @@ msgid "" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3677 +#: documentation/content/en/articles/committers-guide/_index.adoc:3709 msgid "" "Run a `make describe`. Since the top-level `make index` that you will be " "running in a few steps is an iteration of `make describe` over the entire " @@ -8492,14 +8650,14 @@ msgid "" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3678 +#: documentation/content/en/articles/committers-guide/_index.adoc:3710 msgid "" "If you want to be really thorough, now might be a good time to run " "man:portlint[1]." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3681 +#: documentation/content/en/articles/committers-guide/_index.adoc:3713 msgid "" "Check that the ``PKGORIGIN``s are correct. The ports system uses each port's " "`CATEGORIES` entry to create its `PKGORIGIN`, which is used to connect " @@ -8509,7 +8667,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3683 +#: documentation/content/en/articles/committers-guide/_index.adoc:3715 msgid "" "To do this, use the [.filename]#chkorigin.sh# tool: `env PORTSDIR=/path/to/" "ports sh -e /path/to/ports/Tools/scripts/chkorigin.sh`. This will check " @@ -8519,7 +8677,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3684 +#: documentation/content/en/articles/committers-guide/_index.adoc:3716 msgid "" "On your own local system, test the proposed changes: first, comment out the " "SUBDIR entries in the old ports' categories' [.filename]##Makefile##s; then " @@ -8531,7 +8689,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3685 +#: documentation/content/en/articles/committers-guide/_index.adoc:3717 msgid "" "Once this is done, you can commit the updated [.filename]#ports/Makefile# to " "connect the new category to the build and also commit the " @@ -8539,25 +8697,25 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3686 +#: documentation/content/en/articles/committers-guide/_index.adoc:3718 msgid "Add appropriate entries to [.filename]#ports/MOVED#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3687 +#: documentation/content/en/articles/committers-guide/_index.adoc:3719 msgid "Update the documentation by modifying:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3688 -#: documentation/content/en/articles/committers-guide/_index.adoc:3697 +#: documentation/content/en/articles/committers-guide/_index.adoc:3720 +#: documentation/content/en/articles/committers-guide/_index.adoc:3729 msgid "" -"the extref:{porters-handbook}[list of categories, PORTING-CATEGORIES] in the " -"Porter's Handbook" +"the extref:{porters-handbook}makefiles[list of categories, porting-" +"categories] in the Porter's Handbook" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3690 +#: documentation/content/en/articles/committers-guide/_index.adoc:3722 msgid "" "Only once all the above have been done, and no one is any longer reporting " "problems with the new ports, should the old ports be deleted from their " @@ -8565,38 +8723,38 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3692 +#: documentation/content/en/articles/committers-guide/_index.adoc:3724 #, no-wrap msgid "What do I need to do to implement a new virtual category?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3695 +#: documentation/content/en/articles/committers-guide/_index.adoc:3727 msgid "" "This is much simpler than a physical category. Only a few modifications are " "needed:" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3699 -#: documentation/content/en/articles/committers-guide/_index.adoc:3793 +#: documentation/content/en/articles/committers-guide/_index.adoc:3731 +#: documentation/content/en/articles/committers-guide/_index.adoc:3825 #, no-wrap msgid "Miscellaneous Questions" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3702 +#: documentation/content/en/articles/committers-guide/_index.adoc:3734 #, no-wrap msgid "Are there changes that can be committed without asking the maintainer for approval?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3705 +#: documentation/content/en/articles/committers-guide/_index.adoc:3737 msgid "Blanket approval for most ports applies to these types of fixes:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3707 +#: documentation/content/en/articles/committers-guide/_index.adoc:3739 msgid "" "Most infrastructure changes to a port (that is, modernizing, but not " "changing the functionality). For example, the blanket covers converting to " @@ -8605,19 +8763,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3708 +#: documentation/content/en/articles/committers-guide/_index.adoc:3740 msgid "Trivial and _tested_ build and runtime fixes." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3709 +#: documentation/content/en/articles/committers-guide/_index.adoc:3741 msgid "" "Documentations or metadata changes to ports, like [.filename]#pkg-descr# or " "`COMMENT`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3714 +#: documentation/content/en/articles/committers-guide/_index.adoc:3746 msgid "" "Exceptions to this are anything maintained by the {portmgr}, or the " "{security-officer}. No unauthorized commits may ever be made to ports " @@ -8625,47 +8783,47 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3717 +#: documentation/content/en/articles/committers-guide/_index.adoc:3749 #, no-wrap msgid "How do I know if my port is building correctly or not?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3721 +#: documentation/content/en/articles/committers-guide/_index.adoc:3753 msgid "" "The packages are built multiple times each week. If a port fails, the " "maintainer will receive an email from `pkg-fallout@FreeBSD.org`." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3723 +#: documentation/content/en/articles/committers-guide/_index.adoc:3755 msgid "" "Reports for all the package builds (official, experimental, and non-" -"regression) are aggregated at link:pkg-status.FreeBSD.org[pkg-" +"regression) are aggregated at link:https://pkg-status.FreeBSD.org[pkg-" "status.FreeBSD.org]." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3725 +#: documentation/content/en/articles/committers-guide/_index.adoc:3757 #, no-wrap msgid "I added a new port. Do I need to add it to the [.filename]#INDEX#?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3728 +#: documentation/content/en/articles/committers-guide/_index.adoc:3760 msgid "" "No. The file can either be generated by running `make index`, or a pre-" "generated version can be downloaded with `make fetchindex`." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3730 +#: documentation/content/en/articles/committers-guide/_index.adoc:3762 #, no-wrap msgid "Are there any other files I am not allowed to touch?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3734 +#: documentation/content/en/articles/committers-guide/_index.adoc:3766 msgid "" "Any file directly under [.filename]#ports/#, or any file under a " "subdirectory that starts with an uppercase letter ([.filename]#Mk/#, " @@ -8675,13 +8833,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3736 +#: documentation/content/en/articles/committers-guide/_index.adoc:3768 #, no-wrap msgid "What is the proper procedure for updating the checksum for a port distfile when the file changes without a version change?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3740 +#: documentation/content/en/articles/committers-guide/_index.adoc:3772 msgid "" "When the checksum for a distribution file is updated due to the author " "updating the file without changing the port revision, the commit message " @@ -8694,20 +8852,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3742 +#: documentation/content/en/articles/committers-guide/_index.adoc:3774 #, no-wrap msgid "How can an experimental test build of the ports tree (exp-run) be requested?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3746 +#: documentation/content/en/articles/committers-guide/_index.adoc:3778 msgid "" "An exp-run must be completed before patches with a significant ports impact " "are committed. The patch can be against the ports tree or the base system." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3748 +#: documentation/content/en/articles/committers-guide/_index.adoc:3780 msgid "" "Full package builds will be done with the patches provided by the submitter, " "and the submitter is required to fix detected problems _(fallout)_ before " @@ -8715,22 +8873,22 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3752 +#: documentation/content/en/articles/committers-guide/_index.adoc:3784 msgid "Go to the link:https://bugs.freebsd.org/submit[Bugzilla new PR page]." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3753 +#: documentation/content/en/articles/committers-guide/_index.adoc:3785 msgid "Select the product your patch is about." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3754 +#: documentation/content/en/articles/committers-guide/_index.adoc:3786 msgid "Fill in the bug report as normal. Remember to attach the patch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3755 +#: documentation/content/en/articles/committers-guide/_index.adoc:3787 msgid "" "If at the top it says “Show Advanced Fields” click on it. It will now say " "“Hide Advanced Fields”. Many new fields will be available. If it already " @@ -8738,56 +8896,56 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3756 +#: documentation/content/en/articles/committers-guide/_index.adoc:3788 msgid "" "In the “Flags” section, set the “exp-run” one to `?`. As for all other " "fields, hovering the mouse over any field shows more details." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3757 +#: documentation/content/en/articles/committers-guide/_index.adoc:3789 msgid "Submit. Wait for the build to run." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3758 +#: documentation/content/en/articles/committers-guide/_index.adoc:3790 msgid "{portmgr} will reply with a possible fallout." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3759 +#: documentation/content/en/articles/committers-guide/_index.adoc:3791 msgid "Depending on the fallout:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3760 +#: documentation/content/en/articles/committers-guide/_index.adoc:3792 msgid "" "If there is no fallout, the procedure stops here, and the change can be " "committed, pending any other approval required." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3761 +#: documentation/content/en/articles/committers-guide/_index.adoc:3793 msgid "" "If there is fallout, it _must_ be fixed, either by fixing the ports directly " "in the ports tree, or adding to the submitted patch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3762 +#: documentation/content/en/articles/committers-guide/_index.adoc:3794 msgid "" "When this is done, go back to step 6 saying the fallout was fixed and wait " "for the exp-run to be run again. Repeat as long as there are broken ports." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3765 +#: documentation/content/en/articles/committers-guide/_index.adoc:3797 #, no-wrap msgid "Issues Specific to Developers Who Are Not Committers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3770 +#: documentation/content/en/articles/committers-guide/_index.adoc:3802 msgid "" "A few people who have access to the FreeBSD machines do not have commit " "bits. Almost all of this document will apply to these developers as well " @@ -8796,17 +8954,17 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3772 +#: documentation/content/en/articles/committers-guide/_index.adoc:3804 msgid "crossref:committers-guide[admin, Administrative Details]" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3773 +#: documentation/content/en/articles/committers-guide/_index.adoc:3805 msgid "crossref:committers-guide[conventions-everyone, For Everyone]" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3777 +#: documentation/content/en/articles/committers-guide/_index.adoc:3809 msgid "" "Get your mentor to add you to the \"Additional Contributors\" " "([.filename]#doc/shared/contrib-additional.adoc#), if you are not already " @@ -8814,48 +8972,48 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3779 +#: documentation/content/en/articles/committers-guide/_index.adoc:3811 msgid "crossref:committers-guide[developer.relations, Developer Relations]" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3780 +#: documentation/content/en/articles/committers-guide/_index.adoc:3812 msgid "crossref:committers-guide[ssh.guide, SSH Quick-Start Guide]" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3781 +#: documentation/content/en/articles/committers-guide/_index.adoc:3813 msgid "" "crossref:committers-guide[rules, The FreeBSD Committers' Big List of Rules]" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3783 +#: documentation/content/en/articles/committers-guide/_index.adoc:3815 #, no-wrap msgid "Information About Google Analytics" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3786 +#: documentation/content/en/articles/committers-guide/_index.adoc:3818 msgid "" "As of December 12, 2012, Google Analytics was enabled on the FreeBSD Project " "website to collect anonymized usage statistics regarding usage of the site." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3790 +#: documentation/content/en/articles/committers-guide/_index.adoc:3822 msgid "" "As of March 3, 2022, Google Analytics was removed from the FreeBSD Project." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3795 +#: documentation/content/en/articles/committers-guide/_index.adoc:3827 #, no-wrap msgid "How do I access people.FreeBSD.org to put up personal or project information?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3799 +#: documentation/content/en/articles/committers-guide/_index.adoc:3831 msgid "" "`people.FreeBSD.org` is the same as `freefall.FreeBSD.org`. Just create a " "[.filename]#public_html# directory. Anything you place in that directory " @@ -8864,45 +9022,45 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3800 +#: documentation/content/en/articles/committers-guide/_index.adoc:3832 #, no-wrap msgid "Where are the mailing list archives stored?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3803 +#: documentation/content/en/articles/committers-guide/_index.adoc:3835 msgid "" "The mailing lists are archived under [.filename]#/local/mail# on " "`freefall.FreeBSD.org`." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3804 +#: documentation/content/en/articles/committers-guide/_index.adoc:3836 #, no-wrap msgid "I would like to mentor a new committer. What process do I need to follow?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3807 +#: documentation/content/en/articles/committers-guide/_index.adoc:3839 msgid "" "See the https://www.freebsd.org/internal/new-account/[New Account Creation " "Procedure] document on the internal pages." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3809 +#: documentation/content/en/articles/committers-guide/_index.adoc:3841 #, no-wrap msgid "Benefits and Perks for FreeBSD Committers" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3812 +#: documentation/content/en/articles/committers-guide/_index.adoc:3844 #, no-wrap msgid "Recognition" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3816 +#: documentation/content/en/articles/committers-guide/_index.adoc:3848 msgid "" "Recognition as a competent software engineer is the longest lasting value. " "In addition, getting a chance to work with some of the best people that " @@ -8910,33 +9068,33 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3818 +#: documentation/content/en/articles/committers-guide/_index.adoc:3850 #, no-wrap msgid "FreeBSD Mall" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3821 +#: documentation/content/en/articles/committers-guide/_index.adoc:3853 msgid "" "FreeBSD committers can get a free 4-CD or DVD set at conferences from http://" "www.freebsdmall.com[FreeBSD Mall, Inc.]." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3823 +#: documentation/content/en/articles/committers-guide/_index.adoc:3855 #, no-wrap msgid "`Gandi.net`" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3826 +#: documentation/content/en/articles/committers-guide/_index.adoc:3858 msgid "" "https://gandi.net[Gandi] provides website hosting, cloud computing, domain " "registration, and X.509 certificate services." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3830 +#: documentation/content/en/articles/committers-guide/_index.adoc:3862 msgid "" "Gandi offers an E-rate discount to all FreeBSD developers. To streamline " "the process of getting the discount first set up a Gandi account, fill in " @@ -8946,20 +9104,20 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3832 +#: documentation/content/en/articles/committers-guide/_index.adoc:3864 #, no-wrap msgid "`rsync.net`" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3835 +#: documentation/content/en/articles/committers-guide/_index.adoc:3867 msgid "" "https://rsync.net[rsync.net] provides cloud storage for offsite backup that " "is optimized for UNIX users. Their service runs entirely on FreeBSD and ZFS." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3836 +#: documentation/content/en/articles/committers-guide/_index.adoc:3868 msgid "" "rsync.net offers a free-forever 500 GB account to FreeBSD developers. Simply " "sign up at https://www.rsync.net/freebsd.html[https://www.rsync.net/" |