diff options
Diffstat (limited to 'documentation/content/en/articles/committers-guide')
| -rw-r--r-- | documentation/content/en/articles/committers-guide/_index.adoc | 3 | ||||
| -rw-r--r-- | documentation/content/en/articles/committers-guide/_index.po | 4740 |
2 files changed, 2552 insertions, 2191 deletions
diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index 71bb302151..2650a480ba 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -188,8 +188,7 @@ Rather than suggest a single way, here are some links to sites that describe var Protect the private key and passphrase. If either the private key or passphrase may have been compromised or disclosed, immediately notify mailto:accounts@FreeBSD.org[accounts@FreeBSD.org] and revoke the key. -Committing the new key is shown in crossref:committers-guide[commit-steps, Steps -for New Committers]. +Committing the new key is shown in crossref:committers-guide[commit-steps, Steps for New Committers]. [[kerberos-ldap]] == Kerberos and LDAP web Password for FreeBSD Cluster diff --git a/documentation/content/en/articles/committers-guide/_index.po b/documentation/content/en/articles/committers-guide/_index.po index 9585f882ca..c1f608dfab 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-06-29 21:20+0100\n" +"POT-Creation-Date: 2025-08-17 20:53+0100\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" @@ -421,43 +421,38 @@ msgid "https://bugs.freebsd.org/bugzilla[Bugzilla]" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:203 -msgid "https://ci.freebsd.org[Jenkins]" -msgstr "" - -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:205 +#: documentation/content/en/articles/committers-guide/_index.adoc:204 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:209 +#: documentation/content/en/articles/committers-guide/_index.adoc:208 #, no-wrap msgid "% ssh kpasswd.freebsd.org\n" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:214 +#: documentation/content/en/articles/committers-guide/_index.adoc:213 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:217 +#: documentation/content/en/articles/committers-guide/_index.adoc:216 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:221 +#: documentation/content/en/articles/committers-guide/_index.adoc:220 #, no-wrap msgid "% kpasswd\n" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:227 +#: documentation/content/en/articles/committers-guide/_index.adoc:226 msgid "" "Unless the Kerberos-authenticated services of the FreeBSD.org cluster have " "been used previously, `Client unknown` will be shown. This error means that " @@ -466,13 +461,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:230 +#: documentation/content/en/articles/committers-guide/_index.adoc:229 #, no-wrap msgid "Commit Bit Types" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:236 +#: documentation/content/en/articles/committers-guide/_index.adoc:235 msgid "" "The FreeBSD repository has a number of components which, when combined, " "support the basic operating system source, documentation, third party " @@ -487,79 +482,79 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:242 +#: documentation/content/en/articles/committers-guide/_index.adoc:241 #, no-wrap msgid "__Committer Type__" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:243 +#: documentation/content/en/articles/committers-guide/_index.adoc:242 #, no-wrap msgid "__Responsible__" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:245 +#: documentation/content/en/articles/committers-guide/_index.adoc:244 #, no-wrap msgid "__Tree Components__" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:246 +#: documentation/content/en/articles/committers-guide/_index.adoc:245 #, no-wrap msgid "src" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:247 +#: documentation/content/en/articles/committers-guide/_index.adoc:246 #, no-wrap msgid "srcmgr@" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:249 +#: documentation/content/en/articles/committers-guide/_index.adoc:248 #, no-wrap msgid "src/" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:250 +#: documentation/content/en/articles/committers-guide/_index.adoc:249 #, no-wrap msgid "doc" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:251 +#: documentation/content/en/articles/committers-guide/_index.adoc:250 #, no-wrap msgid "doceng@" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:253 +#: documentation/content/en/articles/committers-guide/_index.adoc:252 #, no-wrap msgid "doc/, ports/, src/ documentation" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:254 +#: documentation/content/en/articles/committers-guide/_index.adoc:253 #, no-wrap msgid "ports" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:255 +#: documentation/content/en/articles/committers-guide/_index.adoc:254 #, no-wrap msgid "portmgr@" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:256 +#: documentation/content/en/articles/committers-guide/_index.adoc:255 #, no-wrap msgid "ports/" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:261 +#: documentation/content/en/articles/committers-guide/_index.adoc:260 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, " @@ -572,7 +567,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:263 +#: documentation/content/en/articles/committers-guide/_index.adoc:262 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 " @@ -580,13 +575,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:264 +#: documentation/content/en/articles/committers-guide/_index.adoc:263 #, no-wrap msgid "Policy for Committer Activity in Other Trees" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:267 +#: documentation/content/en/articles/committers-guide/_index.adoc:266 msgid "" "All committers may modify [.filename]#src/share/misc/committers-*.dot#, " "[.filename]#src/usr.bin/calendar/calendars/calendar.freebsd#, and " @@ -594,7 +589,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:268 +#: documentation/content/en/articles/committers-guide/_index.adoc:267 msgid "" "doc committers may commit documentation changes to [.filename]#src# files, " "such as manual pages, READMEs, fortune databases, calendar files, and " @@ -603,7 +598,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 "" "Any committer may make changes to any other tree with an \"Approved by\" " "from a non-mentored committer with the appropriate bit. Mentored committers " @@ -611,7 +606,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:271 +#: documentation/content/en/articles/committers-guide/_index.adoc:270 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. " @@ -621,13 +616,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:273 +#: documentation/content/en/articles/committers-guide/_index.adoc:272 #, no-wrap msgid "Documentation Implicit (Blanket) Approval" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:277 +#: documentation/content/en/articles/committers-guide/_index.adoc:276 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 " @@ -636,87 +631,87 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:279 +#: documentation/content/en/articles/committers-guide/_index.adoc:278 msgid "Blanket approval applies to these types of fixes:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:281 +#: documentation/content/en/articles/committers-guide/_index.adoc:280 msgid "Typos" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:282 +#: documentation/content/en/articles/committers-guide/_index.adoc:281 msgid "Trivial fixes" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:284 +#: documentation/content/en/articles/committers-guide/_index.adoc:283 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:287 +#: documentation/content/en/articles/committers-guide/_index.adoc:286 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:289 +#: documentation/content/en/articles/committers-guide/_index.adoc:288 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:291 +#: documentation/content/en/articles/committers-guide/_index.adoc:290 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:292 +#: documentation/content/en/articles/committers-guide/_index.adoc:291 msgid "Changes in [.filename]#doc/shared/contrib-additional.adoc#" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:294 +#: documentation/content/en/articles/committers-guide/_index.adoc:293 msgid "" "extref:{contributors}[Additional FreeBSD Contributors, contrib-additional] " "maintenance." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:295 +#: documentation/content/en/articles/committers-guide/_index.adoc:294 msgid "All link:#commit-steps[Steps for New Committers], doc related" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:296 +#: documentation/content/en/articles/committers-guide/_index.adoc:295 msgid "Security advisories; Errata Notices; Releases;" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:298 +#: documentation/content/en/articles/committers-guide/_index.adoc:297 msgid "Used by {security-officer} and {re}." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:299 +#: documentation/content/en/articles/committers-guide/_index.adoc:298 msgid "Changes in [.filename]#website/content/en/donations/donors.adoc#" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:301 +#: documentation/content/en/articles/committers-guide/_index.adoc:300 msgid "Used by {donations}." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:303 +#: documentation/content/en/articles/committers-guide/_index.adoc:302 msgid "" "Before any commit, a build test is necessary; see the 'Overview' and 'The " "FreeBSD Documentation Build Process' sections of the extref:{fdp-primer}" @@ -724,19 +719,19 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:305 +#: documentation/content/en/articles/committers-guide/_index.adoc:304 #, no-wrap msgid "Git Primer" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:308 +#: documentation/content/en/articles/committers-guide/_index.adoc:307 #, no-wrap msgid "Git basics" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:315 +#: documentation/content/en/articles/committers-guide/_index.adoc:314 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 " @@ -751,33 +746,33 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:317 +#: documentation/content/en/articles/committers-guide/_index.adoc:316 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:319 +#: documentation/content/en/articles/committers-guide/_index.adoc:318 #, no-wrap msgid "Git Mini Primer" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:322 +#: documentation/content/en/articles/committers-guide/_index.adoc:321 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:323 +#: documentation/content/en/articles/committers-guide/_index.adoc:322 #, no-wrap msgid "Scope" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:329 +#: documentation/content/en/articles/committers-guide/_index.adoc:328 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, " @@ -789,7 +784,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:333 +#: documentation/content/en/articles/committers-guide/_index.adoc:332 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 " @@ -798,49 +793,49 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:335 +#: documentation/content/en/articles/committers-guide/_index.adoc:334 #, no-wrap msgid "Getting Started For Developers" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:338 +#: documentation/content/en/articles/committers-guide/_index.adoc:337 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:340 +#: documentation/content/en/articles/committers-guide/_index.adoc:339 #, no-wrap msgid "Daily use" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:345 +#: documentation/content/en/articles/committers-guide/_index.adoc:344 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:348 +#: documentation/content/en/articles/committers-guide/_index.adoc:347 msgid "Clone the repository:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:352 +#: documentation/content/en/articles/committers-guide/_index.adoc:351 #, 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:355 +#: documentation/content/en/articles/committers-guide/_index.adoc:354 msgid "Then you should have the official mirrors as your remote:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:361 +#: documentation/content/en/articles/committers-guide/_index.adoc:360 #, no-wrap msgid "" "% git remote -v\n" @@ -849,12 +844,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:364 +#: documentation/content/en/articles/committers-guide/_index.adoc:363 msgid "Configure the FreeBSD committer data:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:367 +#: documentation/content/en/articles/committers-guide/_index.adoc:366 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 " @@ -863,7 +858,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:374 +#: documentation/content/en/articles/committers-guide/_index.adoc:373 #, no-wrap msgid "" "% gen-gitconfig.sh\n" @@ -873,25 +868,25 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:377 +#: documentation/content/en/articles/committers-guide/_index.adoc:376 msgid "Set the push URL:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:381 +#: documentation/content/en/articles/committers-guide/_index.adoc:380 #, 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:384 +#: documentation/content/en/articles/committers-guide/_index.adoc:383 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:390 +#: documentation/content/en/articles/committers-guide/_index.adoc:389 #, no-wrap msgid "" "% git remote -v\n" @@ -900,24 +895,24 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:393 +#: documentation/content/en/articles/committers-guide/_index.adoc:392 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:395 +#: documentation/content/en/articles/committers-guide/_index.adoc:394 msgid "Install commit message template hook:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:397 +#: documentation/content/en/articles/committers-guide/_index.adoc:396 msgid "For doc repository:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:402 +#: documentation/content/en/articles/committers-guide/_index.adoc:401 #, no-wrap msgid "" "% cd .git/hooks\n" @@ -925,23 +920,23 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:405 +#: documentation/content/en/articles/committers-guide/_index.adoc:404 msgid "For ports repository:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:409 +#: documentation/content/en/articles/committers-guide/_index.adoc:408 #, no-wrap msgid "% git config --add core.hooksPath .hooks\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:412 +#: documentation/content/en/articles/committers-guide/_index.adoc:411 msgid "For src repository:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:417 +#: documentation/content/en/articles/committers-guide/_index.adoc:416 #, no-wrap msgid "" "% cd .git/hooks\n" @@ -949,27 +944,27 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:420 +#: documentation/content/en/articles/committers-guide/_index.adoc:419 #, no-wrap msgid "\"admin\" branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:423 +#: documentation/content/en/articles/committers-guide/_index.adoc:422 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:425 +#: documentation/content/en/articles/committers-guide/_index.adoc:424 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:431 +#: documentation/content/en/articles/committers-guide/_index.adoc:430 #, no-wrap msgid "" "% git config --add remote.freebsd.fetch '+refs/internal/*:refs/internal/*'\n" @@ -978,42 +973,42 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:433 +#: documentation/content/en/articles/committers-guide/_index.adoc:432 msgid "Alternatively, you can add a worktree for the `admin` branch:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:437 +#: documentation/content/en/articles/committers-guide/_index.adoc:436 #, 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:441 +#: documentation/content/en/articles/committers-guide/_index.adoc:440 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:443 +#: documentation/content/en/articles/committers-guide/_index.adoc:442 msgid "For pushing, specify the full refspec:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:447 +#: documentation/content/en/articles/committers-guide/_index.adoc:446 #, no-wrap msgid "git push freebsd HEAD:refs/internal/admin\n" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:449 +#: documentation/content/en/articles/committers-guide/_index.adoc:448 #, no-wrap msgid "Keeping Current With The FreeBSD src Tree" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:456 +#: documentation/content/en/articles/committers-guide/_index.adoc:455 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 " @@ -1022,75 +1017,75 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:457 +#: documentation/content/en/articles/committers-guide/_index.adoc:456 #, no-wrap msgid "Branch Names" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:459 +#: documentation/content/en/articles/committers-guide/_index.adoc:458 msgid "FreeBSD-CURRENT uses the `main` branch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:461 +#: documentation/content/en/articles/committers-guide/_index.adoc:460 msgid "`main` is the default branch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:463 +#: documentation/content/en/articles/committers-guide/_index.adoc:462 msgid "For FreeBSD-STABLE, branch names include `stable/12` and `stable/13`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:465 +#: documentation/content/en/articles/committers-guide/_index.adoc:464 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:467 +#: documentation/content/en/articles/committers-guide/_index.adoc:466 msgid "https://www.freebsd.org/releng/[] shows:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:469 +#: documentation/content/en/articles/committers-guide/_index.adoc:468 msgid "`main` and `stable/⋯` branches open" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:470 +#: documentation/content/en/articles/committers-guide/_index.adoc:469 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:472 +#: documentation/content/en/articles/committers-guide/_index.adoc:471 msgid "Examples:" 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.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:475 +#: documentation/content/en/articles/committers-guide/_index.adoc:474 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:476 +#: documentation/content/en/articles/committers-guide/_index.adoc:475 #, no-wrap msgid "Repositories" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:479 +#: documentation/content/en/articles/committers-guide/_index.adoc:478 msgid "" "Please see the crossref:committers-guide[admin,Administrative Details] for " "the latest information on where to get FreeBSD sources. $URL below can be " @@ -1098,7 +1093,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:482 +#: documentation/content/en/articles/committers-guide/_index.adoc:481 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 " @@ -1107,13 +1102,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:483 +#: documentation/content/en/articles/committers-guide/_index.adoc:482 #, no-wrap msgid "Deep Clone" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:487 +#: documentation/content/en/articles/committers-guide/_index.adoc:486 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 " @@ -1122,13 +1117,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:490 +#: documentation/content/en/articles/committers-guide/_index.adoc:489 #, no-wrap msgid "% git clone -o freebsd $URL -b branch [<directory>]\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:495 +#: documentation/content/en/articles/committers-guide/_index.adoc:494 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 " @@ -1138,7 +1133,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:500 +#: documentation/content/en/articles/committers-guide/_index.adoc:499 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 " @@ -1150,13 +1145,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:501 +#: documentation/content/en/articles/committers-guide/_index.adoc:500 #, no-wrap msgid "Shallow Clone" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:507 +#: documentation/content/en/articles/committers-guide/_index.adoc:506 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 " @@ -1166,13 +1161,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:511 +#: documentation/content/en/articles/committers-guide/_index.adoc:510 #, 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:516 +#: documentation/content/en/articles/committers-guide/_index.adoc:515 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 " @@ -1180,7 +1175,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:521 +#: documentation/content/en/articles/committers-guide/_index.adoc:520 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 " @@ -1188,19 +1183,19 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:523 +#: documentation/content/en/articles/committers-guide/_index.adoc:522 #, no-wrap msgid "Building" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:527 +#: documentation/content/en/articles/committers-guide/_index.adoc:526 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:534 +#: documentation/content/en/articles/committers-guide/_index.adoc:533 #, no-wrap msgid "" "% cd src\n" @@ -1211,12 +1206,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:536 +#: documentation/content/en/articles/committers-guide/_index.adoc:535 msgid "so that won't be covered in depth here." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:539 +#: documentation/content/en/articles/committers-guide/_index.adoc:538 msgid "" "If you want to build a custom kernel, extref:{handbook}[the kernel config " "section, kernelconfig] of the FreeBSD Handbook recommends creating a file " @@ -1225,26 +1220,26 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:540 +#: documentation/content/en/articles/committers-guide/_index.adoc:539 #, no-wrap msgid "Updating" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:544 +#: documentation/content/en/articles/committers-guide/_index.adoc:543 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:547 +#: documentation/content/en/articles/committers-guide/_index.adoc:546 #, no-wrap msgid "% git pull --ff-only\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:552 +#: documentation/content/en/articles/committers-guide/_index.adoc:551 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 " @@ -1254,7 +1249,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:555 +#: documentation/content/en/articles/committers-guide/_index.adoc:554 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 " @@ -1262,20 +1257,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:556 +#: documentation/content/en/articles/committers-guide/_index.adoc:555 #, no-wrap msgid "Selecting a Specific Version" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:560 +#: documentation/content/en/articles/committers-guide/_index.adoc:559 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:562 +#: documentation/content/en/articles/committers-guide/_index.adoc:561 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 " @@ -1283,26 +1278,26 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:565 +#: documentation/content/en/articles/committers-guide/_index.adoc:564 #, no-wrap msgid "% git checkout 08b8197a74\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:568 +#: documentation/content/en/articles/committers-guide/_index.adoc:567 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:571 +#: documentation/content/en/articles/committers-guide/_index.adoc:570 #, no-wrap msgid "Note: checking out '08b8197a742a96964d2924391bf9fdfeb788865d'.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:575 +#: documentation/content/en/articles/committers-guide/_index.adoc:574 #, no-wrap msgid "" "You are in a 'detached HEAD' state. You can look around, make experimental\n" @@ -1311,28 +1306,29 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:578 +#: documentation/content/en/articles/committers-guide/_index.adoc:577 +#: documentation/content/en/articles/committers-guide/_index.adoc:1746 #, no-wrap msgid "" "If you want to create a new branch to retain commits you create, you may\n" "do so (now or later) by using -b with the checkout command again. Example:\n" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:580 -#: documentation/content/en/articles/committers-guide/_index.adoc:1744 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:579 +#: documentation/content/en/articles/committers-guide/_index.adoc:1748 #, no-wrap msgid " git checkout -b <new-branch-name>\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:582 +#: documentation/content/en/articles/committers-guide/_index.adoc:581 #, 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:586 +#: documentation/content/en/articles/committers-guide/_index.adoc:585 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 " @@ -1341,13 +1337,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:587 +#: documentation/content/en/articles/committers-guide/_index.adoc:586 #, no-wrap msgid "Bisecting" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:591 +#: documentation/content/en/articles/committers-guide/_index.adoc:590 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 " @@ -1355,7 +1351,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:596 +#: documentation/content/en/articles/committers-guide/_index.adoc:595 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 " @@ -1367,7 +1363,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:603 +#: documentation/content/en/articles/committers-guide/_index.adoc:602 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 " @@ -1380,14 +1376,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:607 +#: documentation/content/en/articles/committers-guide/_index.adoc:606 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:612 +#: documentation/content/en/articles/committers-guide/_index.adoc:611 #, no-wrap msgid "" "5ef0bd68b515 (HEAD -> main, freebsd/main, freebsd/HEAD) HEAD@{0}: pull --ff-only: Fast-forward\n" @@ -1396,7 +1392,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:616 +#: documentation/content/en/articles/committers-guide/_index.adoc:615 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 " @@ -1407,7 +1403,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:620 +#: documentation/content/en/articles/committers-guide/_index.adoc:619 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 " @@ -1415,7 +1411,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:627 +#: documentation/content/en/articles/committers-guide/_index.adoc:626 #, no-wrap msgid "" "% git bisect start --first-parent\n" @@ -1426,7 +1422,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:636 +#: documentation/content/en/articles/committers-guide/_index.adoc:635 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, " @@ -1439,13 +1435,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:638 +#: documentation/content/en/articles/committers-guide/_index.adoc:637 #, no-wrap msgid "Signing the commits, tags, and pushes, with GnuPG" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:643 +#: documentation/content/en/articles/committers-guide/_index.adoc:642 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 " @@ -1454,7 +1450,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:645 +#: documentation/content/en/articles/committers-guide/_index.adoc:644 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 - " @@ -1462,7 +1458,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:647 +#: documentation/content/en/articles/committers-guide/_index.adoc:646 msgid "" "The rationale behind signing pushes can be found in the https://github.com/" "git/git/commit/a85b377d0419a9dfaca8af2320cc33b051cbed04[commit that " @@ -1470,14 +1466,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:650 +#: documentation/content/en/articles/committers-guide/_index.adoc:649 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:657 +#: documentation/content/en/articles/committers-guide/_index.adoc:656 #, no-wrap msgid "" "% git config --add user.signingKey LONG-KEY-ID\n" @@ -1488,14 +1484,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:665 +#: documentation/content/en/articles/committers-guide/_index.adoc:664 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:671 +#: documentation/content/en/articles/committers-guide/_index.adoc:670 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 " @@ -1503,20 +1499,20 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:673 +#: documentation/content/en/articles/committers-guide/_index.adoc:672 #, no-wrap msgid "Verifying signatures" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:676 +#: documentation/content/en/articles/committers-guide/_index.adoc:675 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:678 +#: documentation/content/en/articles/committers-guide/_index.adoc:677 msgid "" "Tag signatures can be verified with `git verify-tag <tag name>`, or `git tag " "-v <tag name>`." @@ -1528,20 +1524,20 @@ 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:687 +#: documentation/content/en/articles/committers-guide/_index.adoc:686 #, no-wrap msgid "Ports Considerations" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:690 +#: documentation/content/en/articles/committers-guide/_index.adoc:689 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:693 +#: documentation/content/en/articles/committers-guide/_index.adoc:692 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://" @@ -1550,7 +1546,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:697 +#: documentation/content/en/articles/committers-guide/_index.adoc:696 msgid "" "There is also a mirror on GitHub, see extref:{handbook}/mirrors[External " "mirrors, mirrors] for an overview. The _latest_ branch is `main`. The " @@ -1558,13 +1554,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:699 +#: documentation/content/en/articles/committers-guide/_index.adoc:698 #, no-wrap msgid "Commit message formats" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:703 +#: documentation/content/en/articles/committers-guide/_index.adoc:702 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-" @@ -1573,32 +1569,32 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:705 +#: documentation/content/en/articles/committers-guide/_index.adoc:704 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:708 +#: documentation/content/en/articles/committers-guide/_index.adoc:707 #, no-wrap msgid "category/port: Summary.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:710 +#: documentation/content/en/articles/committers-guide/_index.adoc:709 #, no-wrap msgid "Description of why the changes where made.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:712 +#: documentation/content/en/articles/committers-guide/_index.adoc:711 #, no-wrap msgid "PR:\t 12345\n" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:718 +#: documentation/content/en/articles/committers-guide/_index.adoc:717 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 " @@ -1606,39 +1602,39 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:720 +#: documentation/content/en/articles/committers-guide/_index.adoc:719 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:722 +#: documentation/content/en/articles/committers-guide/_index.adoc:721 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:724 +#: documentation/content/en/articles/committers-guide/_index.adoc:723 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:726 +#: documentation/content/en/articles/committers-guide/_index.adoc:725 #, no-wrap msgid "Managing Local Changes" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:729 +#: documentation/content/en/articles/committers-guide/_index.adoc:728 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:735 +#: documentation/content/en/articles/committers-guide/_index.adoc:734 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 " @@ -1649,13 +1645,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:736 +#: documentation/content/en/articles/committers-guide/_index.adoc:735 #, no-wrap msgid "Keeping local changes" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:743 +#: documentation/content/en/articles/committers-guide/_index.adoc:742 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 " @@ -1667,7 +1663,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:747 +#: documentation/content/en/articles/committers-guide/_index.adoc:746 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 " @@ -1676,13 +1672,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:748 +#: documentation/content/en/articles/committers-guide/_index.adoc:747 #, no-wrap msgid "Keeping a local branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:755 +#: documentation/content/en/articles/committers-guide/_index.adoc:754 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 " @@ -1693,7 +1689,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:759 +#: documentation/content/en/articles/committers-guide/_index.adoc:758 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 " @@ -1702,12 +1698,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:761 +#: documentation/content/en/articles/committers-guide/_index.adoc:760 msgid "====== Create a branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:766 +#: documentation/content/en/articles/committers-guide/_index.adoc:765 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 " @@ -1717,7 +1713,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:788 +#: documentation/content/en/articles/committers-guide/_index.adoc:787 #, no-wrap msgid "" "% cd src\n" @@ -1743,7 +1739,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:795 +#: documentation/content/en/articles/committers-guide/_index.adoc:794 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 " @@ -1755,12 +1751,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:797 +#: documentation/content/en/articles/committers-guide/_index.adoc:796 msgid "====== Time to update" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:802 +#: documentation/content/en/articles/committers-guide/_index.adoc:801 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 " @@ -1770,7 +1766,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:808 +#: documentation/content/en/articles/committers-guide/_index.adoc:807 #, no-wrap msgid "" "% git checkout main\n" @@ -1779,7 +1775,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:813 +#: documentation/content/en/articles/committers-guide/_index.adoc:812 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 " @@ -1788,14 +1784,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:815 +#: documentation/content/en/articles/committers-guide/_index.adoc:814 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:822 +#: documentation/content/en/articles/committers-guide/_index.adoc:821 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 " @@ -1804,7 +1800,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:825 +#: documentation/content/en/articles/committers-guide/_index.adoc:824 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 " @@ -1812,7 +1808,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:835 +#: documentation/content/en/articles/committers-guide/_index.adoc:834 #, no-wrap msgid "" "Auto-merging bin/ls/ls.c\n" @@ -1826,15 +1822,20 @@ msgid "" msgstr "" #. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:836 +msgid "which looks scary." +msgstr "" + +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:838 msgid "" -"which looks scary. 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 rest of ls.c has been omitted):" +"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 " +"rest of ls.c has been omitted):" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:847 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:848 #, no-wrap msgid "" " <<<<<<< HEAD\n" @@ -1847,130 +1848,138 @@ msgid "" " >>>>>>> 646e0f9cda11... no color ls\n" msgstr "" -#. type: delimited block . 4 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:851 -#, no-wrap -msgid "" -"The new code is first, and your code is second.\n" -"The right fix here is to just add a #undef COLORLS_NEW before #ifdef and then delete the old changes:\n" -"[source,shell]\n" +msgid "The new code is first, and your code is second." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:855 -msgid "#undef COLORLS_NEW #ifdef COLORLS_NEW #include <terminfo.h>" +#: documentation/content/en/articles/committers-guide/_index.adoc:853 +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:859 +#: documentation/content/en/articles/committers-guide/_index.adoc:858 #, no-wrap msgid "" -"save the file.\n" -"The rebase was interrupted, so you have to complete it:\n" -"[source,shell]\n" +"#undef COLORLS_NEW\n" +"#ifdef COLORLS_NEW\n" +"#include <terminfo.h>\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:860 +msgid "save the file." msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:862 -msgid "% git add ls.c % git rebase --continue" +msgid "The rebase was interrupted, so you have to complete it:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:867 +#: documentation/content/en/articles/committers-guide/_index.adoc:866 #, no-wrap msgid "" -"which tells Git that ls.c has been fixed and to continue the rebase operation.\n" -"Since there was a conflict, you will get kicked into the editor to update the commit message if necessary.\n" -"If the commit message is still accurate, just exit the editor.\n" +"% git add ls.c\n" +"% git rebase --continue\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:872 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:871 msgid "" -"If you get stuck during the rebase, do not panic.\n" -"git rebase --abort will take you back to a clean slate.\n" -"It is important, though, to start with an unmodified tree.\n" -"An aside: The above mentioned `git reflog` comes in handy here, as it will have a list of all the (intermediate) commits that you can view or inspect or cherry-pick.\n" +"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 " +"to update the commit message if necessary. If the commit message is still " +"accurate, just exit the editor." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:875 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:876 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.\n" -"It is a good resource for issues that arise occasionally but are too obscure for this guide.\n" +"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 " +"unmodified tree. An aside: The above mentioned `git reflog` comes in handy " +"here, as it will have a list of all the (intermediate) commits that you can " +"view or inspect or cherry-pick." msgstr "" -#. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:876 -#, no-wrap -msgid "Switching to a Different FreeBSD Branch" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:879 +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 " +"good resource for issues that arise occasionally but are too obscure for " +"this guide." msgstr "" -#. type: delimited block . 4 +#. type: Title ===== #: documentation/content/en/articles/committers-guide/_index.adoc:880 -msgid "" -"If you wish to shift from stable/12 to the current branch. If you have a " -"deep clone, the following will suffice: [source,shell]" +#, no-wrap +msgid "Switching to a Different FreeBSD Branch" msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:883 -msgid "% git checkout main % # build and install here..." +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:889 +#: documentation/content/en/articles/committers-guide/_index.adoc:887 #, no-wrap msgid "" -"If you have a local branch, though, there are one or two caveats.\n" -"First, rebase will rewrite history, so you will likely want to do something to save it.\n" -"Second, jumping branches tends to cause more conflicts.\n" -"If we pretend the example above was relative to stable/12, then to move to `main`, I'd suggest the following:\n" -"[source,shell]\n" +"% git checkout main\n" +"% # build and install here...\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:893 -#, no-wrap +#: documentation/content/en/articles/committers-guide/_index.adoc:892 msgid "" -"% git checkout no-color-ls\n" -"% git checkout -b no-color-ls-stable-12 # create another name for this branch\n" -"% git rebase -i stable/12 no-color-ls --onto main\n" +"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 " +"it. Second, jumping branches tends to cause more conflicts. If we pretend " +"the example above was relative to stable/12, then to move to `main`, I'd " +"suggest the following:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:900 +#: documentation/content/en/articles/committers-guide/_index.adoc:897 #, no-wrap msgid "" -"What the above does is checkout no-color-ls.\n" -"Then create a new name for it (no-color-ls-stable-12) in case you need to get back to it.\n" -"Then you rebase onto the `main` branch.\n" -"This will find all the commits to the current no-color-ls branch (back to where it meets up with the stable/12 branch) and then it will\n" -"replay them onto the `main` branch creating a new no-color-ls branch there (which is why I had you create a place holder name).\n" +"% git checkout no-color-ls\n" +"% git checkout -b no-color-ls-stable-12 # create another name for this branch\n" +"% git rebase -i stable/12 no-color-ls --onto main\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:902 -#, no-wrap -msgid "[[mfc-with-git]]\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:904 +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 " +"onto the `main` branch. This will find all the commits to the current no-" +"color-ls branch (back to where it meets up with the stable/12 branch) and " +"then it will replay them onto the `main` branch creating a new no-color-ls " +"branch there (which is why I had you create a place holder name)." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:902 +#: documentation/content/en/articles/committers-guide/_index.adoc:906 #, no-wrap msgid "MFC (Merge From Current) Procedures" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:903 +#: documentation/content/en/articles/committers-guide/_index.adoc:907 #, no-wrap msgid "Summary" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:907 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:911 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 " @@ -1978,194 +1987,157 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:908 +#: documentation/content/en/articles/committers-guide/_index.adoc:912 #, no-wrap msgid "Single commit MFC" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:911 -#: documentation/content/en/articles/committers-guide/_index.adoc:951 -#: documentation/content/en/articles/committers-guide/_index.adoc:987 -#: documentation/content/en/articles/committers-guide/_index.adoc:1103 -#: documentation/content/en/articles/committers-guide/_index.adoc:1116 -#: documentation/content/en/articles/committers-guide/_index.adoc:1159 -#: documentation/content/en/articles/committers-guide/_index.adoc:1177 -#: documentation/content/en/articles/committers-guide/_index.adoc:1269 -#: documentation/content/en/articles/committers-guide/_index.adoc:1287 -#: documentation/content/en/articles/committers-guide/_index.adoc:1309 -#: documentation/content/en/articles/committers-guide/_index.adoc:1327 -#: documentation/content/en/articles/committers-guide/_index.adoc:1348 -#: documentation/content/en/articles/committers-guide/_index.adoc:1363 -#: documentation/content/en/articles/committers-guide/_index.adoc:1382 -#: documentation/content/en/articles/committers-guide/_index.adoc:1414 -#: documentation/content/en/articles/committers-guide/_index.adoc:1461 -#: documentation/content/en/articles/committers-guide/_index.adoc:1525 -msgid "[source,shell]" +#: documentation/content/en/articles/committers-guide/_index.adoc:918 +#, no-wrap +msgid "" +"% git checkout stable/X\n" +"% git cherry-pick -x $HASH --edit\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:914 -msgid "% git checkout stable/X % git cherry-pick -x $HASH --edit" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:918 -#, no-wrap +#: documentation/content/en/articles/committers-guide/_index.adoc:922 msgid "" -"For MFC commits, for example a vendor import, you would need to specify one parent for cherry-pick purposes.\n" -"Normally, that would be the \"first parent\" of the branch you are cherry-picking from, so:\n" +"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 " +"parent\" of the branch you are cherry-picking from, so:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:920 -#: documentation/content/en/articles/committers-guide/_index.adoc:941 -#: documentation/content/en/articles/committers-guide/_index.adoc:964 -#: documentation/content/en/articles/committers-guide/_index.adoc:975 -#: documentation/content/en/articles/committers-guide/_index.adoc:1241 -#: documentation/content/en/articles/committers-guide/_index.adoc:1335 -#: documentation/content/en/articles/committers-guide/_index.adoc:1421 -#: documentation/content/en/articles/committers-guide/_index.adoc:1433 -#: documentation/content/en/articles/committers-guide/_index.adoc:1445 -#: documentation/content/en/articles/committers-guide/_index.adoc:1471 -#: documentation/content/en/articles/committers-guide/_index.adoc:1483 -#: documentation/content/en/articles/committers-guide/_index.adoc:1490 -#: documentation/content/en/articles/committers-guide/_index.adoc:1532 -#: documentation/content/en/articles/committers-guide/_index.adoc:1566 -#: documentation/content/en/articles/committers-guide/_index.adoc:1573 -#: documentation/content/en/articles/committers-guide/_index.adoc:1582 -#: documentation/content/en/articles/committers-guide/_index.adoc:1611 -#: documentation/content/en/articles/committers-guide/_index.adoc:1627 -#: documentation/content/en/articles/committers-guide/_index.adoc:1638 -#: documentation/content/en/articles/committers-guide/_index.adoc:1667 -#: documentation/content/en/articles/committers-guide/_index.adoc:1688 -#: documentation/content/en/articles/committers-guide/_index.adoc:1719 -#: documentation/content/en/articles/committers-guide/_index.adoc:1731 -#: documentation/content/en/articles/committers-guide/_index.adoc:1764 -#: documentation/content/en/articles/committers-guide/_index.adoc:1773 -#: documentation/content/en/articles/committers-guide/_index.adoc:1785 -#: documentation/content/en/articles/committers-guide/_index.adoc:1801 -#: documentation/content/en/articles/committers-guide/_index.adoc:1817 -#: documentation/content/en/articles/committers-guide/_index.adoc:1828 -#: documentation/content/en/articles/committers-guide/_index.adoc:1835 -#: documentation/content/en/articles/committers-guide/_index.adoc:1848 -#: documentation/content/en/articles/committers-guide/_index.adoc:1868 -#: documentation/content/en/articles/committers-guide/_index.adoc:1882 -#: documentation/content/en/articles/committers-guide/_index.adoc:1906 -#: documentation/content/en/articles/committers-guide/_index.adoc:1918 -#: documentation/content/en/articles/committers-guide/_index.adoc:1937 -#: documentation/content/en/articles/committers-guide/_index.adoc:1948 -#: documentation/content/en/articles/committers-guide/_index.adoc:1958 -#: documentation/content/en/articles/committers-guide/_index.adoc:1998 -#: documentation/content/en/articles/committers-guide/_index.adoc:2006 -#: documentation/content/en/articles/committers-guide/_index.adoc:2017 -#: documentation/content/en/articles/committers-guide/_index.adoc:2038 -#: documentation/content/en/articles/committers-guide/_index.adoc:2099 +#: documentation/content/en/articles/committers-guide/_index.adoc:927 #, no-wrap -msgid "[source,shell]\n" +msgid "" +"% git checkout stable/X\n" +"% git cherry-pick -x $HASH -m 1 --edit\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:923 -msgid "% git checkout stable/X % git cherry-pick -x $HASH -m 1 --edit" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:926 -#, no-wrap -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`.\n" +#: documentation/content/en/articles/committers-guide/_index.adoc:930 +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: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:929 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:933 msgid "" -"Once the cherry-pick is finished, push with `git push`.\n" -"If you get an error due to losing the commit race, use `git pull --rebase` and try to push again.\n" +"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:930 +#: documentation/content/en/articles/committers-guide/_index.adoc:934 #, no-wrap msgid "MFC to RELENG branch" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:934 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:938 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: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:939 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:940 msgid "" -"* Merge or direct commit to the appropriate `stable/X` branch first before merging to the `releng/X.Y` branch.\n" -"* Use the hash that's in the `stable/X` branch for the MFC to `releng/X.Y` branch.\n" -"* Leave both \"cherry picked from\" lines in the commit message.\n" -"* Be sure to add the `Approved by:` line when you are in the editor.\n" +"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:944 -msgid "% git checkout releng/13.0 % git cherry-pick -x $HASH --edit" +#: documentation/content/en/articles/committers-guide/_index.adoc:941 +msgid "" +"Use the hash that's in the `stable/X` branch for the MFC to `releng/X.Y` " +"branch." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:947 -#, no-wrap -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.\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:942 +msgid "Leave both \"cherry picked from\" lines in the commit message." msgstr "" -#. type: Title ==== +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:943 +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 #, no-wrap -msgid "Multiple commit MFC" +msgid "" +"% git checkout releng/13.0\n" +"% git cherry-pick -x $HASH --edit\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:959 +#: documentation/content/en/articles/committers-guide/_index.adoc:951 msgid "" -"% git checkout -b tmp-branch stable/X % for h in $HASH_LIST; do git cherry-" -"pick -x $h; done % git rebase -i stable/X # mark each of the commits after " -"the first as 'squash' # Update the commit message to reflect all elements of " -"commit, if necessary. # Be sure to retain the \"cherry picked from\" " -"lines. % git push freebsd HEAD:stable/X" +"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 +#, no-wrap +msgid "Multiple commit MFC" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:962 +#: documentation/content/en/articles/committers-guide/_index.adoc:963 #, no-wrap -msgid "If the push fails due to losing the commit race, rebase and try again:\n" +msgid "" +"% git checkout -b tmp-branch stable/X\n" +"% for h in $HASH_LIST; do git cherry-pick -x $h; done\n" +"% git rebase -i stable/X\n" +"# mark each of the commits after the first as 'squash'\n" +"# Update the commit message to reflect all elements of commit, if necessary.\n" +"# Be sure to retain the \"cherry picked from\" lines.\n" +"% git push freebsd HEAD:stable/X\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:970 -msgid "" -"% git checkout stable/X % git pull % git checkout tmp-branch % git rebase " -"stable/X % git push freebsd HEAD:stable/X" +#: documentation/content/en/articles/committers-guide/_index.adoc:966 +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:973 +#: documentation/content/en/articles/committers-guide/_index.adoc:974 #, no-wrap -msgid "Once the MFC is complete, you can delete the temporary branch:\n" +msgid "" +"% git checkout stable/X\n" +"% git pull\n" +"% git checkout tmp-branch\n" +"% git rebase stable/X\n" +"% git push freebsd HEAD:stable/X\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:978 -msgid "% git checkout stable/X % git branch -d tmp-branch" +#: documentation/content/en/articles/committers-guide/_index.adoc:977 +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 +#, no-wrap +msgid "" +"% git checkout stable/X\n" +"% git branch -d tmp-branch\n" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:980 +#: documentation/content/en/articles/committers-guide/_index.adoc:984 #, no-wrap msgid "MFC a vendor import" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:985 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:989 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 " @@ -2174,128 +2146,151 @@ msgid "" "`main` (though there may be some exceptions)." msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:989 -msgid "% git cherry-pick -x -m 1 $HASH" -msgstr "" - #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:992 +#: documentation/content/en/articles/committers-guide/_index.adoc:993 #, no-wrap -msgid "" -"is typically what you want.\n" -"This will tell cherry-pick to apply the correct diff.\n" +msgid "% git cherry-pick -x -m 1 $HASH\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:997 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:996 msgid "" -"There are some, hopefully, rare cases where it's possible that the `main` branch was merged backwards by the conversion script.\n" -"Should that be the case (and we've not found any yet), you'd change the above to `-m 2` to pickup the proper parent.\n" -"Just do:\n" -"[source,shell]\n" +"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 -msgid "% git cherry-pick --abort % git cherry-pick -x -m 2 $HASH" +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 " +"case (and we've not found any yet), you'd change the above to `-m 2` to " +"pickup the proper parent. Just do:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1002 +#: documentation/content/en/articles/committers-guide/_index.adoc:1004 #, no-wrap -msgid "to do that. The `--abort` will cleanup the failed first attempt.\n" +msgid "" +"% git cherry-pick --abort\n" +"% git cherry-pick -x -m 2 $HASH\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1006 +msgid "to do that. The `--abort` will cleanup the failed first attempt." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1003 +#: documentation/content/en/articles/committers-guide/_index.adoc:1007 #, no-wrap msgid "Redoing a MFC" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1008 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1011 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: [source,shell]" -msgstr "" - -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1010 -msgid "% git reset --hard freebsd/stable/12" +"the easiest way is to use `git reset --hard` like so:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1013 +#: documentation/content/en/articles/committers-guide/_index.adoc:1014 #, no-wrap +msgid "% git reset --hard freebsd/stable/12\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1017 msgid "" -"though if you have some revs you want to keep, and others you don't,\n" -"using `git rebase -i` is better.\n" +"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:1014 +#: documentation/content/en/articles/committers-guide/_index.adoc:1018 #, no-wrap msgid "Considerations when MFCing" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1017 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1021 msgid "" "When committing source commits to stable and releng branches, we have the " "following goals:" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1021 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1023 msgid "" -"* Clearly mark direct commits distinct from commits that land a change from another branch.\n" -"* Avoid introducing known breakage into stable and releng branches.\n" -"* Allow developers to determine which changes have or have not been landed from one branch to another.\n" +"Clearly mark direct commits distinct from commits that land a change from " +"another branch." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1023 -#, no-wrap -msgid "With Subversion, we used the following practices to achieve these goals:\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1024 +msgid "Avoid introducing known breakage into stable and releng branches." msgstr "" -#. type: delimited block . 4 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1025 +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 -#, no-wrap msgid "" -"* Using `MFC` and `MFS` tags to mark commits that merged changes from another branch.\n" -"* Squashing fixup commits into the main commit when merging a change.\n" -"* Recording mergeinfo so that `svn mergeinfo --show-revs` worked.\n" +"With Subversion, we used the following practices to achieve these goals:" msgstr "" -#. type: delimited block . 4 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1029 +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 +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 -#, no-wrap +msgid "Recording mergeinfo so that `svn mergeinfo --show-revs` worked." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1035 msgid "" -"With Git, we will need to use different strategies to achieve the same goals.\n" -"This document aims to define best practices when merging source commits using Git that achieve these goals.\n" -"In general, we aim to use Git's native support to achieve these goals rather than enforcing practices built on Subversion's model.\n" +"With Git, we will need to use different strategies to achieve the same " +"goals. This document aims to define best practices when merging source " +"commits using Git that achieve these goals. In general, we aim to use Git's " +"native support to achieve these goals rather than enforcing practices built " +"on Subversion's model." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1034 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1038 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 branches.\n" -"Instead, when this document refers to \"merge commits\", it means a commit originally made to `main` that is replicated or \"landed\" to a stable branch, or a commit from a stable branch that is replicated to a releng branch with some variation of `git cherry-pick`.\n" +"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 " +"branches. Instead, when this document refers to \"merge commits\", it means " +"a commit originally made to `main` that is replicated or \"landed\" to a " +"stable branch, or a commit from a stable branch that is replicated to a " +"releng branch with some variation of `git cherry-pick`." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1035 +#: documentation/content/en/articles/committers-guide/_index.adoc:1039 #, no-wrap msgid "Finding Eligible Hashes to MFC" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1041 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1045 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 " @@ -2309,42 +2304,45 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1042 +#: documentation/content/en/articles/committers-guide/_index.adoc:1046 #, no-wrap msgid "Commit message standards" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1043 +#: documentation/content/en/articles/committers-guide/_index.adoc:1047 #, no-wrap msgid "Marking MFCs" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1046 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1050 msgid "The project has adopted the following practice for marking MFCs:" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1048 -#, no-wrap -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 is added by Git directly, committers do not have to manually edit the commit log when merging.\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1052 +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 " +"is added by Git directly, committers do not have to manually edit the commit " +"log when merging." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1050 -#, no-wrap -msgid "When merging multiple commits, keep all the \"cherry picked from\" lines.\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1054 +msgid "" +"When merging multiple commits, keep all the \"cherry picked from\" lines." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1051 +#: documentation/content/en/articles/committers-guide/_index.adoc:1055 #, no-wrap msgid "Trim Metadata?" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1055 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1059 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 " @@ -2352,8 +2350,8 @@ msgid "" "reflect information about the MFC commit itself?" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1064 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1068 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 " @@ -2371,8 +2369,8 @@ msgid "" "guidelines can be agreed upon." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1068 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1072 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 " @@ -2381,15 +2379,15 @@ msgid "" "MFC commits such as Phabricator URLs for use by re@ in the future." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1071 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1075 msgid "" "Preserving existing metadata provides a very simple workflow. Developers " "use `git cherry-pick -x` without having to edit the log message." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1074 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1078 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 " @@ -2398,66 +2396,61 @@ msgid "" "without having to re-enter the entire commit message." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1076 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1080 msgid "" "The bottom line is that developers will likely need to curate their commit " "message for MFCs that are non-trivial." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1078 -msgid "[[vendor-import-git]]" -msgstr "" - #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:1078 +#: documentation/content/en/articles/committers-guide/_index.adoc:1082 #, no-wrap msgid "Vendor Imports with Git" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1081 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1085 msgid "This section describes the vendor import procedure with Git in detail." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1082 +#: documentation/content/en/articles/committers-guide/_index.adoc:1086 #, no-wrap msgid "Branch naming convention" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1085 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1089 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:1091 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1094 msgid "" -"[NOTE] ==== This chapter follows the convention that the `freebsd` origin is " -"the origin name for the official FreeBSD Git repository. If you use a " -"different convention, replace `freebsd` with the name you use instead in the " -"examples below. ====" +"This chapter follows the convention that the `freebsd` origin is the origin " +"name for the official FreeBSD Git repository. If you use a different " +"convention, replace `freebsd` with the name you use instead in the examples " +"below." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1094 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1098 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:1095 +#: documentation/content/en/articles/committers-guide/_index.adoc:1099 #, no-wrap msgid "Updating an old vendor import" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1101 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1105 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 " @@ -2466,26 +2459,27 @@ msgid "" "(the `../mtree`) does not currently exist." msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1105 -msgid "% git worktree add ../mtree vendor/NetBSD/mtree" +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1109 +#, no-wrap +msgid "% git worktree add ../mtree vendor/NetBSD/mtree\n" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1107 +#: documentation/content/en/articles/committers-guide/_index.adoc:1111 #, no-wrap msgid "Update the Sources in the Vendor Branch" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1110 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1114 msgid "" "Prepare a full, clean tree of the vendor sources. Import everything but " "merge only what is needed." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1114 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1118 msgid "" "This example assumes the NetBSD source is checked out from their GitHub " "mirror in `~/git/NetBSD`. Note that \"upstream\" might have added or " @@ -2493,8 +2487,8 @@ msgid "" "package:net/rsync[] is commonly installed, so I'll use that." msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1128 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1132 #, no-wrap msgid "" "% cd ../mtree\n" @@ -2510,87 +2504,86 @@ msgid "" "% git tag -a vendor/NetBSD/mtree/20201211\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1141 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1145 msgid "" -"It is critical to verify that the source code you are importing comes from a\n" -"trustworthy source. Many open-source projects use cryptographic signatures to\n" -"sign code changes, git tags, and/or source code tarballs. Always verify these\n" -"signatures, and use isolation mechanisms like jails, chroot, in combination with\n" -"a dedicated, non-privileged user account that is different from the one you\n" -"regularly use (see the Updating the FreeBSD source tree section below for\n" -"more details), until you are confident that the source code you are importing\n" -"looks safe. Following the upstream development and occasionally reviewing the\n" -"upstream code changes can greatly help in improving code quality and benefit\n" -"everyone involved. It is also a good idea to examine the git diff results\n" -"before importing them into the vendor area.\n" +"It is critical to verify that the source code you are importing comes from a " +"trustworthy source. Many open-source projects use cryptographic signatures " +"to sign code changes, git tags, and/or source code tarballs. Always verify " +"these signatures, and use isolation mechanisms like jails, chroot, in " +"combination with a dedicated, non-privileged user account that is different " +"from the one you regularly use (see the Updating the FreeBSD source tree " +"section below for more details), until you are confident that the source " +"code you are importing looks safe. Following the upstream development and " +"occasionally reviewing the upstream code changes can greatly help in " +"improving code quality and benefit everyone involved. It is also a good idea " +"to examine the git diff results before importing them into the vendor area." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1145 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1149 msgid "" -"Always run the `git diff` and `git status` commands and examine the results\n" -"carefully. When in doubt, it is useful to do a `git annotate` on the vendor\n" -"branch or the upstream git repository to see who and why a change was made.\n" +"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 " +"branch or the upstream git repository to see who and why a change was made." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1148 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1152 msgid "" -"In the example above we used `-m` to illustrate, but you should compose a\n" -"proper message in an editor (using a commit message template).\n" +"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: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1153 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1157 msgid "" -"It is also important to create an annotated tag using `git tag -a`, otherwise the push will be rejected.\n" -"Only annotated tags are allowed to be pushed.\n" -"The annotated tag gives you a chance to enter a commit message.\n" -"Enter the version you are importing, along with any salient new features or fixes in that version.\n" +"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 " +"pushed. The annotated tag gives you a chance to enter a commit message. " +"Enter the version you are importing, along with any salient new features or " +"fixes in that version." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1154 +#: documentation/content/en/articles/committers-guide/_index.adoc:1158 #, no-wrap msgid "Updating the FreeBSD Copy" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1157 -msgid "At this point you can push the import to `vendor` into our repo." -msgstr "" - #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1161 -msgid "% git push --follow-tags freebsd vendor/NetBSD/mtree" +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:1164 +#: documentation/content/en/articles/committers-guide/_index.adoc:1165 #, no-wrap -msgid "`--follow-tags` tells `git push` to also push tags associated with the locally committed revision.\n" +msgid "% git push --follow-tags freebsd vendor/NetBSD/mtree\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1168 +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:1165 +#: documentation/content/en/articles/committers-guide/_index.adoc:1169 #, no-wrap msgid "Updating the FreeBSD source tree" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1169 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1173 msgid "" "Now you need to update the mtree in FreeBSD. The sources live in `contrib/" "mtree` since it is upstream software." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1175 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1179 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 " @@ -2599,115 +2592,191 @@ msgid "" "when importing updates." msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1180 -msgid "% cd ../src % git subtree merge -P contrib/mtree vendor/NetBSD/mtree" -msgstr "" - #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1190 +#: documentation/content/en/articles/committers-guide/_index.adoc:1184 #, no-wrap msgid "" -"This would generate a subtree merge commit of `contrib/mtree` against the local `vendor/NetBSD/mtree` branch.\n" -"Examine the diff from the merge result and the contents of the\n" -"upstream branch. If the merge reduced our local changes to more\n" -"trivial difference like blank line or indenting changes, try amending\n" -"the local changes to reduce diff against upstream, or try to\n" -"contribute the remaining changes back to the upstream project.\n" -"If there were conflicts, you would need to fix them before committing.\n" -"Include details about the changes being merged in the merge commit message.\n" +"% cd ../src\n" +"% git subtree merge -P contrib/mtree vendor/NetBSD/mtree\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1204 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1194 msgid "" -"Some open-source software includes a `configure` script that generates files\n" -"used to define how the code is built; usually, these generated files like\n" -"`config.h` should be updated as part of the import process. When doing\n" -"this, always keep in mind that these scripts are executable code running\n" -"under the current user's credentials. This process should always be run\n" -"in an isolated environment, ideally inside a jail that does not have\n" -"network access, and with an unprivileged account; or, at minimum, a\n" -"dedicated account that is different from the user account you normally\n" -"use for everyday purposes or for pushing to the FreeBSD source\n" -"code repository. This minimizes the risk of encountering bugs that can\n" -"cause data loss or, in worse cases, maliciously planted code. Using an\n" -"isolated jail also prevents the configure scripts from detecting locally\n" -"installed software packages, which may lead to unexpected results.\n" +"This would generate a subtree merge commit of `contrib/mtree` against the " +"local `vendor/NetBSD/mtree` branch. Examine the diff from the merge result " +"and the contents of the upstream branch. If the merge reduced our local " +"changes to more trivial difference like blank line or indenting changes, try " +"amending the local changes to reduce diff against upstream, or try to " +"contribute the remaining changes back to the upstream project. If there " +"were conflicts, you would need to fix them before committing. Include " +"details about the changes being merged in the merge commit message." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1211 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1208 +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 " +"`config.h` should be updated as part of the import process. When doing this, " +"always keep in mind that these scripts are executable code running under the " +"current user's credentials. This process should always be run in an isolated " +"environment, ideally inside a jail that does not have network access, and " +"with an unprivileged account; or, at minimum, a dedicated account that is " +"different from the user account you normally use for everyday purposes or " +"for pushing to the FreeBSD source code repository. This minimizes the risk " +"of encountering bugs that can cause data loss or, in worse cases, " +"maliciously planted code. Using an isolated jail also prevents the configure " +"scripts from detecting locally installed software packages, which may lead " +"to unexpected results." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1215 msgid "" -"When testing your changes, run them in a chroot or jailed environment,\n" -"or even within a virtual machine first, especially for kernel or library\n" -"modifications. This approach helps prevent adverse interactions with\n" -"your working environment. It can be particularly beneficial for\n" -"changes to libraries that many base system components use,\n" -"among others.\n" +"When testing your changes, run them in a chroot or jailed environment, or " +"even within a virtual machine first, especially for kernel or library " +"modifications. This approach helps prevent adverse interactions with your " +"working environment. It can be particularly beneficial for changes to " +"libraries that many base system components use, among others." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1212 +#: documentation/content/en/articles/committers-guide/_index.adoc:1216 #, no-wrap msgid "Rebasing your change against latest FreeBSD source tree" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1215 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1219 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 " "to redo the merge." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1218 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1222 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 " "recreate the commit." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1220 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1224 msgid "" "The following steps should be taken to easily recreate the merge commit as " "if `git rebase --merge-commits` worked properly:" msgstr "" -#. type: delimited block . 4 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1226 +msgid "cd to the top of the repo" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1227 +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 +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 +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 +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 +msgid "checkout `main`" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1232 +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 +msgid "Re-do the subtree merge" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1234 +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 +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 +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 -#, no-wrap msgid "" -"* cd to the top of the repo\n" -"* Create a side branch `XXX` with the **contents** of the merged tree.\n" -"* Update this side branch `XXX` to be merged and up-to-date with FreeBSD's `main` branch.\n" -"** In the worst case scenario, you would still have to resolve merge conflicts, if there was any, but this should be really rare.\n" -"** Resolve conflicts, and collapse multiple commits down to 1 if need be (without conflicts, there's no collapse needed)\n" -"* checkout `main`\n" -"* create a branch `YYY` (allows for easier unwinding if things go wrong)\n" -"* Re-do the subtree merge\n" -"* Instead of resolving any conflicts from the subtree merge, checkout the contents of XXX on top of it.\n" -"** The trailing `.` is important, as is being at the top level of the repo.\n" -"** Rather than switching branches to XXX, it splats the contents of XXX on top of the repo\n" -"* Commit the results with the prior commit message (the example assumes there's only one merge on the XXX branch).\n" -"* Make sure the branches are the same.\n" -"* Do whatever review you need, including having others check it out if you think that's needed.\n" -"* Push the commit, if you 'lost the race' again, just redo these steps again (see below for a recipe)\n" -"* Delete the branches once the commit is upstream. They are throw-a-way.\n" +"Commit the results with the prior commit message (the example assumes " +"there's only one merge on the XXX branch)." msgstr "" -#. type: delimited block . 4 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1238 +msgid "Make sure the branches are the same." +msgstr "" + +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1239 -#, no-wrap -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 above):\n" +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:1252 +#: documentation/content/en/articles/committers-guide/_index.adoc:1240 +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 +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 +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 " +"above):" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1256 #, no-wrap msgid "" "% cd ../src\t\t\t# CD to top of tree\n" @@ -2722,29 +2791,27 @@ msgid "" "% git show YYY\t\t\t# Should only have changes you want, and be a merge commit from vendor branch\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1256 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1259 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:\n" -"[source,shell]\n" +"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: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1258 -msgid "" -"% git checkout -B YYY freebsd/main # Create new throw-away YYY branch if " -"starting over is just going to be easier" +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1262 +#, 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:1260 +#: documentation/content/en/articles/committers-guide/_index.adoc:1264 #, no-wrap msgid "Pushing the changes" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1265 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1269 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 " @@ -2754,71 +2821,73 @@ msgid "" "they will eventually appear in the repository." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1267 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1271 msgid "" "After review, when you are sure it is a good change, you can push it to the " "FreeBSD repo:" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1273 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1277 +#, no-wrap msgid "" -"% git push freebsd YYY:main\t# put the commit on upstream's 'main' branch % " -"git branch -D XXX\t\t# Throw away the throw-a-way branches. % git branch -D " -"YYY" +"% git push freebsd YYY:main\t# put the commit on upstream's 'main' branch\n" +"% git branch -D XXX\t\t# Throw away the throw-a-way branches.\n" +"% git branch -D YYY\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1280 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1284 msgid "" -"Note: I used `XXX` and `YYY` to make it obvious they are terrible names and should not leave your machine.\n" -"If you use such names for other work, then you'll need to pick different names, or risk losing the other work.\n" -"There is nothing magic about these names.\n" -"Upstream will not allow you to push them, but never the less, please pay attention to the exact commands above.\n" -"Some commands use syntax that differs only slightly from typical uses and that different behavior is critical to this recipe working.\n" +"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 " +"you'll need to pick different names, or risk losing the other work. There " +"is nothing magic about these names. Upstream will not allow you to push " +"them, but never the less, please pay attention to the exact commands above. " +"Some commands use syntax that differs only slightly from typical uses and " +"that different behavior is critical to this recipe working." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1281 +#: documentation/content/en/articles/committers-guide/_index.adoc:1285 #, no-wrap msgid "How to redo things if need be" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1285 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1289 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 " "commit with the commit message always at XXX~1 to make committing easier." msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1294 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1298 +#, no-wrap msgid "" -"% git checkout -B XXX YYY\t# recreate that throw-away-branch XXX and switch " -"to it % git merge freebsd/main\t# Merge the changes and resolve conflicts % " -"git checkout -B YYY freebsd/main # Recreate new throw-away YYY branch for " -"redo % git subtree merge -P contrib/mtree vendor/NetBSD/mtree # Redo subtree " -"merge % git checkout XXX .\t\t# XXX branch has the conflict resolution % git " -"commit -c XXX~1\t\t# -c reuses the commit message from commit before rebase" +"% git checkout -B XXX YYY\t# recreate that throw-away-branch XXX and switch to it\n" +"% git merge freebsd/main\t# Merge the changes and resolve conflicts\n" +"% git checkout -B YYY freebsd/main # Recreate new throw-away YYY branch for redo\n" +"% git subtree merge -P contrib/mtree vendor/NetBSD/mtree # Redo subtree merge\n" +"% git checkout XXX .\t\t# XXX branch has the conflict resolution\n" +"% git commit -c XXX~1\t\t# -c reuses the commit message from commit before rebase\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1297 -#, no-wrap -msgid "Then go check it out as above and push as above when ready.\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1301 +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:1298 +#: documentation/content/en/articles/committers-guide/_index.adoc:1302 #, no-wrap msgid "Creating a new vendor branch" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1305 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1309 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 " @@ -2829,142 +2898,172 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1306 +#: documentation/content/en/articles/committers-guide/_index.adoc:1310 #, no-wrap msgid "Create the repo" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1315 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1319 +#, no-wrap msgid "" -"% cd /some/where % mkdir glorbnitz % cd glorbnitz % git init % git checkout " -"-b vendor/glorbnitz" +"% cd /some/where\n" +"% mkdir glorbnitz\n" +"% cd glorbnitz\n" +"% git init\n" +"% git checkout -b vendor/glorbnitz\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1318 -#, no-wrap -msgid "At this point, you have a new repo, where all new commits will go on the `vendor/glorbnitz` branch.\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1322 +msgid "" +"At this point, you have a new repo, where all new commits will go on the " +"`vendor/glorbnitz` branch." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1320 -#, no-wrap -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.\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1324 +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:1321 +#: documentation/content/en/articles/committers-guide/_index.adoc:1325 #, no-wrap msgid "Copy the sources in" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1325 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1329 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 " "files." msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1330 -msgid "% cp -r ~/glorbnitz/* . % git add *" -msgstr "" - #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1333 +#: documentation/content/en/articles/committers-guide/_index.adoc:1334 #, no-wrap -msgid "At this point, you should have a pristine copy of glorbnitz ready to commit.\n" +msgid "" +"% cp -r ~/glorbnitz/* .\n" +"% git add *\n" msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1337 -msgid "% git commit -m \"Import GlorbNitz frobnosticator revision 3.1415\"" +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:1342 +#: documentation/content/en/articles/committers-guide/_index.adoc:1341 #, 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 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.\n" -"Not everybody will know so, for your actual commit, you should follow the\n" -"crossref:committers-guide[commit-log-message,commit log message] section instead of emulating the brief style used here.\n" +"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. " +"Not everybody will know so, for your actual commit, you should follow the " +"crossref:committers-guide[commit-log-message,commit log message] section " +"instead of emulating the brief style used here." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1343 +#: documentation/content/en/articles/committers-guide/_index.adoc:1347 #, no-wrap msgid "Now import it into our repository" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1346 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1350 msgid "Now you need to import the branch into our repository." msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1352 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1356 +#, no-wrap msgid "" -"% cd /path/to/freebsd/repo/src % git remote add glorbnitz /some/where/" -"glorbnitz % git fetch glorbnitz vendor/glorbnitz" +"% cd /path/to/freebsd/repo/src\n" +"% git remote add glorbnitz /some/where/glorbnitz\n" +"% git fetch glorbnitz vendor/glorbnitz\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1357 -#, no-wrap +#. perhaps the real treasure was the friends it made along the way... +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1360 msgid "" -"Note the vendor/glorbnitz branch is in the repo. At this point the `/some/where/glorbnitz` can be deleted, if you like.\n" -"It was only a means to an end.\n" -"// perhaps the real treasure was the friends it made along the way...\n" +"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:1358 +#: documentation/content/en/articles/committers-guide/_index.adoc:1362 #, no-wrap msgid "Tag and push" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1361 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1365 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: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1369 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1373 +#, no-wrap msgid "" -"% git worktree add ../glorbnitz vendor/glorbnitz % cd ../glorbnitz % git tag " -"--annotate vendor/glorbnitz/3.1415 # Make sure the commit is good with \"git " -"show\" % git push --follow-tags freebsd vendor/glorbnitz" +"% git worktree add ../glorbnitz vendor/glorbnitz\n" +"% cd ../glorbnitz\n" +"% git tag --annotate vendor/glorbnitz/3.1415\n" +"# Make sure the commit is good with \"git show\"\n" +"% git push --follow-tags freebsd vendor/glorbnitz\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1372 -#, no-wrap -msgid "By 'good' we mean:\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1376 +msgid "By 'good' we mean:" msgstr "" -#. type: delimited block . 4 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1378 -#, no-wrap +msgid "All the right files are present" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1379 +msgid "None of the wrong files are present" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1380 +msgid "The vendor branch points at something sensible" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1381 +msgid "The tag looks good, and is annotated" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1382 msgid "" -". All the right files are present\n" -". None of the wrong files are present\n" -". The vendor branch points at something sensible\n" -". The tag looks good, and is annotated\n" -". The commit message for the tag has a quick summary of what's new since the last tag\n" +"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:1379 +#: documentation/content/en/articles/committers-guide/_index.adoc:1383 #, no-wrap msgid "Time to finally merge it into the base tree" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1388 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1392 #, no-wrap msgid "" "% cd ../src\n" @@ -2974,41 +3073,54 @@ msgid "" "% git push freebsd\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1391 -#, no-wrap -msgid "Here 'good' means:\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1395 +msgid "Here 'good' means:" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1396 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1397 msgid "" -". All the right files, and none of the wrong ones, were merged into contrib/glorbnitz.\n" -". No other changes are in the tree.\n" -". 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 FreeBSD `main` branch and any caveats.\n" -". UPDATING should be updated if there is anything of note, such as user visible changes, important upgrade concerns, etc.\n" +"All the right files, and none of the wrong ones, were merged into contrib/" +"glorbnitz." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1402 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1398 +msgid "No other changes are in the tree." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1399 +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 " +"FreeBSD `main` branch and any caveats." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1400 +msgid "" +"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 msgid "" -"[NOTE]\n" -"====\n" -"This hasn't connected `glorbnitz` to the build yet.\n" -"How so do that is specific to the software being imported and is beyond the scope of this tutorial.\n" -"====\n" +"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 " +"tutorial." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1403 +#: documentation/content/en/articles/committers-guide/_index.adoc:1407 #, no-wrap msgid "Keeping current" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1409 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1413 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 " @@ -3016,281 +3128,282 @@ msgid "" "the following." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1412 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1416 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 " "pull --rebase` is useful if you have changes staged in the `main` branch." msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1416 -msgid "% git config --global pull.ff only" -msgstr "" - #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1419 +#: documentation/content/en/articles/committers-guide/_index.adoc:1420 #, no-wrap -msgid "You may need to omit the --global if you want this setting to apply to only this repository.\n" +msgid "% git config --global pull.ff only\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1425 -msgid "% cd freebsd-src % git checkout main % git pull (--ff-only|--rebase)" +#: documentation/content/en/articles/committers-guide/_index.adoc:1423 +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 #, no-wrap 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 exist before.\n" -"This can be harder to recover from.\n" +"% cd freebsd-src\n" +"% git checkout main\n" +"% git pull (--ff-only|--rebase)\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1431 -#, no-wrap -msgid "The longer form is also recommended.\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1433 +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 " +"exist before. This can be harder to recover from." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1438 -msgid "" -"% cd freebsd-src % git checkout main % git fetch freebsd % git merge --ff-" -"only freebsd/main" +#: documentation/content/en/articles/committers-guide/_index.adoc:1435 +msgid "The longer form is also recommended." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1443 +#: documentation/content/en/articles/committers-guide/_index.adoc:1442 #, no-wrap msgid "" -"These commands reset your tree to the `main` branch, and then update it from where you pulled the tree from originally.\n" -"It's important to switch to `main` before doing this so it moves forward.\n" -"Now, it's time to move the changes forward:\n" +"% cd freebsd-src\n" +"% git checkout main\n" +"% git fetch freebsd\n" +"% git merge --ff-only freebsd/main\n" msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1447 -msgid "% git rebase -i main working" +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 " +"`main` before doing this so it moves forward. Now, it's time to move the " +"changes forward:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1454 +#: documentation/content/en/articles/committers-guide/_index.adoc:1451 #, no-wrap -msgid "" -"This will bring up an interactive screen to change the defaults.\n" -"For now, just exit the editor.\n" -"Everything should just apply.\n" -"If not, then you'll need to resolve the diffs.\n" -"https://docs.github.com/en/free-pro-team@latest/github/using-git/resolving-merge-conflicts-after-a-git-rebase[This github document] can help you navigate this process.\n" +msgid "% git rebase -i main working\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1456 -#, no-wrap -msgid "[[git-push-upstream]]\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1458 +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 " +"need to resolve the diffs. https://docs.github.com/en/free-pro-team@latest/" +"github/using-git/resolving-merge-conflicts-after-a-git-rebase[This github " +"document] can help you navigate this process." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1456 +#: documentation/content/en/articles/committers-guide/_index.adoc:1460 #, no-wrap msgid "Time to push changes upstream" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1459 -msgid "" -"First, ensure that the push URL is properly configured for the upstream " -"repository." -msgstr "" - #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1463 msgid "" -"% git remote set-url --push freebsd ssh://git@gitrepo.freebsd.org/src.git" +"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 #, no-wrap -msgid "" -"Then, verify that user name and email are configured right.\n" -"We require that they exactly match the passwd entry in FreeBSD cluster.\n" +msgid "% git remote set-url --push freebsd ssh://git@gitrepo.freebsd.org/src.git\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1469 -#, no-wrap -msgid "Use\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1471 +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 -msgid "freefall% gen-gitconfig.sh" +msgid "Use" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1476 +#: documentation/content/en/articles/committers-guide/_index.adoc:1477 #, no-wrap -msgid "on freefall.freebsd.org to get a recipe that you can use directly, assuming /usr/local/bin is in the PATH.\n" +msgid "freefall% gen-gitconfig.sh\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1481 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1480 msgid "" -"The below command merges the `working` branch into the upstream `main` branch.\n" -"It's important that you curate your changes to be just like you want them in the FreeBSD source repo before doing this.\n" -"This syntax pushes the `working` branch to `main`, moving the `main` branch forward.\n" -"You will only be able to do this if this results in a linear change to `main` (e.g. no merges).\n" +"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 -msgid "% git push freebsd working:main" +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 " +"want them in the FreeBSD source repo before doing this. This syntax pushes " +"the `working` branch to `main`, moving the `main` branch forward. You will " +"only be able to do this if this results in a linear change to `main` (e.g. " +"no merges)." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1488 +#: documentation/content/en/articles/committers-guide/_index.adoc:1489 #, no-wrap -msgid "If your push is rejected due to losing a commit race, rebase your branch before trying again:\n" +msgid "% git push freebsd working:main\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1495 +#: documentation/content/en/articles/committers-guide/_index.adoc:1492 msgid "" -"% git checkout working % git fetch freebsd % git rebase freebsd/main % git " -"push freebsd working:main" +"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:1498 +#: documentation/content/en/articles/committers-guide/_index.adoc:1499 #, no-wrap -msgid "[[git-push-upstream-alt]]\n" +msgid "" +"% git checkout working\n" +"% git fetch freebsd\n" +"% git rebase freebsd/main\n" +"% git push freebsd working:main\n" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1498 +#: documentation/content/en/articles/committers-guide/_index.adoc:1502 #, no-wrap msgid "Time to push changes upstream (alternative)" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1504 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1507 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 " "changes from a branch to the local `main` when you need to do a subset of a " -"branch. The instructions are similar to the prior section: [source,shell]" -msgstr "" - -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1508 -msgid "% git checkout main % git merge --ff-only `working` % git push freebsd" +"branch. The instructions are similar to the prior section:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:1512 #, no-wrap msgid "" -"If you lose the race, then try again with\n" -"[source,shell]\n" +"% git checkout main\n" +"% git merge --ff-only `working`\n" +"% git push freebsd\n" msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1515 -msgid "% git pull --rebase % git push freebsd" +msgid "If you lose the race, then try again with" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1518 +#: documentation/content/en/articles/committers-guide/_index.adoc:1519 #, no-wrap 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 the commit race.\n" -"Note: merging vendor branch commits will not work with this technique.\n" +"% git pull --rebase\n" +"% git push freebsd\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1522 +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 " +"the commit race. Note: merging vendor branch commits will not work with " +"this technique." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1519 +#: documentation/content/en/articles/committers-guide/_index.adoc:1523 #, no-wrap msgid "Finding the Subversion Revision" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1523 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1527 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 " "you have these, notes will show up in the git log command like so:" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1527 -msgid "% git log" -msgstr "" - #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1530 +#: documentation/content/en/articles/committers-guide/_index.adoc:1531 #, no-wrap -msgid "If you have a specific version in mind, you can use this construct:\n" +msgid "% git log\n" msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1534 -msgid "% git log --grep revision=XXXX" +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 #, no-wrap -msgid "" -"to find the specific revision.\n" -"The hex number after 'commit' is the hash you can use to refer to this commit.\n" +msgid "% git log --grep revision=XXXX\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1540 -#, no-wrap -msgid "[[git-faq]]\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1542 +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:1540 +#: documentation/content/en/articles/committers-guide/_index.adoc:1544 #, no-wrap msgid "Git FAQ" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1543 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1547 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:1549 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1552 msgid "" -"[NOTE] ==== 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 for their own development and to minimize \"whoops\" " -"pushes to the wrong repository. ====" +"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 " +"for their own development and to minimize \"whoops\" pushes to the wrong " +"repository." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1550 +#: documentation/content/en/articles/committers-guide/_index.adoc:1554 #, no-wrap msgid "Users" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1552 +#: documentation/content/en/articles/committers-guide/_index.adoc:1556 #, no-wrap msgid "How do I track -current and -stable with only one copy of the repository?" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1557 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1561 #, 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" @@ -3298,8 +3411,8 @@ msgid "" "How do I do this with Git?\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1561 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1565 #, no-wrap msgid "" "**A:** You can use Git worktrees.\n" @@ -3307,101 +3420,109 @@ msgid "" "While using a 'bare repository' has been put forward as a way to cope, it's more complicated and will not be documented here.\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1564 -#, no-wrap -msgid "" -"First, you need to clone the FreeBSD repository, shown here cloning into `freebsd-current` to reduce confusion.\n" -"$URL is whatever mirror works best for you:\n" -msgstr "" - #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1568 msgid "" -"% git clone -o freebsd --config remote.freebsd.fetch='+refs/notes/*:refs/" -"notes/*' $URL freebsd-current" +"First, you need to clone the FreeBSD repository, shown here cloning into " +"`freebsd-current` to reduce confusion. $URL is whatever mirror works best " +"for you:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1571 +#: documentation/content/en/articles/committers-guide/_index.adoc:1572 #, no-wrap -msgid "then once that's cloned, you can simply create a worktree from it:\n" +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:1576 -msgid "% cd freebsd-current % git worktree add ../freebsd-stable-12 stable/12" +#: documentation/content/en/articles/committers-guide/_index.adoc:1575 +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 #, no-wrap msgid "" -"this will checkout `stable/12` into a directory named `freebsd-stable-12` that's a peer to the `freebsd-current` directory.\n" -"Once created, it's updated very similarly to how you might expect:\n" +"% cd freebsd-current\n" +"% git worktree add ../freebsd-stable-12 stable/12\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1590 +#: documentation/content/en/articles/committers-guide/_index.adoc:1584 msgid "" -"% cd freebsd-current % git checkout main % git pull --ff-only # changes from " -"upstream now local and current tree updated % cd ../freebsd-stable-12 % git " -"merge --ff-only freebsd/stable/12 # now your stable/12 is up to date too" +"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 " +"updated very similarly to how you might expect:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1593 +#: documentation/content/en/articles/committers-guide/_index.adoc:1594 #, no-wrap -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 tree, forcing a complicated merge rather than a simple one.\n" +msgid "" +"% cd freebsd-current\n" +"% git checkout main\n" +"% git pull --ff-only\n" +"# changes from upstream now local and current tree updated\n" +"% cd ../freebsd-stable-12\n" +"% git merge --ff-only freebsd/stable/12\n" +"# now your stable/12 is up to date too\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1595 -#, no-wrap -msgid "Here's https://adventurist.me/posts/00296[a good writeup] that goes into more detail.\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1597 +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 " +"tree, forcing a complicated merge rather than a simple one." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1599 +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:1596 +#: documentation/content/en/articles/committers-guide/_index.adoc:1600 #, no-wrap msgid "Developers" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1598 +#: documentation/content/en/articles/committers-guide/_index.adoc:1602 #, no-wrap msgid "Ooops! I committed to `main`, instead of another branch." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1601 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1605 #, 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: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1603 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1607 #, no-wrap msgid "**A:** First, don't panic.\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1607 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1611 msgid "" -"Second, don't push.\n" -"In fact, you can fix almost anything if you haven't pushed.\n" -"All the answers in this section assume no push has happened.\n" +"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: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1609 -#, no-wrap -msgid "The following answer assumes you committed to `main` and want to create a branch called `issue`:\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1613 +msgid "" +"The following answer assumes you committed to `main` and want to create a " +"branch called `issue`:" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1615 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1619 #, no-wrap msgid "" "% git checkout -b issue # Create the 'issue' branch\n" @@ -3410,21 +3531,21 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1617 +#: documentation/content/en/articles/committers-guide/_index.adoc:1621 #, no-wrap msgid "Ooops! I committed something to the wrong branch!" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1621 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1625 #, 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" "What do I do?\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1625 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1629 #, no-wrap msgid "" "**A:** The answer is similar to the previous one, but with cherry picking.\n" @@ -3432,23 +3553,26 @@ msgid "" "It also assumes that it's the last commit on wilma (hence using wilma in the `git cherry-pick` command), but that too can be generalized.\n" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1633 -msgid "" -"# We're on branch wilma % git checkout fred\t\t# move to fred branch % git " -"cherry-pick wilma\t\t# copy the misplaced commit % git checkout wilma\t\t# " -"go back to wilma branch % git reset --hard HEAD^\t# move what wilma refers " -"to back 1 commit" -msgstr "" - #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1636 +#: documentation/content/en/articles/committers-guide/_index.adoc:1637 #, no-wrap -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.\n" +msgid "" +"# We're on branch wilma\n" +"% git checkout fred\t\t# move to fred branch\n" +"% git cherry-pick wilma\t\t# copy the misplaced commit\n" +"% git checkout wilma\t\t# go back to wilma branch\n" +"% git reset --hard HEAD^\t# move what wilma refers to back 1 commit\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1643 +#: documentation/content/en/articles/committers-guide/_index.adoc:1640 +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 #, no-wrap msgid "" "# We're on branch wilma\n" @@ -3457,14 +3581,14 @@ msgid "" "% git rebase -i main wilma\t\t# drop the cherry-picked change\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1646 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1650 #, 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: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1652 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1656 #, 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" @@ -3474,14 +3598,14 @@ msgid "" "There's no need to switch back to wilma to adjust it: just rebase!\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1654 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1658 #, no-wrap msgid "**Q:** I want to split off some changes from branch `wilma` into branch `fred`\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1660 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1664 #, no-wrap msgid "" "**A:** The more general answer would be the same as the previous.\n" @@ -3491,34 +3615,37 @@ msgid "" "If not, you'll need to resolve the conflicts as you go.\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1665 -#, no-wrap -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.\n" -"You can then `git rebase -i` both these branches, selecting the changes you want in `fred` or `wilma` by retaining the pick likes, and deleting the rest from the editor.\n" -"Some people would create a tag/branch called `pre-split` before starting in case something goes wrong in the split.\n" -"You can undo it with the following sequence:\n" -msgstr "" - #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1672 +#: documentation/content/en/articles/committers-guide/_index.adoc:1669 msgid "" -"% git checkout pre-split\t# Go back % git branch -D fred\t\t# delete the " -"fred branch % git checkout -B wilma\t\t# reset the wilma branch % git branch " -"-d pre-split\t# Pretend it didn't happen" +"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 " +"rebase -i` both these branches, selecting the changes you want in `fred` or " +"`wilma` by retaining the pick likes, and deleting the rest from the editor. " +"Some people would create a tag/branch called `pre-split` before starting in " +"case something goes wrong in the split. You can undo it with the following " +"sequence:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:1676 #, no-wrap msgid "" -"The last step is optional.\n" -"If you are going to try again to split, you'd omit it.\n" +"% git checkout pre-split\t# Go back\n" +"% git branch -D fred\t\t# delete the fred branch\n" +"% git checkout -B wilma\t\t# reset the wilma branch\n" +"% git branch -d pre-split\t# Pretend it didn't happen\n" msgstr "" -#. type: delimited block . 4 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1680 +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 #, 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" @@ -3526,306 +3653,324 @@ msgid "" "I don't know how many times I moved things around.\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1682 -#, 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: delimited block . 4 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1686 #, no-wrap -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.\n" -"Nothing weird happened when I did that, but let's say it did.\n" -"The way to look at what you've done is with the `git reflog`:\n" +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:1701 +#: documentation/content/en/articles/committers-guide/_index.adoc:1690 msgid "" -"% git reflog 6ff9c25 (HEAD -> wilma) HEAD@{0}: rebase -i (finish): returning " -"to refs/heads/wilma 6ff9c25 (HEAD -> wilma) HEAD@{1}: rebase -i (start): " -"checkout main 869cbd3 HEAD@{2}: rebase -i (start): checkout wilma a6a5094 " -"(fred) HEAD@{3}: rebase -i (finish): returning to refs/heads/fred a6a5094 " -"(fred) HEAD@{4}: rebase -i (pick): Encourage contributions 1ccd109 (freebsd/" -"main, main) HEAD@{5}: rebase -i (start): checkout main 869cbd3 HEAD@{6}: " -"rebase -i (start): checkout fred 869cbd3 HEAD@{7}: checkout: moving from " -"wilma to fred 869cbd3 HEAD@{8}: commit: Encourage contributions ... %" +"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 " +"when I did that, but let's say it did. The way to look at what you've done " +"is with the `git reflog`:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1709 +#: documentation/content/en/articles/committers-guide/_index.adoc:1705 #, no-wrap msgid "" -"Here we see the changes I've made.\n" -"You can use it to figure out where things went wrong.\n" -"I'll just point out a few things here.\n" -"The first one is that HEAD@{X} is a 'commitish' thing, so you can use that as an argument to a command.\n" -"Although if that command commits anything to the repository, the X numbers change.\n" -"You can also use the hash (first column).\n" +"% git reflog\n" +"6ff9c25 (HEAD -> wilma) HEAD@{0}: rebase -i (finish): returning to refs/heads/wilma\n" +"6ff9c25 (HEAD -> wilma) HEAD@{1}: rebase -i (start): checkout main\n" +"869cbd3 HEAD@{2}: rebase -i (start): checkout wilma\n" +"a6a5094 (fred) HEAD@{3}: rebase -i (finish): returning to refs/heads/fred\n" +"a6a5094 (fred) HEAD@{4}: rebase -i (pick): Encourage contributions\n" +"1ccd109 (freebsd/main, main) HEAD@{5}: rebase -i (start): checkout main\n" +"869cbd3 HEAD@{6}: rebase -i (start): checkout fred\n" +"869cbd3 HEAD@{7}: checkout: moving from wilma to fred\n" +"869cbd3 HEAD@{8}: commit: Encourage contributions\n" +"...\n" +"%\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1717 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1713 msgid "" -"Next, 'Encourage contributions' was the last commit I made to `wilma` before I decided to split things up.\n" -"You can also see the same hash is there when I created the `fred` branch to do that.\n" -"I started by rebasing `fred` and you see the 'start', each step, and the 'finish' for that process.\n" -"While we don't need it here, you can figure out exactly what happened.\n" -"Fortunately, to fix this, you can follow the prior answer's steps, but with the hash `869cbd3` instead of `pre-split`.\n" -"While that seems a bit verbose, it's easy to remember since you're doing one thing at a time.\n" -"You can also stack:\n" +"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 " +"that HEAD@{X} is a 'commitish' thing, so you can use that as an argument to " +"a command. Although if that command commits anything to the repository, the " +"X numbers change. You can also use the hash (first column)." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1722 -msgid "% git checkout -B wilma 869cbd3 % git branch -D fred" +#: documentation/content/en/articles/committers-guide/_index.adoc:1721 +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 " +"I created the `fred` branch to do that. I started by rebasing `fred` and " +"you see the 'start', each step, and the 'finish' for that process. While we " +"don't need it here, you can figure out exactly what happened. Fortunately, " +"to fix this, you can follow the prior answer's steps, but with the hash " +"`869cbd3` instead of `pre-split`. While that seems a bit verbose, it's easy " +"to remember since you're doing one thing at a time. You can also stack:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1729 +#: documentation/content/en/articles/committers-guide/_index.adoc:1726 #, no-wrap msgid "" -"and you are ready to try again.\n" -"The `checkout -B` with the hash combines checking out and creating a branch for it.\n" -"The `-B` instead of `-b` forces the movement of a pre-existing branch.\n" -"Either way works, which is what's great (and awful) about Git.\n" -"One reason I tend to use `git checkout -B xxxx hash` instead of checking out the hash, and then creating / moving the branch is purely to avoid the slightly distressing message about detached heads:\n" +"% git checkout -B wilma 869cbd3\n" +"% git branch -D fred\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1735 -msgid "% git checkout 869cbd3 M\tfaq.md Note: checking out '869cbd3'." +#: documentation/content/en/articles/committers-guide/_index.adoc:1733 +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 " +"the movement of a pre-existing branch. Either way works, which is what's " +"great (and awful) about Git. One reason I tend to use `git checkout -B xxxx " +"hash` instead of checking out the hash, and then creating / moving the " +"branch is purely to avoid the slightly distressing message about detached " +"heads:" msgstr "" -#. type: Plain text +#. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:1739 +#, no-wrap msgid "" -"You are in 'detached HEAD' state. You can look around, make experimental " -"changes and commit them, and you can discard any commits you make in this " -"state without impacting any branches by performing another checkout." +"% git checkout 869cbd3\n" +"M\tfaq.md\n" +"Note: checking out '869cbd3'.\n" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1742 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1743 +#, no-wrap msgid "" -"If you want to create a new branch to retain commits you create, you may do " -"so (now or later) by using -b with the checkout command again. Example:" -msgstr "" - -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1747 -msgid "HEAD is now at 869cbd3 Encourage contributions % git checkout -B wilma" +"You are in 'detached HEAD' state. You can look around, make experimental\n" +"changes and commit them, and you can discard any commits you make in this\n" +"state without impacting any branches by performing another checkout.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1750 +#: documentation/content/en/articles/committers-guide/_index.adoc:1751 #, no-wrap -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.\n" +msgid "" +"HEAD is now at 869cbd3 Encourage contributions\n" +"% git checkout -B wilma\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1754 +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:1751 +#: documentation/content/en/articles/committers-guide/_index.adoc:1755 #, no-wrap msgid "Ooops! I did a `git pull` and it created a merge commit, what do I do?" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1755 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1759 #, 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" "How do I recover?\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1757 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1761 #, no-wrap msgid "**A:** This can happen when you invoke the pull with your development branch checked out.\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1759 -#, no-wrap -msgid "Many developers use `git pull --rebase` to avoid this situation.\n" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1762 -#, no-wrap -msgid "" -"Right after the pull, you will have the new merge commit checked out.\n" -"Git supports a `HEAD^#` syntax to examine the parents of a merge commit:\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1763 +msgid "Many developers use `git pull --rebase` to avoid this situation." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1767 -#, no-wrap +#: documentation/content/en/articles/committers-guide/_index.adoc:1766 msgid "" -"git log --oneline HEAD^1 # Look at the first parent's commits\n" -"git log --oneline HEAD^2 # Look at the second parent's commits\n" +"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 #, no-wrap msgid "" -"From those logs, you can easily identify which commit is your development work.\n" -"Then you simply reset your branch to the corresponding `HEAD^#`:\n" +"git log --oneline HEAD^1 # Look at the first parent's commits\n" +"git log --oneline HEAD^2 # Look at the second parent's commits\n" msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1775 -msgid "git reset --hard HEAD^1" +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:1778 +#: documentation/content/en/articles/committers-guide/_index.adoc:1779 #, no-wrap -msgid "In addition, a `git pull --rebase` at this stage will rebase your changes to 'main' to the latest 'freebsd/main'.\n" +msgid "git reset --hard HEAD^1\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1780 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1782 +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 #, no-wrap msgid "**Q:** But I also need to fix my `main` branch. How do I do that?\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1783 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1787 #, no-wrap msgid "" "**A:** Git keeps track of the remote repository branches in a `freebsd/` namespace.\n" "To fix your `main` branch, just make it point to the remote's `main`:\n" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1787 -msgid "git branch -f main freebsd/main" -msgstr "" - #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1792 +#: documentation/content/en/articles/committers-guide/_index.adoc:1791 #, no-wrap +msgid "git branch -f main freebsd/main\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1796 msgid "" -"There's nothing magical about branches in Git: they are just labels on a graph that are automatically moved forward by making commits.\n" -"So the above works because you're just moving a label.\n" -"There's no metadata about the branch that needs to be preserved due to this.\n" +"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 " +"works because you're just moving a label. There's no metadata about the " +"branch that needs to be preserved due to this." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1793 +#: documentation/content/en/articles/committers-guide/_index.adoc:1797 #, no-wrap msgid "Mixing and matching branches" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1797 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1801 #, no-wrap msgid "" "**Q:** So I have two branches `worker` and `async` that I'd like to combine into one branch called `feature`\n" "while maintaining the commits in both.\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1799 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1803 #, no-wrap msgid "**A:** This is a job for cherry pick.\n" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1805 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1809 +#, no-wrap msgid "" -"% git checkout worker % git checkout -b feature\t# create a new branch % git " -"cherry-pick main..async\t# bring in the changes" +"% git checkout worker\n" +"% git checkout -b feature\t# create a new branch\n" +"% git cherry-pick main..async\t# bring in the changes\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1810 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1814 msgid "" -"You now have a new branch called `feature`.\n" -"This branch combines commits from both branches.\n" -"You can further curate it with `git rebase`.\n" +"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: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1812 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1816 #, 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: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1815 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1819 #, no-wrap msgid "" "**A:** This takes a little bit of prep work, but `git rebase` will do the heavy\n" "lifting here.\n" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1821 -msgid "" -"% git checkout driver\t\t# Checkout the driver % git checkout -b kernel\t# " -"Create kernel branch % git checkout -b userland\t# Create userland branch" -msgstr "" - #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1826 +#: documentation/content/en/articles/committers-guide/_index.adoc:1825 #, no-wrap msgid "" -"Now you have two identical branches.\n" -"So, it's time to separate out the commits.\n" -"We'll assume first that all the commits in `driver` go into either the `kernel` or the `userland` branch, but not both.\n" +"% git checkout driver\t\t# Checkout the driver\n" +"% git checkout -b kernel\t# Create kernel branch\n" +"% git checkout -b userland\t# Create userland branch\n" msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1830 -msgid "% git rebase -i main kernel" +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 " +"the `kernel` or the `userland` branch, but not both." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1833 +#: documentation/content/en/articles/committers-guide/_index.adoc:1834 #, no-wrap -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 worse, you can throw this all away and start over with the `driver` branch since you've not yet moved it).\n" +msgid "% git rebase -i main kernel\n" msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1837 -msgid "% git rebase -i main userland" +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 " +"worse, you can throw this all away and start over with the `driver` branch " +"since you've not yet moved it)." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1840 +#: documentation/content/en/articles/committers-guide/_index.adoc:1841 #, no-wrap -msgid "and do the same thing you did with the `kernel` branch.\n" +msgid "% git rebase -i main userland\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1843 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1844 +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 #, no-wrap msgid "" "**Q:** Oh great! I followed the above and forgot a commit in the `kernel` branch.\n" "How do I recover?\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1846 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1850 #, no-wrap msgid "" "**A:** You can use the `driver` branch to find the hash of the commit is missing and\n" "cherry pick it.\n" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1852 -msgid "% git checkout kernel % git log driver % git cherry-pick $HASH" +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1856 +#, no-wrap +msgid "" +"% git checkout kernel\n" +"% git log driver\n" +"% git cherry-pick $HASH\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1858 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1862 #, no-wrap msgid "" "**Q:** OK. I have the same situation as the above, but my commits are all mixed up.\n" @@ -3834,81 +3979,84 @@ msgid "" "Your rebase method to select sounds tricky.\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1861 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1865 #, no-wrap msgid "" "**A:** In this situation, you'd be better off to curate the original branch to separate\n" "out the commits, and then use the above method to split the branch.\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1866 -#, no-wrap -msgid "" -"So let's assume that there's just one commit with a clean tree.\n" -"You can either use `git rebase` with an `edit` line, or you can use this with the commit on the tip.\n" -"The steps are the same either way.\n" -"The first thing we need to do is to back up one commit while leaving the changes uncommitted in the tree:\n" -msgstr "" - #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1870 -msgid "% git reset HEAD^" +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 " +"commit on the tip. The steps are the same either way. The first thing we " +"need to do is to back up one commit while leaving the changes uncommitted in " +"the tree:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1873 +#: documentation/content/en/articles/committers-guide/_index.adoc:1874 #, no-wrap -msgid "Note: Do not, repeat do not, add `--hard` here since that also removes the changes from your tree.\n" +msgid "% git reset HEAD^\n" msgstr "" -#. type: delimited block . 4 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1877 -#, no-wrap msgid "" -"Now, if you are lucky, the change needing to be split up falls entirely along file lines.\n" -"In that case you can just do the usual `git add` for the files in each group than do a `git commit`.\n" -"Note: when you do this, you'll lose the commit message when you do the reset, so if you need it for some reason, you should save a copy (though `git log $HASH` can recover it).\n" +"Note: Do not, repeat do not, add `--hard` here since that also removes the " +"changes from your tree." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1880 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1881 msgid "" -"If you are not lucky, you'll need to split apart files.\n" -"There's another tool to do that which you can apply one file at a time.\n" +"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 " +"files in each group than do a `git commit`. Note: when you do this, you'll " +"lose the commit message when you do the reset, so if you need it for some " +"reason, you should save a copy (though `git log $HASH` can recover it)." msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1884 -msgid "git add -i foo/bar.c" +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:1890 +#: documentation/content/en/articles/committers-guide/_index.adoc:1888 #, no-wrap +msgid "git add -i foo/bar.c\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1894 msgid "" -"will step through the diffs, prompting you, one at time, whether to include or exclude the hunk.\n" -"Once you're done, `git commit` and you'll have the remainder in your tree.\n" -"You can run it multiple times as well, and even over multiple files (though I find it easier to do one file at a time\n" -"and use the `git rebase -i` to fold the related commits together).\n" +"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 " +"remainder in your tree. You can run it multiple times as well, and even " +"over multiple files (though I find it easier to do one file at a time and " +"use the `git rebase -i` to fold the related commits together)." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1891 +#: documentation/content/en/articles/committers-guide/_index.adoc:1895 #, no-wrap msgid "Joining the FreeBSD GitHub oranization." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1894 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1898 #, no-wrap msgid "**Q:** How do I join the FreeBSD GitHub organization?\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1898 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1902 #, no-wrap msgid "" "**A:** Please see https://wiki.freebsd.org/GitHub#Joining_the_Organisation[our GitHub Wiki Info] page for details.\n" @@ -3917,140 +4065,146 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1899 +#: documentation/content/en/articles/committers-guide/_index.adoc:1903 #, no-wrap msgid "Cloning and Mirroring" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1902 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1906 #, no-wrap msgid "**Q:** I'd like to mirror the entire Git repository, how do I do that?\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1904 -#, no-wrap -msgid "**A:** If all you want to do is mirror, then\n" -msgstr "" - #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1908 -msgid "% git clone --mirror $URL" +#, 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 #, no-wrap -msgid "" -"will do the trick.\n" -"However, there are two disadvantages to this if you want to use it for anything other than a mirror you'll reclone.\n" +msgid "% git clone --mirror $URL\n" msgstr "" -#. type: delimited block . 4 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1916 -#, no-wrap msgid "" -"First, this is a 'bare repository' which has the repository database, but no checked out worktree.\n" -"This is great for mirroring, but terrible for day to day work.\n" -"There's a number of ways around this with `git worktree`:\n" +"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:1924 +#: documentation/content/en/articles/committers-guide/_index.adoc:1920 msgid "" -"% git clone --mirror https://git.freebsd.org/ports.git ports.git % cd " -"ports.git % git worktree add ../ports main % git worktree add ../quarterly " -"branches/2020Q4 % cd ../ports" +"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 " +"day work. There's a number of ways around this with `git worktree`:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1927 +#: documentation/content/en/articles/committers-guide/_index.adoc:1928 #, no-wrap -msgid "But if you aren't using your mirror for further local clones, then it's a poor match.\n" +msgid "" +"% git clone --mirror https://git.freebsd.org/ports.git ports.git\n" +"% cd ports.git\n" +"% git worktree add ../ports main\n" +"% git worktree add ../quarterly branches/2020Q4\n" +"% cd ../ports\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1930 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1931 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 upstream.\n" -"This means that you'll lose changes if you are committing to this repository on anything other than private project branches.\n" +"But if you aren't using your mirror for further local clones, then it's a " +"poor match." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1932 -#, no-wrap -msgid "**Q:** So what can I do instead?\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1934 +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 " +"upstream. This means that you'll lose changes if you are committing to this " +"repository on anything other than private project branches." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1935 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1936 #, no-wrap -msgid "" -"**A:** Well, you can stuff all of the upstream repository's refs into a private namespace in your local repository.\n" -"Git clones everything via a 'refspec' and the default refspec is:\n" +msgid "**Q:** So what can I do instead?\n" msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1939 #, no-wrap -msgid " fetch = +refs/heads/*:refs/remotes/freebsd/*\n" +msgid "" +"**A:** Well, you can stuff all of the upstream repository's refs into a private namespace in your local repository.\n" +"Git clones everything via a 'refspec' and the default refspec is:\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1942 +#: documentation/content/en/articles/committers-guide/_index.adoc:1943 #, no-wrap -msgid "which says just fetch the branch refs.\n" +msgid " fetch = +refs/heads/*:refs/remotes/freebsd/*\n" msgstr "" -#. type: delimited block . 4 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1946 -#, no-wrap -msgid "" -"However, the FreeBSD repository has a number of other things in it.\n" -"To see those, you can add explicit refspecs for each ref namespace, or you can fetch everything.\n" -"To setup your repository to do that:\n" +msgid "which says just fetch the branch refs." msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1950 -msgid "git config --add remote.freebsd.fetch '+refs/*:refs/freebsd/*'" +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 " +"fetch everything. To setup your repository to do that:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:1954 #, no-wrap -msgid "" -"which will put everything in the upstream repository into your local repository's `refs/freebsd/` namespace.\n" -"Please note, that this also grabs all the unconverted vendor branches and the number of refs associated with them is quite large.\n" +msgid "git config --add remote.freebsd.fetch '+refs/*:refs/freebsd/*'\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1956 -#, no-wrap -msgid "You'll need to refer to these 'refs' with their full name because they aren't in and of Git's regular namespaces.\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1958 +msgid "" +"which will put everything in the upstream repository into your local " +"repository's `refs/freebsd/` namespace. Please note, that this also grabs " +"all the unconverted vendor branches and the number of refs associated with " +"them is quite large." msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1960 -msgid "git log refs/freebsd/vendor/zlib/1.2.10" +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:1963 +#: documentation/content/en/articles/committers-guide/_index.adoc:1964 #, no-wrap -msgid "would look at the log for the vendor branch for zlib starting at 1.2.10.\n" +msgid "git log refs/freebsd/vendor/zlib/1.2.10\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1967 +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:1964 +#: documentation/content/en/articles/committers-guide/_index.adoc:1968 #, no-wrap msgid "Collaborating with others" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1968 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1972 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 " @@ -4061,30 +4215,30 @@ msgid "" "branch." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1970 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1974 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: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1973 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1977 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: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1980 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1984 msgid "" -"[source,shell] ```` % git remote -v freebsd https://git.freebsd.org/src.git " -"(fetch) freebsd ssh://git@gitrepo.freebsd.org/src.git (push) ````" +"```` % git remote -v freebsd https://git.freebsd.org/src.git (fetch) " +"freebsd ssh://git@gitrepo.freebsd.org/src.git (push) ````" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1983 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1987 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/" @@ -4092,65 +4246,68 @@ msgid "" "fork should be your own, personal, GitHub account (gvnn3 in my case)." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1986 -msgid "" -"Now add a remote on your local system that points to your fork: " -"[source,shell]" -msgstr "" - #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1993 -msgid "" -"% git remote add github git@github.com:gvnn3/freebsd-src.git % git remote -v " -"github\tgit@github.com:gvnn3/freebsd-src.git (fetch) " -"github\tgit@github.com:gvnn3/freebsd-src.git (push) freebsd\thttps://" -"git.freebsd.org/src.git (fetch) freebsd\tssh://git@gitrepo.freebsd.org/" -"src.git (push)" +#: documentation/content/en/articles/committers-guide/_index.adoc:1989 +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:1996 +#: documentation/content/en/articles/committers-guide/_index.adoc:1997 #, no-wrap msgid "" -"With this in place you can create a branch\n" -"crossref:committers-guide[keeping_a_local_branch,as shown above].\n" +"% git remote add github git@github.com:gvnn3/freebsd-src.git\n" +"% git remote -v\n" +"github\tgit@github.com:gvnn3/freebsd-src.git (fetch)\n" +"github\tgit@github.com:gvnn3/freebsd-src.git (push)\n" +"freebsd\thttps://git.freebsd.org/src.git (fetch)\n" +"freebsd\tssh://git@gitrepo.freebsd.org/src.git (push)\n" msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:2000 -msgid "% git checkout -b gnn-pr2001-fix" +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 #, no-wrap -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 your hosted branch.\n" -"Before you can push you'll have to set the appropriate upstream, as Git will tell you the first time you try to push to your +github+ remote:\n" +msgid "% git checkout -b gnn-pr2001-fix\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2010 +#: documentation/content/en/articles/committers-guide/_index.adoc:2008 msgid "" -"% git push github fatal: The current branch gnn-pr2001-fix has no upstream " -"branch. To push the current branch and set the remote as upstream, use" +"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 " +"your hosted branch. Before you can push you'll have to set the appropriate " +"upstream, as Git will tell you the first time you try to push to your " +"+github+ remote:" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2012 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2014 #, no-wrap -msgid " git push --set-upstream github gnn-pr2001-fix\n" +msgid "" +"% git push github\n" +"fatal: The current branch gnn-pr2001-fix has no upstream branch.\n" +"To push the current branch and set the remote as upstream, use\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2015 +#: documentation/content/en/articles/committers-guide/_index.adoc:2016 #, no-wrap -msgid "Setting the push as +git+ advises allows it to succeed:\n" +msgid " git push --set-upstream github gnn-pr2001-fix\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2031 +#: documentation/content/en/articles/committers-guide/_index.adoc:2019 +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 #, no-wrap msgid "" "% git push --set-upstream github gnn-feature\n" @@ -4166,24 +4323,17 @@ msgid "" "remote: https://github.com/gvnn3/freebsd-src/pull/new/gnn-feature\n" "remote:\n" "To github.com:gvnn3/freebsd-src.git\n" +" * [new branch] gnn-feature -> gnn-feature\n" +"Branch 'gnn-feature' set up to track remote branch 'gnn-feature' from 'github'.\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2033 -#, no-wrap -msgid "" -"[new branch] gnn-feature -> gnn-feature\n" -"Branch 'gnn-feature' set up to track remote branch 'gnn-feature' from 'github'.\n" +#: documentation/content/en/articles/committers-guide/_index.adoc:2040 +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:2036 -#, no-wrap -msgid "Subsequent changes to the same branch will push correctly by default:\n" -msgstr "" - -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2049 +#: documentation/content/en/articles/committers-guide/_index.adoc:2053 #, no-wrap msgid "" "% git push\n" @@ -4198,28 +4348,21 @@ msgid "" " 9e5243d7b659..cf6aeb8d7dda gnn-feature -> gnn-feature\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2053 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2057 msgid "" -"At this point your work is now in your branch on +GitHub+ and you can\n" -"share the link with other collaborators.\n" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2055 -#, no-wrap -msgid "[[github-pull-land]]\n" +"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:2055 +#: documentation/content/en/articles/committers-guide/_index.adoc:2059 #, no-wrap msgid "Landing a github pull request" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2060 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2064 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 " @@ -4231,124 +4374,160 @@ msgid "" "to ensure they are exactly as represented." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2065 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2068 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 " -"above]. In addition, make sure to have the following origins: [source,shell]" -msgstr "" - -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2071 -msgid "" -"% git remote -v freebsd https://git.freebsd.org/src.git (fetch) freebsd " -"ssh://git@gitrepo.freebsd.org/src.git (push) github https://github.com/" -"freebsd/freebsd-src (fetch) github https://github.com/freebsd/freebsd-src " -"(fetch)" +"above]. In addition, make sure to have the following origins:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2091 +#: documentation/content/en/articles/committers-guide/_index.adoc:2075 #, no-wrap msgid "" -"Often pull requests are simple: requests that contain only a single commit.\n" -"In this case, a streamlined approach may be used, though the approach in the prior section will also work.\n" -"Here, a branch is created, the change is cherry picked, the commit message adjusted, and sanity-checked before being pushed.\n" -"The branch `staging` is used in this example but it can be any name.\n" -"This technique works for any number of commits in the pull request, especially when the changes apply cleanly to the FreeBSD tree.\n" -"However, when there's multiple commits, especially when minor adjustments are needed, `git rebase -i` works better than `git cherry-pick`.\n" -"Briefly, these commands create a branch; cherry-picks the changes from the pull request; tests it; adjusts the commit messages; and fast forward merges it back to `main`.\n" -"The PR number is `$PR` below.\n" -"When adjusting the message, add `Pull Request: https://github.com/freebsd-src/pull/$PR`.\n" -"All pull requests committed to the FreeBSD repository should be reviewed by at least one person.\n" -"This need not be the person committing it, but in that case the person committing it should trust the other reviewers competence to review the commit.\n" -"Committers that do a code review of pull requests before pushing them into the repo should add a `Reviewed by:` line to the commit, because in this case it is not implicit.\n" -"Add anybody that reviews and approves the commit on github to `Reviewed by:` as well.\n" -"As always, care should be taken to ensure the change does what it is supposed to, and that no malicious code is present.\n" -"[NOTE]\n" -"======\n" -"In addition, please check to make sure that the pull request author name is not anonymous.\n" -"Github's web editing interface generates names like:\n" -"[source,shell]\n" +"% git remote -v\n" +"freebsd https://git.freebsd.org/src.git (fetch)\n" +"freebsd ssh://git@gitrepo.freebsd.org/src.git (push)\n" +"github https://github.com/freebsd/freebsd-src (fetch)\n" +"github https://github.com/freebsd/freebsd-src (fetch)\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2090 +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 " +"prior section will also work. Here, a branch is created, the change is " +"cherry picked, the commit message adjusted, and sanity-checked before being " +"pushed. The branch `staging` is used in this example but it can be any " +"name. This technique works for any number of commits in the pull request, " +"especially when the changes apply cleanly to the FreeBSD tree. However, " +"when there's multiple commits, especially when minor adjustments are needed, " +"`git rebase -i` works better than `git cherry-pick`. Briefly, these " +"commands create a branch; cherry-picks the changes from the pull request; " +"tests it; adjusts the commit messages; and fast forward merges it back to " +"`main`. The PR number is `$PR` below. When adjusting the message, add " +"`Pull Request: https://github.com/freebsd-src/pull/$PR`. All pull requests " +"committed to the FreeBSD repository should be reviewed by at least one " +"person. This need not be the person committing it, but in that case the " +"person committing it should trust the other reviewers competence to review " +"the commit. Committers that do a code review of pull requests before " +"pushing them into the repo should add a `Reviewed by:` line to the commit, " +"because in this case it is not implicit. Add anybody that reviews and " +"approves the commit on github to `Reviewed by:` as well. As always, care " +"should be taken to ensure the change does what it is supposed to, and that " +"no malicious code is present." msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2093 -#, no-wrap -msgid "Author: github-user <38923459+github-user@users.noreply.github.com>\n" +#. type: delimited block = 6 +#: documentation/content/en/articles/committers-guide/_index.adoc:2094 +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 #, no-wrap -msgid "" -"A polite request to the author for a better name and/or email should be made.\n" -"Extra care should be taken to ensure no style issue or malicious code is introduced.\n" -"======\n" +msgid "Author: github-user <38923459+github-user@users.noreply.github.com>\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2109 +#: documentation/content/en/articles/committers-guide/_index.adoc:2100 msgid "" -"% git fetch github pull/$PR/head:staging % git rebase -i main staging\t# to " -"move the staging branch forward, adjust commit message here <do testing " -"here, as needed> % git checkout main % git pull --ff-only\t\t# to get the " -"latest if time has passed % git checkout main % git merge --ff-only staging " -"<test again if needed> % git push freebsd --push-option=confirm-author" +"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 " +"is introduced." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2114 +#: documentation/content/en/articles/committers-guide/_index.adoc:2113 #, no-wrap msgid "" -"[.procedure]\n" -"====\n" -"For complicated pull requests that have multiple commits with conflicts, follow the following outline.\n" +"% git fetch github pull/$PR/head:staging\n" +"% git rebase -i main staging\t# to move the staging branch forward, adjust commit message here\n" +"<do testing here, as needed>\n" +"% git checkout main\n" +"% git pull --ff-only\t\t# to get the latest if time has passed\n" +"% git checkout main\n" +"% git merge --ff-only staging\n" +"<test again if needed>\n" +"% git push freebsd --push-option=confirm-author\n" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2118 +msgid "" +"For complicated pull requests that have multiple commits with conflicts, " +"follow the following outline." msgstr "" -#. type: delimited block . 4 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2120 +msgid "checkout the pull request `git checkout github/pull/XXX`" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2121 +msgid "create a branch to rebase `git checkout -b staging`" +msgstr "" + +#. type: delimited block = 4 #: documentation/content/en/articles/committers-guide/_index.adoc:2122 -#, no-wrap msgid "" -". checkout the pull request `git checkout github/pull/XXX`\n" -". create a branch to rebase `git checkout -b staging`\n" -". rebase the `staging` branch to the latest `main` with `git rebase -i main staging`\n" -". resolve conflicts and do whatever testing is needed\n" -". fast forward the `staging` branch into `main` as above\n" -". final sanity check of changes to make sure all is well\n" -". push to FreeBSD's Git repository.\n" +"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:2127 -#, no-wrap +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2123 +msgid "resolve conflicts and do whatever testing is needed" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2124 +msgid "fast forward the `staging` branch into `main` as above" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2125 +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 +msgid "push to FreeBSD's Git repository." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2128 msgid "" -"This will also work when bringing branches developed elsewhere into the local tree for committing.\n" -"====\n" -"Once finished with the pull request, close it using GitHub's web interface.\n" -"It is worth noting that if your `github` origin uses `https://`, the only step you'll need a GitHub account for is closing the pull request.\n" +"This will also work when bringing branches developed elsewhere into the " +"local tree for committing." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2129 -#, no-wrap -msgid "[[vcs-history]]\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2131 +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 " +"step you'll need a GitHub account for is closing the pull request." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2129 +#: documentation/content/en/articles/committers-guide/_index.adoc:2133 #, no-wrap msgid "Version Control History" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2132 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2136 msgid "The project has moved to crossref:committers-guide[git-primer,git]." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2138 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2142 msgid "" "The FreeBSD source repository switched from CVS to Subversion on May 31st, " "2008. The first real SVN commit is __r179447__. The source repository " @@ -4357,8 +4536,8 @@ msgid "" "__5ef5f51d2bef80b0ede9b10ad5b0e9440b60518c__." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2144 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2148 msgid "" "The FreeBSD `doc/www` repository switched from CVS to Subversion on May " "19th, 2012. The first real SVN commit is __r38821__. The documentation " @@ -4367,8 +4546,8 @@ msgid "" "__3be01a475855e7511ad755b2defd2e0da5d58bbe__." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2150 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2154 msgid "" "The FreeBSD `ports` repository switched from CVS to Subversion on July 14th, " "2012. The first real SVN commit is __r300894__. The ports repository " @@ -4377,226 +4556,374 @@ msgid "" "__ed8d3eda309dd863fb66e04bccaa513eee255cbf__." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2152 -msgid "[[conventions]]" -msgstr "" - #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2152 +#: documentation/content/en/articles/committers-guide/_index.adoc:2156 #, no-wrap msgid "Setup, Conventions, and Traditions" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2157 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2161 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 " "for those who are not committers." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2159 -msgid "[[conventions-committers]]" -msgstr "" - #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2159 +#: documentation/content/en/articles/committers-guide/_index.adoc:2163 #, no-wrap msgid "For New Committers" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2162 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2166 msgid "" "Those who have been given commit rights to the FreeBSD repositories must " "follow these steps." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2165 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2168 +msgid "Get mentor approval before committing each of these changes!" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2169 msgid "" -"* Get mentor approval before committing each of these changes!\n" -"* All [.filename]#src# commits go to FreeBSD-CURRENT first before being merged to FreeBSD-STABLE. The FreeBSD-STABLE branch must maintain ABI and API compatibility with earlier versions of that branch. Do not merge changes that break this compatibility.\n" +"All [.filename]#src# commits go to FreeBSD-CURRENT first before being merged " +"to FreeBSD-STABLE. The FreeBSD-STABLE branch must maintain ABI and API " +"compatibility with earlier versions of that branch. Do not merge changes " +"that break this compatibility." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2170 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2174 #, no-wrap +msgid "*Steps for New Committers*\n" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2176 +msgid "Add an Author Entity" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2178 msgid "" -"[[commit-steps]]\n" -"[.procedure]\n" -"====\n" -"*Steps for New Committers*\n" +"[.filename]#doc/shared/authors.adoc# - Add an author entity. Later steps " +"depend on this entity, and missing this step will cause the [.filename]#doc/" +"# build to fail. This is a relatively easy task, but remains a good first " +"test of version control skills." msgstr "" -#. type: delimited block . 4 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2179 +msgid "Update the List of Developers and Contributors" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2181 +msgid "" +"[.filename]#doc/shared/contrib-committers.adoc# - Add an entry, which will " +"then appear in the \"Developers\" section of the extref:{contributors}" +"[Contributors List, staff-committers]. Entries are sorted by last name." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2183 +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 +msgid "Add a News Item" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2186 +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 " +"date from the commit bit approval email." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2187 +msgid "Add a PGP Key" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2189 +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/" +"documentation/static/pgpkeys/README[README] file for more information." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2191 +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 +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 +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, " +"the `{admins}` might need it for account recovery. A complete keyring of " +"`FreeBSD.org` users is available for download from link:https://" +"docs.FreeBSD.org/pgpkeys/pgpkeys.txt[https://docs.FreeBSD.org/pgpkeys/" +"pgpkeys.txt]." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2199 +msgid "Update Mentor and Mentee Information" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2201 +msgid "" +"[.filename]#src/share/misc/committers-<repository>.dot# - Add an entry to " +"the current committers section, where _repository_ is `doc`, `ports`, or " +"`src`, depending on the commit privileges granted." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2203 +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 +msgid "Generate a Kerberos Password" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2206 +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 " +"other FreeBSD services like the link:https://bugs.freebsd.org/bugzilla/[bug-" +"tracking database] (you get a bug-tracking account as part of that step)." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2207 +msgid "Optional: Enable Wiki Account" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2211 +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 " +"instructions on the link:https://wiki.freebsd.org/Wiki/About[Wiki/About " +"page] to obtain one. Contact mailto:wiki-admin@FreeBSD.org[wiki-" +"admin@FreeBSD.org] if you need help with your Wiki account." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2212 +msgid "Optional: Update Wiki Information" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2214 +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://" +"wiki.freebsd.org/IRC/Nicknames[IRC Nicks], https://wiki.freebsd.org/" +"Community/Dogs[Dogs of FreeBSD], and or https://wiki.freebsd.org/Community/" +"Cats[Cats of FreeBSD] pages." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2215 +msgid "Optional: Update Ports with Personal Information" +msgstr "" + +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:2217 -#, no-wrap msgid "" -". Add an Author Entity\n" -"+\n" -"[.filename]#doc/shared/authors.adoc# - Add an author entity. Later steps depend on this entity, and missing this step will cause the [.filename]#doc/# build to fail. This is a relatively easy task, but remains a good first test of version control skills.\n" -". Update the List of Developers and Contributors\n" -"+\n" -"[.filename]#doc/shared/contrib-committers.adoc# - Add an entry, which will then appear in the \"Developers\" section of the extref:{contributors}[Contributors List, staff-committers]. Entries are sorted by last name.\n" -"+\n" -"[.filename]#doc/shared/contrib-additional.adoc# - _Remove_ the entry. Entries are sorted by first name.\n" -". Add a News Item\n" -"+\n" -"[.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 date from the commit bit approval email.\n" -". Add a PGP Key\n" -"+\n" -"`{des}` has written a shell script ([.filename]#doc/documentation/tools/addkey.sh#) to make this easier. See the https://cgit.freebsd.org/doc/plain/documentation/static/pgpkeys/README[README] file for more information.\n" -"+\n" -"Use [.filename]#doc/documentation/tools/checkkey.sh# to verify that keys meet minimal best-practices standards.\n" -"+\n" -"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.\n" -"+\n" -"[NOTE]\n" -"======\n" -"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, the `{admins}` might need it for account recovery. A complete keyring of `FreeBSD.org` users is available for download from link:https://docs.FreeBSD.org/pgpkeys/pgpkeys.txt[https://docs.FreeBSD.org/pgpkeys/pgpkeys.txt].\n" -"======\n" -". Update Mentor and Mentee Information\n" -"+\n" -"[.filename]#src/share/misc/committers-<repository>.dot# - Add an entry to the current committers section, where _repository_ is `doc`, `ports`, or `src`, depending on the commit privileges granted.\n" -"+\n" -"Add an entry for each additional mentor/mentee relationship in the bottom section.\n" -". Generate a Kerberos Password\n" -"+\n" -"See crossref:committers-guide[kerberos-ldap, Kerberos and LDAP web Password for FreeBSD Cluster] to generate or set a Kerberos account for use with other FreeBSD services like the link:https://bugs.freebsd.org/bugzilla/[bug-tracking database] (you get a bug-tracking account as part of that step).\n" -". Optional: Enable Wiki Account\n" -"+\n" -"link:https://wiki.freebsd.org[FreeBSD Wiki] Account - A wiki account allows sharing projects and ideas.\n" -"Those who do not yet have an account can follow instructions on the link:https://wiki.freebsd.org/Wiki/About[Wiki/About page] to obtain one.\n" -"Contact mailto:wiki-admin@FreeBSD.org[wiki-admin@FreeBSD.org] if you need help with your Wiki account.\n" -". Optional: Update Wiki Information\n" -"+\n" -"Wiki Information - After gaining access to the wiki, some people add entries to the https://wiki.freebsd.org/HowWeGotHere[How We Got Here], https://wiki.freebsd.org/IRC/Nicknames[IRC Nicks], https://wiki.freebsd.org/Community/Dogs[Dogs of FreeBSD], and or https://wiki.freebsd.org/Community/Cats[Cats of FreeBSD] pages.\n" -". Optional: Update Ports with Personal Information\n" -"+\n" -"[.filename]#ports/astro/xearth/files/freebsd.committers.markers# and [.filename]#src/usr.bin/calendar/calendars/calendar.freebsd# - Some people add entries for themselves to these files to show where they are located or the date of their birthday.\n" -". Optional: Prevent Duplicate Mailings\n" -"+\n" -"Subscribers to {dev-commits-doc-all}, {dev-commits-ports-all} or {dev-commits-src-all} might wish to unsubscribe to avoid receiving duplicate copies of commit messages and followups.\n" -"====\n" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2219 -#, no-wrap -msgid "[[conventions-everyone]]\n" +"[.filename]#ports/astro/xearth/files/freebsd.committers.markers# and " +"[.filename]#src/usr.bin/calendar/calendars/calendar.freebsd# - Some people " +"add entries for themselves to these files to show where they are located or " +"the date of their birthday." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2218 +msgid "Optional: Prevent Duplicate Mailings" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2220 +msgid "" +"Subscribers to {dev-commits-doc-all}, {dev-commits-ports-all} or {dev-" +"commits-src-all} might wish to unsubscribe to avoid receiving duplicate " +"copies of commit messages and followups." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2219 +#: documentation/content/en/articles/committers-guide/_index.adoc:2223 #, no-wrap msgid "For Everyone" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2239 -msgid "" -"[[conventions-everyone-steps]] [.procedure] ==== . 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 comprehensive biography, " -"just write a paragraph or two about who you are, what you plan to be working " -"on as a developer in FreeBSD, and who will be your mentor. Email this to the " -"{developers-name} and you will be on your way! . 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 want " -"mail addressed to _yourusername_@FreeBSD.org to be forwarded. This includes " -"all of the commit messages as well as any other mail addressed to the " -"{committers-name} and the {developers-name}. Really large mailboxes which " -"have taken up permanent residence on `freefall` may get truncated without " -"warning if space needs to be freed, so forward it or save it elsewhere. + " -"[NOTE] ====== If your e-mail system uses SPF with strict rules, you should " -"exclude `mx2.FreeBSD.org` from SPF checks. ====== + 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 checks and will " -"drop some messages based on these checks. At the moment proper DNS " -"information for the connecting host is the only check in place but that may " -"change. Some people blame these checks for bouncing valid email. To have " -"these checks turned off for your email, create a file named " -"[.filename]#~/.spam_lover# on `freefall.FreeBSD.org`. + [NOTE] ====== Those " -"who are developers but not committers will not be subscribed to the " -"committers or developers mailing lists. The subscriptions are derived from " -"the access rights. ====== ====" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2229 +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 " +"comprehensive biography, just write a paragraph or two about who you are, " +"what you plan to be working on as a developer in FreeBSD, and who will be " +"your mentor. Email this to the {developers-name} and you will be on your way!" msgstr "" -#. type: delimited block . 4 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2230 +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 " +"want mail addressed to _yourusername_@FreeBSD.org to be forwarded. This " +"includes all of the commit messages as well as any other mail addressed to " +"the {committers-name} and the {developers-name}. Really large mailboxes " +"which have taken up permanent residence on `freefall` may get truncated " +"without warning if space needs to be freed, so forward it or save it " +"elsewhere." +msgstr "" + +#. type: delimited block = 6 +#: documentation/content/en/articles/committers-guide/_index.adoc:2234 +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 +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 " +"checks and will drop some messages based on these checks. At the moment " +"proper DNS information for the connecting host is the only check in place " +"but that may change. Some people blame these checks for bouncing valid " +"email. To have these checks turned off for your email, create a file named " +"[.filename]#~/.spam_lover# on `freefall.FreeBSD.org`." +msgstr "" + +#. type: delimited block = 6 #: documentation/content/en/articles/committers-guide/_index.adoc:2241 -msgid "[[smtp-setup]]" +msgid "" +"Those who are developers but not committers will not be subscribed to the " +"committers or developers mailing lists. The subscriptions are derived from " +"the access rights." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:2241 +#: documentation/content/en/articles/committers-guide/_index.adoc:2245 #, no-wrap msgid "SMTP Access Setup" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2244 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2248 msgid "" "For those willing to send e-mail messages through the FreeBSD.org " "infrastructure, follow the instructions below:" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2266 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2252 +msgid "Point your mail client at `smtp.FreeBSD.org:587`." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2253 +msgid "Enable STARTTLS." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2254 +msgid "Ensure your `From:` address is set to `_yourusername_@FreeBSD.org`." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2256 +msgid "" +"For authentication, you can use your FreeBSD Kerberos username and password " +"(see crossref:committers-guide[kerberos-ldap, Kerberos and LDAP web Password " +"for FreeBSD Cluster]). The `_yourusername_/mail` principal is preferred, as " +"it is only valid for authenticating to mail resources." +msgstr "" + +#. type: delimited block = 6 +#: documentation/content/en/articles/committers-guide/_index.adoc:2260 +msgid "Do not include `@FreeBSD.org` when entering in your username." +msgstr "" + +#. type: Block title +#: documentation/content/en/articles/committers-guide/_index.adoc:2262 #, no-wrap +msgid "Additional Notes" +msgstr "" + +#. type: delimited block = 6 +#: documentation/content/en/articles/committers-guide/_index.adoc:2266 msgid "" -"[.procedure]\n" -"====\n" -". Point your mail client at `smtp.FreeBSD.org:587`.\n" -". Enable STARTTLS.\n" -". Ensure your `From:` address is set to `_yourusername_@FreeBSD.org`.\n" -". For authentication, you can use your FreeBSD Kerberos username and password\n" -" (see crossref:committers-guide[kerberos-ldap, Kerberos and LDAP web Password for FreeBSD Cluster]). The `_yourusername_/mail` principal is preferred, as it is only valid for authenticating to mail resources.\n" -"+\n" -"[NOTE]\n" -"======\n" -"Do not include `@FreeBSD.org` when entering in your username.\n" -"======\n" -"+\n" -".Additional Notes\n" -"[NOTE]\n" -"======\n" -"* Will only accept mail from `_yourusername_@FreeBSD.org`. If you are authenticated as one user, you are not permitted to send mail from another.\n" -"* A header will be appended with the SASL username: (`Authenticated sender: _username_`).\n" -"* Host has various rate limits in place to cut down on brute force attempts.\n" -"======\n" -"====\n" +"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 . 4 +#. type: delimited block = 6 +#: documentation/content/en/articles/committers-guide/_index.adoc:2267 +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 -#, no-wrap -msgid "[[smtp-setup-local-mta]]\n" +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:2268 +#: documentation/content/en/articles/committers-guide/_index.adoc:2272 #, 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:2271 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2275 msgid "" "It is also possible to use a local MTA to forward locally sent emails to the " "FreeBSD.org SMTP servers." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2276 -msgid "[[smtp-setup-local-postfix]] .Using Postfix [example] ====" +#. type: Block title +#: documentation/content/en/articles/committers-guide/_index.adoc:2277 +#, no-wrap +msgid "Using Postfix" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2278 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2282 msgid "" "To tell a local Postfix instance that anything from " "`_yourusername_@FreeBSD.org` should be forwarded to the FreeBSD.org servers, " @@ -4604,149 +4931,135 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2280 -msgid "[.programlisting]" -msgstr "" - -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2286 -msgid "" -"sender_dependent_relayhost_maps = hash:/usr/local/etc/postfix/relayhost_maps " -"smtp_sasl_auth_enable = yes smtp_sasl_security_options = noanonymous " -"smtp_sasl_password_maps = hash:/usr/local/etc/postfix/sasl_passwd " -"smtp_use_tls = yes" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2289 -#, no-wrap -msgid "Create [.filename]#/usr/local/etc/postfix/relayhost_maps# with the following content:\n" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2291 -#: documentation/content/en/articles/committers-guide/_index.adoc:2298 -#: documentation/content/en/articles/committers-guide/_index.adoc:2305 -#: documentation/content/en/articles/committers-guide/_index.adoc:2313 -#: documentation/content/en/articles/committers-guide/_index.adoc:2328 -#: documentation/content/en/articles/committers-guide/_index.adoc:2338 -#: documentation/content/en/articles/committers-guide/_index.adoc:2352 -#: documentation/content/en/articles/committers-guide/_index.adoc:2383 +#: documentation/content/en/articles/committers-guide/_index.adoc:2290 #, no-wrap -msgid "[.programlisting]\n" +msgid "" +"sender_dependent_relayhost_maps = hash:/usr/local/etc/postfix/relayhost_maps\n" +"smtp_sasl_auth_enable = yes\n" +"smtp_sasl_security_options = noanonymous\n" +"smtp_sasl_password_maps = hash:/usr/local/etc/postfix/sasl_passwd\n" +"smtp_use_tls = yes\n" msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:2293 -msgid "yourusername@FreeBSD.org [smtp.freebsd.org]:587" +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:2296 +#: documentation/content/en/articles/committers-guide/_index.adoc:2297 #, no-wrap -msgid "Create [.filename]#/usr/local/etc/postfix/sasl_passwd# with the following content:\n" +msgid "yourusername@FreeBSD.org [smtp.freebsd.org]:587\n" msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:2300 -#, no-wrap -msgid "[smtp.freebsd.org]:587 yourusername:yourpassword\n" +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:2303 +#: documentation/content/en/articles/committers-guide/_index.adoc:2304 #, no-wrap -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 [.filename]#main.cf#:\n" +msgid "[smtp.freebsd.org]:587 yourusername:yourpassword\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2308 +#: documentation/content/en/articles/committers-guide/_index.adoc:2307 msgid "" -"smtpd_sender_login_maps = hash:/usr/local/etc/postfix/sender_login_maps " -"smtpd_sender_restrictions = reject_known_sender_login_mismatch" +"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 " +"[.filename]#main.cf#:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2311 +#: documentation/content/en/articles/committers-guide/_index.adoc:2312 #, no-wrap -msgid "Create [.filename]#/usr/local/etc/postfix/sender_login_maps# with the following content:\n" +msgid "" +"smtpd_sender_login_maps = hash:/usr/local/etc/postfix/sender_login_maps\n" +"smtpd_sender_restrictions = reject_known_sender_login_mismatch\n" msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:2315 -msgid "yourusername@FreeBSD.org yourlocalusername" +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 #, no-wrap -msgid "" -"Where _yourlocalusername_ is the SASL username used to connect to the local instance of Postfix.\n" -"====\n" +msgid "yourusername@FreeBSD.org yourlocalusername\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2324 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2322 msgid "" -"[[smtp-setup-local-opensmtpd]]\n" -".Using OpenSMTPD\n" -"[example]\n" -"====\n" +"Where _yourlocalusername_ is the SASL username used to connect to the local " +"instance of Postfix." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2326 +#. type: Block title +#: documentation/content/en/articles/committers-guide/_index.adoc:2325 #, no-wrap -msgid "To tell a local OpenSMTPD instance that anything from `_yourusername_@FreeBSD.org` should be forwarded to the FreeBSD.org servers, add this to your [.filename]#smtpd.conf#:\n" +msgid "Using OpenSMTPD" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2331 +#: documentation/content/en/articles/committers-guide/_index.adoc:2330 msgid "" -"action \"freebsd\" relay host smtp+tls://freebsd@smtp.freebsd.org:587 auth " -"<secrets> match from any auth yourlocalusername mail-from " -"\"_yourusername_@freebsd.org\" for any action \"freebsd\"" +"To tell a local OpenSMTPD instance that anything from " +"`_yourusername_@FreeBSD.org` should be forwarded to the FreeBSD.org servers, " +"add this to your [.filename]#smtpd.conf#:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2334 +#: documentation/content/en/articles/committers-guide/_index.adoc:2335 #, no-wrap -msgid "Where _yourlocalusername_ is the SASL username used to connect to the local instance of OpenSMTPD.\n" +msgid "" +"action \"freebsd\" relay host smtp+tls://freebsd@smtp.freebsd.org:587 auth <secrets>\n" +"match from any auth yourlocalusername mail-from \"_yourusername_@freebsd.org\" for any action \"freebsd\"\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2336 -#, no-wrap -msgid "Create [.filename]#/usr/local/etc/mail/secrets# with the following content:\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2338 +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 -msgid "freebsd\tyourusername:yourpassword" +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:2347 +#: documentation/content/en/articles/committers-guide/_index.adoc:2344 #, no-wrap -msgid "" -"====\n" -"[[smtp-setup-local-exim]]\n" -".Using Exim\n" -"[example]\n" -"====\n" +msgid "freebsd\tyourusername:yourpassword\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2350 +#. type: Block title +#: documentation/content/en/articles/committers-guide/_index.adoc:2348 +#, no-wrap +msgid "Using Exim" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2354 #, no-wrap msgid "" "To direct a local Exim instance to forward all mail from `_example_@FreeBSD.org`\n" " to FreeBSD.org servers, add this to Exim [.filename]#configuration#:\n" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2359 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2363 #, no-wrap msgid "" "Routers section: (at the top of the list):\n" @@ -4757,8 +5070,8 @@ msgid "" " route_data = ${lookup {${lc:$sender_address}} lsearch {/usr/local/etc/exim/freebsd_send}}\n" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2371 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2375 #, no-wrap msgid "" "Transport Section:\n" @@ -4774,8 +5087,8 @@ msgid "" " hosts_require_auth = smtp.freebsd.org\n" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2378 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2382 #, no-wrap msgid "" "Authenticators:\n" @@ -4786,37 +5099,27 @@ msgid "" " client_condition = ${if eq{$host}{smtp.freebsd.org}}\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2381 -#, no-wrap -msgid "Create [.filename]#/usr/local/etc/exim/freebsd_send# with the following content:\n" -msgstr "" - #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:2385 -msgid "example@freebsd.org:smtp.freebsd.org::587" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2388 -#, no-wrap -msgid "====\n" +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:2390 +#: documentation/content/en/articles/committers-guide/_index.adoc:2389 #, no-wrap -msgid "[[mentors]]\n" +msgid "example@freebsd.org:smtp.freebsd.org::587\n" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2390 +#: documentation/content/en/articles/committers-guide/_index.adoc:2394 #, no-wrap msgid "Mentors" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2395 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2399 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 " @@ -4825,16 +5128,16 @@ msgid "" "initial period." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2398 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2402 msgid "" "For committers: do not commit anything without first getting mentor " "approval. Document that approval with an `Approved by:` line in the commit " "message." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2403 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2407 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 " @@ -4843,19 +5146,14 @@ msgid "" "can be found in crossref:committers-guide[admin-branch, \"admin\" branch]." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2405 -msgid "[[pre-commit-review]]" -msgstr "" - #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2405 +#: documentation/content/en/articles/committers-guide/_index.adoc:2409 #, no-wrap msgid "Pre-Commit Review" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2410 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2414 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` " @@ -4864,80 +5162,129 @@ msgid "" "review:" msgstr "" -#. type: delimited block . 4 +#. type: delimited block = 4 #: documentation/content/en/articles/committers-guide/_index.adoc:2416 -#, no-wrap msgid "" -"* All non-trivial changes should be reviewed before they are committed to the repository.\n" -"* Reviews may be conducted by email, in Bugzilla, in Phabricator, or by another mechanism. Where possible, reviews should be public.\n" -"* The developer responsible for a code change is also responsible for making all necessary review-related changes.\n" -"* 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 should receive an explicit \"looks good\" before it is committed. So long as it is explicit, this can take whatever form makes sense for the review method.\n" -"* Timeouts are not a substitute for review.\n" +"All non-trivial changes should be reviewed before they are committed to the " +"repository." msgstr "" -#. type: delimited block . 4 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2417 +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 -#, no-wrap -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 are:\n" +msgid "" +"The developer responsible for a code change is also responsible for making " +"all necessary review-related changes." msgstr "" -#. type: delimited block . 4 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2419 +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 " +"should receive an explicit \"looks good\" before it is committed. So long as " +"it is explicit, this can take whatever form makes sense for the review " +"method." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2420 +msgid "Timeouts are not a substitute for review." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2422 +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 " +"are:" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2424 +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 -#, no-wrap 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.\n" -"* 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 urgent, the common courtesy ping rate is one week. Remember that you are asking for valuable time from other professional developers.\n" -"* Ask for help on mailing lists, IRC, etc. Others may be able to either help you directly, or suggest a reviewer.\n" -"* 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 quick look at it.\n" -"+\n" -"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 difficult after the fact.\n" +"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 " +"urgent, the common courtesy ping rate is one week. Remember that you are " +"asking for valuable time from other professional developers." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2430 -#, no-wrap +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2426 msgid "" -"Developers should participate in code reviews as both reviewers and reviewees.\n" -"If someone is kind enough to review your code, you should return the favor for someone else.\n" -"Note that while anyone is welcome to review and give feedback on a patch, only an appropriate subject-matter expert can approve a change.\n" -"This will usually be a committer who works with the code in question on a regular basis.\n" +"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:2433 -#, no-wrap +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2427 msgid "" -"In some cases, no subject-matter expert may be available.\n" -"In those cases, a review by an experienced developer is sufficient when coupled with appropriate testing.\n" +"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 " +"quick look at it." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2435 -#, no-wrap -msgid "[[commit-log-message]]\n" +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2429 +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 " +"difficult after the fact." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2434 +msgid "" +"Developers should participate in code reviews as both reviewers and " +"reviewees. If someone is kind enough to review your code, you should return " +"the favor for someone else. Note that while anyone is welcome to review and " +"give feedback on a patch, only an appropriate subject-matter expert can " +"approve a change. This will usually be a committer who works with the code " +"in question on a regular basis." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2437 +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 " +"appropriate testing." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2435 +#: documentation/content/en/articles/committers-guide/_index.adoc:2439 #, no-wrap msgid "Commit Log Messages" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2438 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2442 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:2439 +#: documentation/content/en/articles/committers-guide/_index.adoc:2443 #, no-wrap msgid "Why are commit messages important?" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2443 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2447 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 " @@ -4946,16 +5293,16 @@ msgid "" "`fixed a bug`?" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2446 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2450 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 " "other developers, in the present and for the future." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2449 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2453 msgid "" "FreeBSD has hundreds of active developers and hundreds of thousands of " "commits spanning decades of history. Over that time the developer community " @@ -4963,65 +5310,78 @@ msgid "" "learned lessons." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2451 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2455 msgid "Commit messages serve at least three purposes:" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2458 -#, no-wrap +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2457 +msgid "Communicating with other developers" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2462 msgid "" -"* Communicating with other developers\n" -"+\n" -"FreeBSD commits generate email to various mailing lists.\n" -"These include the commit message along with a copy of the patch itself.\n" -"Commit messages are also viewed through commands like git log.\n" -"These serve to make other developers aware of changes that are ongoing; that other developer may want to test the change, may have an interest in the topic and will want to review in more detail, or may have their own projects underway that would benefit from interaction.\n" +"FreeBSD commits generate email to various mailing lists. These include the " +"commit message along with a copy of the patch itself. Commit messages are " +"also viewed through commands like git log. These serve to make other " +"developers aware of changes that are ongoing; that other developer may want " +"to test the change, may have an interest in the topic and will want to " +"review in more detail, or may have their own projects underway that would " +"benefit from interaction." msgstr "" -#. type: delimited block . 4 +#. type: delimited block = 4 #: documentation/content/en/articles/committers-guide/_index.adoc:2464 -#, no-wrap +msgid "Making Changes Discoverable" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2468 msgid "" -"* Making Changes Discoverable\n" -"+\n" -"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.\n" -"Verbose, detailed commit messages allow searches for changes that might be relevant.\n" -"For example, `git log --since 1year --grep 'USB timeout'`.\n" +"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, " +"detailed commit messages allow searches for changes that might be relevant. " +"For example, `git log --since 1year --grep 'USB timeout'`." msgstr "" -#. type: delimited block . 4 +#. type: delimited block = 4 #: documentation/content/en/articles/committers-guide/_index.adoc:2470 -#, no-wrap +msgid "Providing historical documentation" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2474 msgid "" -"* Providing historical documentation\n" -"+\n" -"Commit messages serve to document changes for future developers, perhaps years or decades later.\n" -"This future developer may even be you, the original author.\n" -"A change that seems obvious today may be decidedly not so much later on.\n" +"Commit messages serve to document changes for future developers, perhaps " +"years or decades later. This future developer may even be you, the original " +"author. A change that seems obvious today may be decidedly not so much " +"later on." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2472 -#, no-wrap -msgid "The `git blame` command annotates each line of a source file with the change (hash and subject line) that brought it in.\n" +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2476 +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:2474 -#, no-wrap -msgid "Having established the importance, here are elements of a good FreeBSD commit message:\n" +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2478 +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:2475 +#: documentation/content/en/articles/committers-guide/_index.adoc:2479 #, no-wrap msgid "Start with a subject line" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2479 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2483 msgid "" "Commit messages should start with a single-line subject that briefly " "summarizes the change. The subject should, by itself, allow the reader to " @@ -5029,102 +5389,103 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2480 +#: documentation/content/en/articles/committers-guide/_index.adoc:2484 #, no-wrap msgid "Keep subject lines short" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2485 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2489 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 " "so that git log --oneline can display the short hash and subject on a single " -"80-column line. A good rule of thumb is to stay below 63 characters, and " +"80-column line. A good rule of thumb is to stay below 67 characters, and " "aim for about 50 or fewer if possible." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2486 +#: documentation/content/en/articles/committers-guide/_index.adoc:2490 #, 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:2489 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2494 msgid "" "If the change relates to a specific component the subject line may be " -"prefixed with that component name and a colon (:)." +"prefixed with that component name and a colon (:). If applicable, try to " +"use the same prefix used in previous commits to the same files." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2491 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2496 msgid "✓ `foo: Add -k option to keep temporary data`" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2493 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2498 msgid "" -"Include the prefix in the 63-character limit suggested above, so that `git " +"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:2494 +#: documentation/content/en/articles/committers-guide/_index.adoc:2499 #, no-wrap msgid "Capitalize the first letter of the subject" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2498 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2503 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:2499 +#: documentation/content/en/articles/committers-guide/_index.adoc:2504 #, no-wrap msgid "Do not end the subject line with punctuation" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2503 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2508 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:2504 +#: documentation/content/en/articles/committers-guide/_index.adoc:2509 #, 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:2507 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2512 msgid "Separate the body from the subject with a blank line." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2509 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2514 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:2511 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2516 msgid "✓ `ls: Fix typo in usage text`" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2512 +#: documentation/content/en/articles/committers-guide/_index.adoc:2517 #, no-wrap msgid "Limit messages to 72 columns" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2518 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2523 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. " @@ -5135,13 +5496,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2519 +#: documentation/content/en/articles/committers-guide/_index.adoc:2524 #, no-wrap msgid "Use the present tense, imperative mood" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2524 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2529 msgid "" "This facilitates short subject lines and provides consistency, including " "with automatically generated commit messages (e.g., as generated by git " @@ -5150,8 +5511,8 @@ msgid "" "\"." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2529 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2534 #, no-wrap msgid "" "✓ `foo: Implement the -k (keep) option`\n" @@ -5161,41 +5522,41 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2530 +#: documentation/content/en/articles/committers-guide/_index.adoc:2535 #, no-wrap msgid "Focus on what and why, not how" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2533 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2538 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:2537 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2542 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 " "have it." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2539 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2544 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:2540 +#: documentation/content/en/articles/committers-guide/_index.adoc:2545 #, 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:2543 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2548 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. " @@ -5204,13 +5565,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2544 +#: documentation/content/en/articles/committers-guide/_index.adoc:2549 #, no-wrap msgid "Write commit messages for your future self" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2548 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2553 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 " @@ -5220,13 +5581,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 "Commit messages should stand alone" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2553 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2558 msgid "" "You may include references to mailing list postings, benchmark result web " "sites, or code review links. However, the commit message should contain all " @@ -5234,8 +5595,8 @@ msgid "" "in the future." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2557 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2562 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 " @@ -5246,66 +5607,58 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2558 +#: documentation/content/en/articles/committers-guide/_index.adoc:2563 #, no-wrap msgid "Include appropriate metadata in a footer" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2561 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2566 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:2563 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2568 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:2565 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2570 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 " "times to avoid ambiguity or improve readability." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2567 -msgid "The key words or phrases are:" -msgstr "" - -#. type: Table +#. type: delimited block = 4 #: documentation/content/en/articles/committers-guide/_index.adoc:2572 -#, no-wrap -msgid "" -"[.informaltable]\n" -"[cols=\"20%,80%\", frame=\"none\"]" +msgid "The key words or phrases are:" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2573 +#: documentation/content/en/articles/committers-guide/_index.adoc:2578 #, no-wrap msgid "`PR:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2575 +#: documentation/content/en/articles/committers-guide/_index.adoc:2580 #, 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:2576 +#: documentation/content/en/articles/committers-guide/_index.adoc:2581 #, no-wrap msgid "`Reported by:`" 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 name and e-mail address of the person that reported the issue; for developers, just the username on the FreeBSD cluster.\n" @@ -5314,7 +5667,7 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2582 +#: documentation/content/en/articles/committers-guide/_index.adoc:2587 #, no-wrap msgid "" "`Submitted by:` +\n" @@ -5322,19 +5675,19 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2584 +#: documentation/content/en/articles/committers-guide/_index.adoc:2589 #, 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:2585 +#: documentation/content/en/articles/committers-guide/_index.adoc:2590 #, no-wrap msgid "`Reviewed by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2600 +#: documentation/content/en/articles/committers-guide/_index.adoc:2605 #, 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" @@ -5353,25 +5706,25 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2601 +#: documentation/content/en/articles/committers-guide/_index.adoc:2606 #, no-wrap msgid "`Tested by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2603 +#: documentation/content/en/articles/committers-guide/_index.adoc:2608 #, 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:2604 +#: documentation/content/en/articles/committers-guide/_index.adoc:2609 #, no-wrap msgid "`Discussed with:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2607 +#: documentation/content/en/articles/committers-guide/_index.adoc:2612 #, 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" @@ -5379,13 +5732,13 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2608 +#: documentation/content/en/articles/committers-guide/_index.adoc:2613 #, no-wrap msgid "`Approved by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2634 +#: documentation/content/en/articles/committers-guide/_index.adoc:2639 #, 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" @@ -5414,25 +5767,25 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2635 +#: documentation/content/en/articles/committers-guide/_index.adoc:2640 #, no-wrap msgid "`Obtained from:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2637 +#: documentation/content/en/articles/committers-guide/_index.adoc:2642 #, 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:2638 +#: documentation/content/en/articles/committers-guide/_index.adoc:2643 #, no-wrap msgid "`Fixes:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2641 +#: documentation/content/en/articles/committers-guide/_index.adoc:2646 #, 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" @@ -5440,97 +5793,97 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2642 +#: documentation/content/en/articles/committers-guide/_index.adoc:2647 #, no-wrap msgid "`MFC after:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2644 +#: documentation/content/en/articles/committers-guide/_index.adoc:2649 #, 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:2645 +#: documentation/content/en/articles/committers-guide/_index.adoc:2650 #, no-wrap msgid "`MFC to:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2647 +#: documentation/content/en/articles/committers-guide/_index.adoc:2652 #, 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:2648 +#: documentation/content/en/articles/committers-guide/_index.adoc:2653 #, no-wrap msgid "`MFH:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2650 +#: documentation/content/en/articles/committers-guide/_index.adoc:2655 #, 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:2651 +#: documentation/content/en/articles/committers-guide/_index.adoc:2656 #, no-wrap msgid "`Relnotes:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2653 +#: documentation/content/en/articles/committers-guide/_index.adoc:2658 #, 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:2654 +#: documentation/content/en/articles/committers-guide/_index.adoc:2659 #, no-wrap msgid "`Security:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2656 +#: documentation/content/en/articles/committers-guide/_index.adoc:2661 #, 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:2657 +#: documentation/content/en/articles/committers-guide/_index.adoc:2662 #, no-wrap msgid "`Event:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2659 +#: documentation/content/en/articles/committers-guide/_index.adoc:2664 #, 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:2660 +#: documentation/content/en/articles/committers-guide/_index.adoc:2665 #, no-wrap msgid "`Sponsored by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2662 +#: documentation/content/en/articles/committers-guide/_index.adoc:2667 #, 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:2663 +#: documentation/content/en/articles/committers-guide/_index.adoc:2668 #, no-wrap msgid "`Pull Request:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2667 +#: documentation/content/en/articles/committers-guide/_index.adoc:2672 #, 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" @@ -5539,13 +5892,13 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2668 +#: documentation/content/en/articles/committers-guide/_index.adoc:2673 #, no-wrap msgid "`Co-authored-by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2671 +#: documentation/content/en/articles/committers-guide/_index.adoc:2676 #, no-wrap msgid "" "The name and email address of an additional author of the commit.\n" @@ -5553,73 +5906,73 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2672 +#: documentation/content/en/articles/committers-guide/_index.adoc:2677 #, no-wrap msgid "`Signed-off-by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2674 +#: documentation/content/en/articles/committers-guide/_index.adoc:2679 #, no-wrap msgid "ID certifies compliance with https://developercertificate.org/" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2675 +#: documentation/content/en/articles/committers-guide/_index.adoc:2680 #, no-wrap msgid "`Differential Revision:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2677 +#: documentation/content/en/articles/committers-guide/_index.adoc:2682 #, 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:2679 +#: documentation/content/en/articles/committers-guide/_index.adoc:2684 #, 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:2685 +#: documentation/content/en/articles/committers-guide/_index.adoc:2690 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:2689 -#: documentation/content/en/articles/committers-guide/_index.adoc:2707 -#: documentation/content/en/articles/committers-guide/_index.adoc:2722 -#: documentation/content/en/articles/committers-guide/_index.adoc:2738 -#: documentation/content/en/articles/committers-guide/_index.adoc:2753 +#: 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 #, no-wrap msgid "...\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2691 +#: documentation/content/en/articles/committers-guide/_index.adoc:2696 #, no-wrap msgid "PR:\t\t12345\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2694 +#: documentation/content/en/articles/committers-guide/_index.adoc:2699 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:2697 +#: documentation/content/en/articles/committers-guide/_index.adoc:2702 #, no-wrap msgid "Commit Log for a Commit Needing Review" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2703 +#: documentation/content/en/articles/committers-guide/_index.adoc:2708 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 " @@ -5627,73 +5980,73 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2709 +#: documentation/content/en/articles/committers-guide/_index.adoc:2714 #, no-wrap msgid "Reviewed by:\t-arch\n" msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2713 +#: documentation/content/en/articles/committers-guide/_index.adoc:2718 #, no-wrap msgid "Commit Log for a Commit Needing Approval" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2718 +#: documentation/content/en/articles/committers-guide/_index.adoc:2723 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:2724 +#: documentation/content/en/articles/committers-guide/_index.adoc:2729 #, no-wrap msgid "Approved by:\tabc (maintainer)\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2727 +#: documentation/content/en/articles/committers-guide/_index.adoc:2732 msgid "Where _abc_ is the account name of the person who approved." msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2729 +#: documentation/content/en/articles/committers-guide/_index.adoc:2734 #, 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:2734 +#: documentation/content/en/articles/committers-guide/_index.adoc:2739 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:2740 +#: documentation/content/en/articles/committers-guide/_index.adoc:2745 #, no-wrap msgid "Obtained from:\tOpenBSD\n" msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2744 +#: documentation/content/en/articles/committers-guide/_index.adoc:2749 #, 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:2749 +#: documentation/content/en/articles/committers-guide/_index.adoc:2754 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:2755 +#: documentation/content/en/articles/committers-guide/_index.adoc:2760 #, no-wrap msgid "MFC after:\t2 weeks\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2758 +#: documentation/content/en/articles/committers-guide/_index.adoc:2763 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`, " @@ -5701,12 +6054,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2761 +#: documentation/content/en/articles/committers-guide/_index.adoc:2766 msgid "It is often necessary to combine these." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2765 +#: documentation/content/en/articles/committers-guide/_index.adoc:2770 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 " @@ -5716,19 +6069,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2767 +#: documentation/content/en/articles/committers-guide/_index.adoc:2772 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:2768 +#: documentation/content/en/articles/committers-guide/_index.adoc:2773 #, no-wrap msgid "Example Combined Commit Log" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2779 +#: documentation/content/en/articles/committers-guide/_index.adoc:2784 #, no-wrap msgid "" "PR:\t\t54321\n" @@ -5739,13 +6092,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2784 +#: documentation/content/en/articles/committers-guide/_index.adoc:2789 #, no-wrap msgid "Preferred License for New Files" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2790 +#: documentation/content/en/articles/committers-guide/_index.adoc:2795 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/" @@ -5755,14 +6108,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2792 +#: documentation/content/en/articles/committers-guide/_index.adoc:2797 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:2823 +#: documentation/content/en/articles/committers-guide/_index.adoc:2828 #, no-wrap msgid "" "/*\n" @@ -5796,7 +6149,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2829 +#: documentation/content/en/articles/committers-guide/_index.adoc:2834 msgid "" "The FreeBSD project strongly discourages the so-called \"advertising " "clause\" in new code. Due to the large number of contributors to the " @@ -5807,7 +6160,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2833 +#: documentation/content/en/articles/committers-guide/_index.adoc:2838 msgid "" "The FreeBSD project discourages completely new licenses and variations on " "the standard licenses. New licenses require the approval of {core-email} to " @@ -5818,7 +6171,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2837 +#: documentation/content/en/articles/committers-guide/_index.adoc:2842 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 " @@ -5829,7 +6182,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2840 +#: documentation/content/en/articles/committers-guide/_index.adoc:2845 msgid "" "Developers are reminded that in open source, getting \"open\" right is just " "as important as getting \"source\" right, as improper handling of " @@ -5838,13 +6191,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2842 +#: documentation/content/en/articles/committers-guide/_index.adoc:2847 #, no-wrap msgid "Keeping Track of Licenses Granted to the FreeBSD Project" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2847 +#: documentation/content/en/articles/committers-guide/_index.adoc:2852 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 " @@ -5855,7 +6208,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2852 +#: documentation/content/en/articles/committers-guide/_index.adoc:2857 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 " @@ -5865,13 +6218,13 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2854 +#: documentation/content/en/articles/committers-guide/_index.adoc:2859 msgid "" "Contact details for people or organizations granting the special license." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2855 +#: documentation/content/en/articles/committers-guide/_index.adoc:2860 msgid "" "What files, directories etc. in the repositories are covered by the license " "grant including the revision numbers where any specially licensed material " @@ -5879,7 +6232,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2856 +#: documentation/content/en/articles/committers-guide/_index.adoc:2861 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 " @@ -5887,24 +6240,24 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2857 +#: documentation/content/en/articles/committers-guide/_index.adoc:2862 msgid "The license text." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2858 +#: documentation/content/en/articles/committers-guide/_index.adoc:2863 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:2859 +#: documentation/content/en/articles/committers-guide/_index.adoc:2864 msgid "Any other relevant information." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2862 +#: documentation/content/en/articles/committers-guide/_index.adoc:2867 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 " @@ -5914,7 +6267,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2865 +#: documentation/content/en/articles/committers-guide/_index.adoc:2870 msgid "" "The license archive should contain only details of license grants; this is " "not the place for any discussions around licensing or other subjects. " @@ -5923,13 +6276,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2867 +#: documentation/content/en/articles/committers-guide/_index.adoc:2872 #, no-wrap msgid "SPDX Tags in the tree" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2878 +#: documentation/content/en/articles/committers-guide/_index.adoc:2883 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 " @@ -5948,20 +6301,20 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2880 +#: documentation/content/en/articles/committers-guide/_index.adoc:2885 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:2881 +#: documentation/content/en/articles/committers-guide/_index.adoc:2886 #, no-wrap msgid "Developer Relations" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2887 +#: documentation/content/en/articles/committers-guide/_index.adoc:2892 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 " @@ -5974,7 +6327,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2891 +#: documentation/content/en/articles/committers-guide/_index.adoc:2896 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 " @@ -5985,27 +6338,27 @@ msgid "" msgstr "" #. type: delimited block - 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2895 +#: documentation/content/en/articles/committers-guide/_index.adoc:2900 #, 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:2898 +#: documentation/content/en/articles/committers-guide/_index.adoc:2903 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:2903 +#: documentation/content/en/articles/committers-guide/_index.adoc:2908 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:2909 +#: documentation/content/en/articles/committers-guide/_index.adoc:2914 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 " @@ -6016,7 +6369,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2913 +#: documentation/content/en/articles/committers-guide/_index.adoc:2918 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 " @@ -6026,7 +6379,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2916 +#: documentation/content/en/articles/committers-guide/_index.adoc:2921 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 " @@ -6034,7 +6387,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2922 +#: documentation/content/en/articles/committers-guide/_index.adoc:2927 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 " @@ -6043,7 +6396,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2926 +#: documentation/content/en/articles/committers-guide/_index.adoc:2931 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 " @@ -6051,20 +6404,20 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2928 +#: documentation/content/en/articles/committers-guide/_index.adoc:2933 #, no-wrap msgid "If in Doubt..." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2932 +#: documentation/content/en/articles/committers-guide/_index.adoc:2937 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:2936 +#: documentation/content/en/articles/committers-guide/_index.adoc:2941 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 " @@ -6072,32 +6425,32 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2938 +#: documentation/content/en/articles/committers-guide/_index.adoc:2943 msgid "For project specific or administrative questions ask, in order:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2940 +#: documentation/content/en/articles/committers-guide/_index.adoc:2945 msgid "Your mentor or former mentor." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2941 +#: documentation/content/en/articles/committers-guide/_index.adoc:2946 msgid "An experienced committer on IRC, email, etc." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2942 +#: documentation/content/en/articles/committers-guide/_index.adoc:2947 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:2943 +#: documentation/content/en/articles/committers-guide/_index.adoc:2948 msgid "If still not sure, ask on {developers-name}." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2945 +#: documentation/content/en/articles/committers-guide/_index.adoc:2950 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 " @@ -6105,13 +6458,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2947 +#: documentation/content/en/articles/committers-guide/_index.adoc:2952 #, no-wrap msgid "Bugzilla" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2952 +#: documentation/content/en/articles/committers-guide/_index.adoc:2957 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 " @@ -6120,26 +6473,26 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2954 +#: documentation/content/en/articles/committers-guide/_index.adoc:2959 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:2958 +#: documentation/content/en/articles/committers-guide/_index.adoc:2963 msgid "Log in using your old account." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2959 +#: documentation/content/en/articles/committers-guide/_index.adoc:2964 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:2961 +#: documentation/content/en/articles/committers-guide/_index.adoc:2966 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 " @@ -6148,35 +6501,35 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2962 +#: documentation/content/en/articles/committers-guide/_index.adoc:2967 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:2965 +#: documentation/content/en/articles/committers-guide/_index.adoc:2970 msgid "You can find out more about Bugzilla at:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2967 +#: documentation/content/en/articles/committers-guide/_index.adoc:2972 msgid "extref:{pr-guidelines}[FreeBSD Problem Report Handling Guidelines]" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2968 +#: documentation/content/en/articles/committers-guide/_index.adoc:2973 msgid "link:https://www.FreeBSD.org/support/[https://www.FreeBSD.org/support]" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2970 +#: documentation/content/en/articles/committers-guide/_index.adoc:2975 #, no-wrap msgid "Phabricator" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2974 +#: documentation/content/en/articles/committers-guide/_index.adoc:2979 msgid "" "The FreeBSD Project utilizes https://reviews.freebsd.org[Phabricator] for " "code review requests. See the https://wiki.freebsd.org/" @@ -6184,19 +6537,28 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2976 +#: documentation/content/en/articles/committers-guide/_index.adoc:2982 +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 " +"create and update Phabricator reviews. This will make it easier for others " +"to review and test your patches." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2984 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:2980 +#: documentation/content/en/articles/committers-guide/_index.adoc:2988 msgid "Change your Phabricator account email to your `FreeBSD.org` email." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2982 +#: documentation/content/en/articles/committers-guide/_index.adoc:2990 msgid "" "Open new bug on our bug tracker using your `FreeBSD.org` account, see " "crossref:committers-guide[bugzilla, Bugzilla] for more information. Choose " @@ -6207,19 +6569,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2987 +#: documentation/content/en/articles/committers-guide/_index.adoc:2995 msgid "" "Phabricator accounts cannot be merged, please do not open a new account." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2990 +#: documentation/content/en/articles/committers-guide/_index.adoc:2998 #, no-wrap msgid "Who's Who" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2993 +#: documentation/content/en/articles/committers-guide/_index.adoc:3001 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. " @@ -6227,13 +6589,13 @@ msgid "" msgstr "" #. type: Labeled list -#: documentation/content/en/articles/committers-guide/_index.adoc:2994 +#: documentation/content/en/articles/committers-guide/_index.adoc:3002 #, no-wrap msgid "`{doceng}`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3000 +#: documentation/content/en/articles/committers-guide/_index.adoc:3008 msgid "" "doceng is the group responsible for the documentation build infrastructure, " "approving new documentation committers, and ensuring that the FreeBSD " @@ -6247,13 +6609,13 @@ msgid "" msgstr "" #. type: Labeled list -#: documentation/content/en/articles/committers-guide/_index.adoc:3001 +#: documentation/content/en/articles/committers-guide/_index.adoc:3009 #, no-wrap msgid "`{re-members}`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3006 +#: documentation/content/en/articles/committers-guide/_index.adoc:3014 msgid "" "These are the members of the `{re}`. This team is responsible for setting " "release deadlines and controlling the release process. During code freezes, " @@ -6264,20 +6626,20 @@ msgid "" msgstr "" #. type: Labeled list -#: documentation/content/en/articles/committers-guide/_index.adoc:3007 +#: documentation/content/en/articles/committers-guide/_index.adoc:3015 #, no-wrap msgid "`{so}`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3009 +#: documentation/content/en/articles/committers-guide/_index.adoc:3017 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:3014 +#: documentation/content/en/articles/committers-guide/_index.adoc:3022 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 " @@ -6286,7 +6648,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3019 +#: documentation/content/en/articles/committers-guide/_index.adoc:3027 msgid "" "{developers-name}:: All committers are subscribed to -developers. This list " "was created to be a forum for the committers \"community\" issues. Examples " @@ -6294,7 +6656,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3023 +#: documentation/content/en/articles/committers-guide/_index.adoc:3031 msgid "" "The {developers-name} is for the exclusive use of FreeBSD committers. To " "develop FreeBSD, committers must have the ability to openly discuss matters " @@ -6304,7 +6666,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3027 +#: documentation/content/en/articles/committers-guide/_index.adoc:3035 msgid "" "All FreeBSD committers are expected not to not publish or forward messages " "from the {developers-name} outside the list membership without permission of " @@ -6314,7 +6676,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3033 +#: documentation/content/en/articles/committers-guide/_index.adoc:3041 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 " @@ -6327,13 +6689,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3034 +#: documentation/content/en/articles/committers-guide/_index.adoc:3042 #, no-wrap msgid "SSH Quick-Start Guide" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3039 +#: documentation/content/en/articles/committers-guide/_index.adoc:3047 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 " @@ -6344,19 +6706,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3040 +#: documentation/content/en/articles/committers-guide/_index.adoc:3048 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:3044 +#: documentation/content/en/articles/committers-guide/_index.adoc:3052 msgid "Only ECDSA, Ed25519 or RSA keys are supported." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3046 +#: documentation/content/en/articles/committers-guide/_index.adoc:3054 msgid "" "Send your public key ([.filename]#$HOME/.ssh/id_ecdsa.pub#, " "[.filename]#$HOME/.ssh/id_ed25519.pub#, or [.filename]#$HOME/.ssh/" @@ -6365,7 +6727,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3051 +#: documentation/content/en/articles/committers-guide/_index.adoc:3059 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 " @@ -6374,32 +6736,32 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3053 +#: documentation/content/en/articles/committers-guide/_index.adoc:3061 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:3055 +#: documentation/content/en/articles/committers-guide/_index.adoc:3063 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:3057 +#: documentation/content/en/articles/committers-guide/_index.adoc:3065 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:3059 +#: documentation/content/en/articles/committers-guide/_index.adoc:3067 #, no-wrap msgid "Coverity(R) Availability for FreeBSD Committers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3063 +#: documentation/content/en/articles/committers-guide/_index.adoc:3071 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 " @@ -6408,7 +6770,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3066 +#: documentation/content/en/articles/committers-guide/_index.adoc:3074 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/" @@ -6419,7 +6781,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3068 +#: documentation/content/en/articles/committers-guide/_index.adoc:3076 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 " @@ -6427,13 +6789,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3070 +#: documentation/content/en/articles/committers-guide/_index.adoc:3078 #, no-wrap msgid "The FreeBSD Committers' Big List of Rules" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3075 +#: documentation/content/en/articles/committers-guide/_index.adoc:3083 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-" @@ -6444,25 +6806,25 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3077 -#: documentation/content/en/articles/committers-guide/_index.adoc:3107 +#: documentation/content/en/articles/committers-guide/_index.adoc:3085 +#: documentation/content/en/articles/committers-guide/_index.adoc:3115 msgid "Respect other committers." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3078 -#: documentation/content/en/articles/committers-guide/_index.adoc:3123 +#: documentation/content/en/articles/committers-guide/_index.adoc:3086 +#: documentation/content/en/articles/committers-guide/_index.adoc:3131 msgid "Respect other contributors." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3079 -#: documentation/content/en/articles/committers-guide/_index.adoc:3138 +#: documentation/content/en/articles/committers-guide/_index.adoc:3087 +#: documentation/content/en/articles/committers-guide/_index.adoc:3146 msgid "Discuss any significant change _before_ committing." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3080 +#: documentation/content/en/articles/committers-guide/_index.adoc:3088 msgid "" "Respect existing maintainers (if listed in the `MAINTAINER` field in " "[.filename]#Makefile# or in [.filename]#MAINTAINER# in the top-level " @@ -6470,8 +6832,8 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3081 -#: documentation/content/en/articles/committers-guide/_index.adoc:3153 +#: documentation/content/en/articles/committers-guide/_index.adoc:3089 +#: documentation/content/en/articles/committers-guide/_index.adoc:3161 msgid "" "Any disputed change must be backed out pending resolution of the dispute if " "requested by a maintainer. Security related changes may override a " @@ -6479,7 +6841,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3082 +#: documentation/content/en/articles/committers-guide/_index.adoc:3090 msgid "" "Changes go to FreeBSD-CURRENT before FreeBSD-STABLE unless specifically " "permitted by the release engineer or unless they are not applicable to " @@ -6491,40 +6853,40 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3083 -#: documentation/content/en/articles/committers-guide/_index.adoc:3168 +#: documentation/content/en/articles/committers-guide/_index.adoc:3091 +#: documentation/content/en/articles/committers-guide/_index.adoc:3176 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:3084 +#: documentation/content/en/articles/committers-guide/_index.adoc:3092 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:3085 -#: documentation/content/en/articles/committers-guide/_index.adoc:3183 +#: documentation/content/en/articles/committers-guide/_index.adoc:3093 +#: documentation/content/en/articles/committers-guide/_index.adoc:3191 msgid "When in doubt on any procedure, ask first!" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3086 -#: documentation/content/en/articles/committers-guide/_index.adoc:3188 +#: documentation/content/en/articles/committers-guide/_index.adoc:3094 +#: documentation/content/en/articles/committers-guide/_index.adoc:3196 msgid "Test your changes before committing them." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3087 -#: documentation/content/en/articles/committers-guide/_index.adoc:3198 +#: documentation/content/en/articles/committers-guide/_index.adoc:3095 +#: documentation/content/en/articles/committers-guide/_index.adoc:3206 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:3098 +#: documentation/content/en/articles/committers-guide/_index.adoc:3106 msgid "" "As noted, breaking some of these rules can be grounds for suspension or, " "upon repeated offense, permanent removal of commit privileges. Individual " @@ -6550,7 +6912,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3102 +#: documentation/content/en/articles/committers-guide/_index.adoc:3110 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 " @@ -6561,13 +6923,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3103 +#: documentation/content/en/articles/committers-guide/_index.adoc:3111 #, no-wrap msgid "Details" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3111 +#: documentation/content/en/articles/committers-guide/_index.adoc:3119 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 " @@ -6579,7 +6941,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3113 +#: documentation/content/en/articles/committers-guide/_index.adoc:3121 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 " @@ -6589,7 +6951,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3119 +#: documentation/content/en/articles/committers-guide/_index.adoc:3127 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 " @@ -6608,7 +6970,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3122 +#: documentation/content/en/articles/committers-guide/_index.adoc:3130 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 " @@ -6616,7 +6978,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3135 +#: documentation/content/en/articles/committers-guide/_index.adoc:3143 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 " @@ -6630,14 +6992,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3137 +#: documentation/content/en/articles/committers-guide/_index.adoc:3145 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:3144 +#: documentation/content/en/articles/committers-guide/_index.adoc:3152 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 " @@ -6653,17 +7015,17 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3146 +#: documentation/content/en/articles/committers-guide/_index.adoc:3154 msgid "When in doubt, ask for review!" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3147 +#: documentation/content/en/articles/committers-guide/_index.adoc:3155 msgid "Respect existing maintainers if listed." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3152 +#: documentation/content/en/articles/committers-guide/_index.adoc:3160 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, " @@ -6679,7 +7041,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3158 +#: documentation/content/en/articles/committers-guide/_index.adoc:3166 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 " @@ -6697,7 +7059,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3159 +#: documentation/content/en/articles/committers-guide/_index.adoc:3167 msgid "" "Changes go to FreeBSD-CURRENT before FreeBSD-STABLE unless specifically " "permitted by the release engineer or unless they are not applicable to " @@ -6708,7 +7070,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3165 +#: documentation/content/en/articles/committers-guide/_index.adoc:3173 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 " @@ -6727,7 +7089,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3167 +#: documentation/content/en/articles/committers-guide/_index.adoc:3175 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 " @@ -6735,7 +7097,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3178 +#: documentation/content/en/articles/committers-guide/_index.adoc:3186 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. " @@ -6760,14 +7122,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3179 +#: documentation/content/en/articles/committers-guide/_index.adoc:3187 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:3182 +#: documentation/content/en/articles/committers-guide/_index.adoc:3190 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 " @@ -6778,7 +7140,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3187 +#: documentation/content/en/articles/committers-guide/_index.adoc:3195 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, " @@ -6790,7 +7152,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3197 +#: documentation/content/en/articles/committers-guide/_index.adoc:3205 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 " @@ -6806,14 +7168,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3200 +#: documentation/content/en/articles/committers-guide/_index.adoc:3208 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:3205 +#: documentation/content/en/articles/committers-guide/_index.adoc:3213 msgid "" "The trees mentioned above are for contributed software usually imported onto " "a vendor branch. Committing something there may cause unnecessary headaches " @@ -6823,7 +7185,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3209 +#: documentation/content/en/articles/committers-guide/_index.adoc:3217 msgid "" "Reasons for modifying upstream software range from wanting strict control " "over a tightly coupled dependency to lack of portability in the canonical " @@ -6835,7 +7197,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3212 +#: documentation/content/en/articles/committers-guide/_index.adoc:3220 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 " @@ -6843,27 +7205,27 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3213 +#: documentation/content/en/articles/committers-guide/_index.adoc:3221 #, no-wrap msgid "Policy on Multiple Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3216 +#: documentation/content/en/articles/committers-guide/_index.adoc:3224 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:3219 +#: documentation/content/en/articles/committers-guide/_index.adoc:3227 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:3223 +#: documentation/content/en/articles/committers-guide/_index.adoc:3231 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 " @@ -6874,13 +7236,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3225 +#: documentation/content/en/articles/committers-guide/_index.adoc:3233 #, no-wrap msgid "Policy on Multiple Compilers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3239 +#: documentation/content/en/articles/committers-guide/_index.adoc:3247 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 " @@ -6907,7 +7269,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3244 +#: documentation/content/en/articles/committers-guide/_index.adoc:3252 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 " @@ -6916,7 +7278,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3259 +#: documentation/content/en/articles/committers-guide/_index.adoc:3267 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 " @@ -6937,7 +7299,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3263 +#: documentation/content/en/articles/committers-guide/_index.adoc:3271 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 " @@ -6946,7 +7308,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3269 +#: documentation/content/en/articles/committers-guide/_index.adoc:3277 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 " @@ -6959,7 +7321,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3273 +#: documentation/content/en/articles/committers-guide/_index.adoc:3281 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 " @@ -6969,7 +7331,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3279 +#: documentation/content/en/articles/committers-guide/_index.adoc:3287 msgid "" "The FreeBSD project provides headers and libraries that allow other " "compilers to be used to build software not in the base system. These " @@ -6984,7 +7346,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3284 +#: documentation/content/en/articles/committers-guide/_index.adoc:3292 msgid "" "The FreeBSD build system currently accommodates these different " "environments. As new warnings are added to compilers, the project tries to " @@ -6996,13 +7358,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3285 +#: documentation/content/en/articles/committers-guide/_index.adoc:3293 #, no-wrap msgid "Current Compiler Versions" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3288 +#: documentation/content/en/articles/committers-guide/_index.adoc:3296 msgid "" "The versions of supported compilers for a given branch such as `main` or " "`stable/X` varies over time. The authoritative source for supported " @@ -7011,7 +7373,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3292 +#: documentation/content/en/articles/committers-guide/_index.adoc:3300 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 " @@ -7019,13 +7381,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3293 +#: documentation/content/en/articles/committers-guide/_index.adoc:3301 #, no-wrap msgid "Other Suggestions" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3297 +#: documentation/content/en/articles/committers-guide/_index.adoc:3305 msgid "" "When committing documentation changes, use a spell checker before " "committing. For all XML docs, verify that the formatting directives are " @@ -7033,7 +7395,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3299 +#: documentation/content/en/articles/committers-guide/_index.adoc:3307 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 " @@ -7042,7 +7404,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3306 +#: documentation/content/en/articles/committers-guide/_index.adoc:3314 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 " @@ -7055,20 +7417,20 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3307 +#: documentation/content/en/articles/committers-guide/_index.adoc:3315 #, no-wrap msgid "Deprecating Features" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3310 +#: documentation/content/en/articles/committers-guide/_index.adoc:3318 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:3312 +#: documentation/content/en/articles/committers-guide/_index.adoc:3320 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 " @@ -7076,14 +7438,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3313 +#: documentation/content/en/articles/committers-guide/_index.adoc:3321 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:3314 +#: documentation/content/en/articles/committers-guide/_index.adoc:3322 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 " @@ -7091,18 +7453,18 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3315 +#: documentation/content/en/articles/committers-guide/_index.adoc:3323 #, no-wrap msgid "Privacy and Confidentiality" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3318 +#: documentation/content/en/articles/committers-guide/_index.adoc:3326 msgid "Most FreeBSD business is done in public." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3321 +#: documentation/content/en/articles/committers-guide/_index.adoc:3329 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 " @@ -7110,12 +7472,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3322 +#: documentation/content/en/articles/committers-guide/_index.adoc:3330 msgid "Certain sensitive matters must remain private or held under embargo." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3328 +#: documentation/content/en/articles/committers-guide/_index.adoc:3336 msgid "" "There unfortunately cannot be complete transparency. As a FreeBSD developer " "you will have a certain degree of privileged access to information. " @@ -7126,14 +7488,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3329 +#: documentation/content/en/articles/committers-guide/_index.adoc:3337 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:3334 +#: documentation/content/en/articles/committers-guide/_index.adoc:3342 msgid "" "Where there are security problems that affect many different operating " "systems, FreeBSD frequently depends on early access to be able to prepare " @@ -7146,13 +7508,13 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3335 +#: documentation/content/en/articles/committers-guide/_index.adoc:3343 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:3340 +#: documentation/content/en/articles/committers-guide/_index.adoc:3348 msgid "" "Communications to core will initially be treated as confidential. " "Eventually however, most of Core's business will be summarized into the " @@ -7163,14 +7525,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3341 +#: documentation/content/en/articles/committers-guide/_index.adoc:3349 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:3344 +#: documentation/content/en/articles/committers-guide/_index.adoc:3352 msgid "" "Access to certain commercially sensitive data may only be available under a " "Non-Disclosure Agreement. The FreeBSD Foundation legal staff must be " @@ -7178,12 +7540,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3345 +#: documentation/content/en/articles/committers-guide/_index.adoc:3353 msgid "Private communications must not be made public without permission." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3348 +#: documentation/content/en/articles/committers-guide/_index.adoc:3356 msgid "" "Beyond the specific requirements above there is a general expectation not to " "publish private communications between developers without the consent of all " @@ -7193,14 +7555,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3349 +#: documentation/content/en/articles/committers-guide/_index.adoc:3357 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:3352 +#: documentation/content/en/articles/committers-guide/_index.adoc:3360 msgid "" "Similarly to personal communications, certain internal communications " "channels, including FreeBSD Committer only mailing lists and restricted " @@ -7209,12 +7571,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3353 +#: documentation/content/en/articles/committers-guide/_index.adoc:3361 msgid "Core may approve publication." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3355 +#: documentation/content/en/articles/committers-guide/_index.adoc:3363 msgid "" "Where it is impractical to obtain permission due to the number of " "correspondents or where permission to publish is unreasonably withheld, Core " @@ -7223,13 +7585,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3357 +#: documentation/content/en/articles/committers-guide/_index.adoc:3365 #, no-wrap msgid "Support for Multiple Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3364 +#: documentation/content/en/articles/committers-guide/_index.adoc:3372 msgid "" "FreeBSD is a highly portable operating system intended to function on many " "different types of hardware architectures. Maintaining clean separation of " @@ -7245,13 +7607,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3365 +#: documentation/content/en/articles/committers-guide/_index.adoc:3373 #, no-wrap msgid "Statement of General Intent" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3370 +#: documentation/content/en/articles/committers-guide/_index.adoc:3378 msgid "" "The FreeBSD Project targets \"production quality commercial off-the-shelf " "(COTS) workstation, server, and high-end embedded systems\". By retaining a " @@ -7267,7 +7629,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3377 +#: documentation/content/en/articles/committers-guide/_index.adoc:3385 msgid "" "The FreeBSD Project differentiates platform targets into four tiers. Each " "tier includes a list of guarantees consumers may rely on as well as " @@ -7281,13 +7643,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3378 +#: documentation/content/en/articles/committers-guide/_index.adoc:3386 #, no-wrap msgid "Platform Targets" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3385 +#: documentation/content/en/articles/committers-guide/_index.adoc:3393 msgid "" "Support for a hardware platform consists of two components: kernel support " "and userland Application Binary Interfaces (ABIs). Kernel platform support " @@ -7302,7 +7664,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3387 +#: documentation/content/en/articles/committers-guide/_index.adoc:3395 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 " @@ -7311,7 +7673,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3392 +#: documentation/content/en/articles/committers-guide/_index.adoc:3400 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 " @@ -7322,20 +7684,20 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3394 +#: documentation/content/en/articles/committers-guide/_index.adoc:3402 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:3395 +#: documentation/content/en/articles/committers-guide/_index.adoc:3403 #, no-wrap msgid "Tier 1: Fully-Supported Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3400 +#: documentation/content/en/articles/committers-guide/_index.adoc:3408 msgid "" "Tier 1 platforms are the most mature FreeBSD platforms. They are supported " "by the security officer, release engineering, and Ports Management Team. " @@ -7345,42 +7707,42 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3402 +#: documentation/content/en/articles/committers-guide/_index.adoc:3410 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:3404 +#: documentation/content/en/articles/committers-guide/_index.adoc:3412 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:3405 +#: documentation/content/en/articles/committers-guide/_index.adoc:3413 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:3406 +#: documentation/content/en/articles/committers-guide/_index.adoc:3414 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:3407 +#: documentation/content/en/articles/committers-guide/_index.adoc:3415 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:3408 +#: documentation/content/en/articles/committers-guide/_index.adoc:3416 msgid "" "Changes to userland ABIs will generally include compatibility shims to " "ensure correct operation of binaries compiled against any stable branch " @@ -7390,7 +7752,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3409 +#: documentation/content/en/articles/committers-guide/_index.adoc:3417 msgid "" "Changes to certain portions of the kernel ABI will include compatibility " "shims to ensure correct operation of kernel modules compiled against the " @@ -7399,7 +7761,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3410 +#: documentation/content/en/articles/committers-guide/_index.adoc:3418 msgid "" "Official binary packages for third party software will be provided by the " "ports team. For embedded architectures, these packages may be cross-built " @@ -7407,21 +7769,21 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3411 +#: documentation/content/en/articles/committers-guide/_index.adoc:3419 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:3412 +#: documentation/content/en/articles/committers-guide/_index.adoc:3420 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:3413 +#: documentation/content/en/articles/committers-guide/_index.adoc:3421 msgid "" "Features and compatibility shims used by binaries compiled against older " "stable branches may be removed in newer major versions. Such removals will " @@ -7429,19 +7791,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3414 +#: documentation/content/en/articles/committers-guide/_index.adoc:3422 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:3415 +#: documentation/content/en/articles/committers-guide/_index.adoc:3423 msgid "Tier 1 platforms will be included in the source tree." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3416 +#: documentation/content/en/articles/committers-guide/_index.adoc:3424 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 " @@ -7449,14 +7811,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3418 +#: documentation/content/en/articles/committers-guide/_index.adoc:3426 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:3420 +#: documentation/content/en/articles/committers-guide/_index.adoc:3428 msgid "" "Build and test automation support either in the FreeBSD.org cluster or some " "other location easily available for all developers. Embedded platforms may " @@ -7465,41 +7827,41 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3421 -#: documentation/content/en/articles/committers-guide/_index.adoc:3451 +#: documentation/content/en/articles/committers-guide/_index.adoc:3429 +#: documentation/content/en/articles/committers-guide/_index.adoc:3459 msgid "Inclusion in the `make universe` and `make tinderbox` targets." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3422 +#: documentation/content/en/articles/committers-guide/_index.adoc:3430 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:3424 +#: documentation/content/en/articles/committers-guide/_index.adoc:3432 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:3426 +#: documentation/content/en/articles/committers-guide/_index.adoc:3434 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:3427 +#: documentation/content/en/articles/committers-guide/_index.adoc:3435 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:3428 +#: documentation/content/en/articles/committers-guide/_index.adoc:3436 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 " @@ -7508,7 +7870,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3429 +#: documentation/content/en/articles/committers-guide/_index.adoc:3437 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 " @@ -7516,7 +7878,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3430 +#: documentation/content/en/articles/committers-guide/_index.adoc:3438 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 " @@ -7524,13 +7886,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3431 +#: documentation/content/en/articles/committers-guide/_index.adoc:3439 #, no-wrap msgid "Tier 2: Developmental and Niche Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3435 +#: documentation/content/en/articles/committers-guide/_index.adoc:3443 msgid "" "Tier 2 platforms are functional, but less mature FreeBSD platforms. They " "are not supported by the security officer, release engineering, and Ports " @@ -7538,7 +7900,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3439 +#: documentation/content/en/articles/committers-guide/_index.adoc:3447 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 " @@ -7548,14 +7910,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3441 +#: documentation/content/en/articles/committers-guide/_index.adoc:3449 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:3443 +#: documentation/content/en/articles/committers-guide/_index.adoc:3451 msgid "" "The ports infrastructure should include basic support for Tier 2 " "architectures sufficient to support building ports and packages. This " @@ -7564,19 +7926,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3444 +#: documentation/content/en/articles/committers-guide/_index.adoc:3452 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:3445 +#: documentation/content/en/articles/committers-guide/_index.adoc:3453 msgid "Tier 2 platforms will be included in the source tree." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3446 +#: documentation/content/en/articles/committers-guide/_index.adoc:3454 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 " @@ -7584,41 +7946,41 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3447 +#: documentation/content/en/articles/committers-guide/_index.adoc:3455 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:3449 +#: documentation/content/en/articles/committers-guide/_index.adoc:3457 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:3453 +#: documentation/content/en/articles/committers-guide/_index.adoc:3461 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:3455 +#: documentation/content/en/articles/committers-guide/_index.adoc:3463 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:3456 +#: documentation/content/en/articles/committers-guide/_index.adoc:3464 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:3457 +#: documentation/content/en/articles/committers-guide/_index.adoc:3465 msgid "" "While changes are permitted to break the userland ABI, the ABI should not be " "broken gratuitously. Significant userland ABI changes should be restricted " @@ -7626,20 +7988,20 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3458 +#: documentation/content/en/articles/committers-guide/_index.adoc:3466 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:3459 +#: documentation/content/en/articles/committers-guide/_index.adoc:3467 #, no-wrap msgid "Tier 3: Experimental Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3463 +#: documentation/content/en/articles/committers-guide/_index.adoc:3471 msgid "" "Tier 3 platforms have at least partial FreeBSD support. They are _not_ " "supported by the security officer, release engineering, and Ports Management " @@ -7647,7 +8009,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3466 +#: documentation/content/en/articles/committers-guide/_index.adoc:3474 msgid "" "Tier 3 platforms are architectures in the early stages of development, for " "non-mainstream hardware platforms, or which are considered legacy systems " @@ -7656,7 +8018,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3469 +#: documentation/content/en/articles/committers-guide/_index.adoc:3477 msgid "" "The FreeBSD Project provides no guarantees to consumers of Tier 3 platforms " "and is not committed to maintaining resources to support development. Tier " @@ -7665,20 +8027,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3470 +#: documentation/content/en/articles/committers-guide/_index.adoc:3478 #, no-wrap msgid "Unsupported Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3474 +#: documentation/content/en/articles/committers-guide/_index.adoc:3482 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:3477 +#: documentation/content/en/articles/committers-guide/_index.adoc:3485 msgid "" "After a platform transitions to unsupported, all support for the platform is " "removed from the source, ports and documentation trees. Note that ports " @@ -7687,13 +8049,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3478 +#: documentation/content/en/articles/committers-guide/_index.adoc:3486 #, no-wrap msgid "Policy on Changing the Tier of an Architecture" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3482 +#: documentation/content/en/articles/committers-guide/_index.adoc:3490 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 " @@ -7703,25 +8065,25 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3484 +#: documentation/content/en/articles/committers-guide/_index.adoc:3492 #, no-wrap msgid "Ports Specific FAQ" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3487 +#: documentation/content/en/articles/committers-guide/_index.adoc:3495 #, no-wrap msgid "Adding a New Port" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3490 +#: documentation/content/en/articles/committers-guide/_index.adoc:3498 #, no-wrap msgid "How do I add a new port?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3495 +#: documentation/content/en/articles/committers-guide/_index.adoc:3503 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-" @@ -7731,20 +8093,20 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3499 +#: documentation/content/en/articles/committers-guide/_index.adoc:3507 #, no-wrap msgid "\tSUBDIR += newport\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3502 +#: documentation/content/en/articles/committers-guide/_index.adoc:3510 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:3507 +#: documentation/content/en/articles/committers-guide/_index.adoc:3515 #, no-wrap msgid "" "% git add category/Makefile category/newport\n" @@ -7753,7 +8115,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3511 +#: documentation/content/en/articles/committers-guide/_index.adoc:3519 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 " @@ -7761,19 +8123,19 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3514 +#: documentation/content/en/articles/committers-guide/_index.adoc:3522 #, 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:3517 +#: documentation/content/en/articles/committers-guide/_index.adoc:3525 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:3520 +#: documentation/content/en/articles/committers-guide/_index.adoc:3528 msgid "" "The extref:{porters-handbook}testing[Porters Handbook's Testing Chapter] " "contains more detailed instructions. See the extref:{porters-handbook}" @@ -7782,14 +8144,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3522 +#: documentation/content/en/articles/committers-guide/_index.adoc:3530 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:3524 +#: documentation/content/en/articles/committers-guide/_index.adoc:3532 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 " @@ -7797,14 +8159,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3527 +#: documentation/content/en/articles/committers-guide/_index.adoc:3535 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:3531 +#: documentation/content/en/articles/committers-guide/_index.adoc:3539 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 " @@ -7812,7 +8174,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3541 +#: documentation/content/en/articles/committers-guide/_index.adoc:3549 #, no-wrap msgid "" "# make install\n" @@ -7825,85 +8187,85 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3544 +#: documentation/content/en/articles/committers-guide/_index.adoc:3552 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:3547 +#: documentation/content/en/articles/committers-guide/_index.adoc:3555 #, no-wrap msgid "Removing an Existing Port" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3550 +#: documentation/content/en/articles/committers-guide/_index.adoc:3558 #, no-wrap msgid "How do I remove an existing port?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3553 +#: documentation/content/en/articles/committers-guide/_index.adoc:3561 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:3555 +#: documentation/content/en/articles/committers-guide/_index.adoc:3563 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:3556 +#: documentation/content/en/articles/committers-guide/_index.adoc:3564 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:3557 +#: documentation/content/en/articles/committers-guide/_index.adoc:3565 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:3561 +#: documentation/content/en/articles/committers-guide/_index.adoc:3569 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:3564 +#: documentation/content/en/articles/committers-guide/_index.adoc:3572 msgid "Then, remove the port:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3568 +#: documentation/content/en/articles/committers-guide/_index.adoc:3576 msgid "Remove the port's files and directory with `git rm`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3569 +#: documentation/content/en/articles/committers-guide/_index.adoc:3577 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:3570 -#: documentation/content/en/articles/committers-guide/_index.adoc:3585 +#: documentation/content/en/articles/committers-guide/_index.adoc:3578 +#: documentation/content/en/articles/committers-guide/_index.adoc:3593 msgid "Add an entry to [.filename]#ports/MOVED#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3571 +#: documentation/content/en/articles/committers-guide/_index.adoc:3579 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:3576 +#: documentation/content/en/articles/committers-guide/_index.adoc:3584 msgid "" "Alternatively, you can use the rmport script, from [.filename]#ports/Tools/" "scripts#. This script was written by {vd}. When sending questions about " @@ -7912,13 +8274,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3578 +#: documentation/content/en/articles/committers-guide/_index.adoc:3586 #, 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:3583 +#: documentation/content/en/articles/committers-guide/_index.adoc:3591 msgid "" "Perform a thorough check of the ports collection for any dependencies on the " "old port location/name, and update them. Running `grep` on " @@ -7928,14 +8290,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3584 +#: documentation/content/en/articles/committers-guide/_index.adoc:3592 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:3586 +#: documentation/content/en/articles/committers-guide/_index.adoc:3594 msgid "" "Search for entries in xml files inside [.filename]#ports/security/vuxml# and " "adjust them accordingly. In particular, check for previous packages with the " @@ -7943,51 +8305,51 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3587 +#: documentation/content/en/articles/committers-guide/_index.adoc:3595 msgid "Move the port with `git mv`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3588 -#: documentation/content/en/articles/committers-guide/_index.adoc:3599 +#: documentation/content/en/articles/committers-guide/_index.adoc:3596 +#: documentation/content/en/articles/committers-guide/_index.adoc:3607 msgid "Commit the changes." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3591 +#: documentation/content/en/articles/committers-guide/_index.adoc:3599 #, 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:3596 +#: documentation/content/en/articles/committers-guide/_index.adoc:3604 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:3597 +#: documentation/content/en/articles/committers-guide/_index.adoc:3605 msgid "Add the new port to the [.filename]#new-cat/Makefile#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3598 +#: documentation/content/en/articles/committers-guide/_index.adoc:3606 msgid "Change stuff in [.filename]#new-cat/new-port#." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3602 +#: documentation/content/en/articles/committers-guide/_index.adoc:3610 #, no-wrap msgid "Ports Freeze" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3605 +#: documentation/content/en/articles/committers-guide/_index.adoc:3613 #, no-wrap msgid "What is a “ports freeze”?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3612 +#: documentation/content/en/articles/committers-guide/_index.adoc:3620 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 " @@ -7998,7 +8360,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3615 +#: documentation/content/en/articles/committers-guide/_index.adoc:3623 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 " @@ -8006,32 +8368,32 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3617 +#: documentation/content/en/articles/committers-guide/_index.adoc:3625 #, no-wrap msgid "Quarterly Branches" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3620 +#: documentation/content/en/articles/committers-guide/_index.adoc:3628 #, 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:3623 +#: documentation/content/en/articles/committers-guide/_index.adoc:3631 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:3625 +#: documentation/content/en/articles/committers-guide/_index.adoc:3633 #, 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:3628 +#: documentation/content/en/articles/committers-guide/_index.adoc:3636 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 " @@ -8039,7 +8401,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3634 +#: documentation/content/en/articles/committers-guide/_index.adoc:3642 #, no-wrap msgid "" "% git checkout 2021Q2\n" @@ -8049,7 +8411,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3638 +#: documentation/content/en/articles/committers-guide/_index.adoc:3646 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` " @@ -8057,19 +8419,19 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3640 +#: documentation/content/en/articles/committers-guide/_index.adoc:3648 #, no-wrap msgid "Creating a New Category" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3643 +#: documentation/content/en/articles/committers-guide/_index.adoc:3651 #, no-wrap msgid "What is the procedure for creating a new category?" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3648 +#: documentation/content/en/articles/committers-guide/_index.adoc:3656 msgid "" "Please see extref:{porters-handbook}[Proposing a New Category, proposing-" "categories] in the Porter's Handbook. Once that procedure has been followed " @@ -8078,42 +8440,42 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3652 +#: documentation/content/en/articles/committers-guide/_index.adoc:3660 msgid "Perform any needed moves. (This only applies to physical categories.)" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3653 +#: documentation/content/en/articles/committers-guide/_index.adoc:3661 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:3654 +#: documentation/content/en/articles/committers-guide/_index.adoc:3662 msgid "Assign the PR back to you." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3657 +#: documentation/content/en/articles/committers-guide/_index.adoc:3665 #, 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:3662 +#: documentation/content/en/articles/committers-guide/_index.adoc:3670 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:3664 +#: documentation/content/en/articles/committers-guide/_index.adoc:3672 msgid "To do this, you will need to:" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3668 +#: documentation/content/en/articles/committers-guide/_index.adoc:3676 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 " @@ -8121,7 +8483,7 @@ msgid "" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3669 +#: documentation/content/en/articles/committers-guide/_index.adoc:3677 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 " @@ -8130,14 +8492,14 @@ msgid "" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3670 +#: documentation/content/en/articles/committers-guide/_index.adoc:3678 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:3673 +#: documentation/content/en/articles/committers-guide/_index.adoc:3681 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 " @@ -8147,7 +8509,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3675 +#: documentation/content/en/articles/committers-guide/_index.adoc:3683 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 " @@ -8157,7 +8519,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3676 +#: documentation/content/en/articles/committers-guide/_index.adoc:3684 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 " @@ -8169,7 +8531,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3677 +#: documentation/content/en/articles/committers-guide/_index.adoc:3685 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 " @@ -8177,25 +8539,25 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3678 +#: documentation/content/en/articles/committers-guide/_index.adoc:3686 msgid "Add appropriate entries to [.filename]#ports/MOVED#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3679 +#: documentation/content/en/articles/committers-guide/_index.adoc:3687 msgid "Update the documentation by modifying:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3680 -#: documentation/content/en/articles/committers-guide/_index.adoc:3689 +#: documentation/content/en/articles/committers-guide/_index.adoc:3688 +#: documentation/content/en/articles/committers-guide/_index.adoc:3697 msgid "" "the extref:{porters-handbook}[list of categories, PORTING-CATEGORIES] in the " "Porter's Handbook" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3682 +#: documentation/content/en/articles/committers-guide/_index.adoc:3690 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 " @@ -8203,38 +8565,38 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3684 +#: documentation/content/en/articles/committers-guide/_index.adoc:3692 #, 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:3687 +#: documentation/content/en/articles/committers-guide/_index.adoc:3695 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:3691 -#: documentation/content/en/articles/committers-guide/_index.adoc:3785 +#: documentation/content/en/articles/committers-guide/_index.adoc:3699 +#: documentation/content/en/articles/committers-guide/_index.adoc:3793 #, no-wrap msgid "Miscellaneous Questions" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3694 +#: documentation/content/en/articles/committers-guide/_index.adoc:3702 #, 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:3697 +#: documentation/content/en/articles/committers-guide/_index.adoc:3705 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:3699 +#: documentation/content/en/articles/committers-guide/_index.adoc:3707 msgid "" "Most infrastructure changes to a port (that is, modernizing, but not " "changing the functionality). For example, the blanket covers converting to " @@ -8243,19 +8605,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3700 +#: documentation/content/en/articles/committers-guide/_index.adoc:3708 msgid "Trivial and _tested_ build and runtime fixes." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3701 +#: documentation/content/en/articles/committers-guide/_index.adoc:3709 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:3706 +#: documentation/content/en/articles/committers-guide/_index.adoc:3714 msgid "" "Exceptions to this are anything maintained by the {portmgr}, or the " "{security-officer}. No unauthorized commits may ever be made to ports " @@ -8263,20 +8625,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3709 +#: documentation/content/en/articles/committers-guide/_index.adoc:3717 #, 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:3713 +#: documentation/content/en/articles/committers-guide/_index.adoc:3721 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:3715 +#: documentation/content/en/articles/committers-guide/_index.adoc:3723 msgid "" "Reports for all the package builds (official, experimental, and non-" "regression) are aggregated at link:pkg-status.FreeBSD.org[pkg-" @@ -8284,26 +8646,26 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3717 +#: documentation/content/en/articles/committers-guide/_index.adoc:3725 #, 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:3720 +#: documentation/content/en/articles/committers-guide/_index.adoc:3728 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:3722 +#: documentation/content/en/articles/committers-guide/_index.adoc:3730 #, 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:3726 +#: documentation/content/en/articles/committers-guide/_index.adoc:3734 msgid "" "Any file directly under [.filename]#ports/#, or any file under a " "subdirectory that starts with an uppercase letter ([.filename]#Mk/#, " @@ -8313,13 +8675,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3728 +#: documentation/content/en/articles/committers-guide/_index.adoc:3736 #, 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:3732 +#: documentation/content/en/articles/committers-guide/_index.adoc:3740 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 " @@ -8332,20 +8694,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3734 +#: documentation/content/en/articles/committers-guide/_index.adoc:3742 #, 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:3738 +#: documentation/content/en/articles/committers-guide/_index.adoc:3746 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:3740 +#: documentation/content/en/articles/committers-guide/_index.adoc:3748 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 " @@ -8353,22 +8715,22 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3744 +#: documentation/content/en/articles/committers-guide/_index.adoc:3752 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:3745 +#: documentation/content/en/articles/committers-guide/_index.adoc:3753 msgid "Select the product your patch is about." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3746 +#: documentation/content/en/articles/committers-guide/_index.adoc:3754 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:3747 +#: documentation/content/en/articles/committers-guide/_index.adoc:3755 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 " @@ -8376,56 +8738,56 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3748 +#: documentation/content/en/articles/committers-guide/_index.adoc:3756 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:3749 +#: documentation/content/en/articles/committers-guide/_index.adoc:3757 msgid "Submit. Wait for the build to run." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3750 +#: documentation/content/en/articles/committers-guide/_index.adoc:3758 msgid "{portmgr} will reply with a possible fallout." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3751 +#: documentation/content/en/articles/committers-guide/_index.adoc:3759 msgid "Depending on the fallout:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3752 +#: documentation/content/en/articles/committers-guide/_index.adoc:3760 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:3753 +#: documentation/content/en/articles/committers-guide/_index.adoc:3761 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:3754 +#: documentation/content/en/articles/committers-guide/_index.adoc:3762 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:3757 +#: documentation/content/en/articles/committers-guide/_index.adoc:3765 #, no-wrap msgid "Issues Specific to Developers Who Are Not Committers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3762 +#: documentation/content/en/articles/committers-guide/_index.adoc:3770 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 " @@ -8434,17 +8796,17 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3764 +#: documentation/content/en/articles/committers-guide/_index.adoc:3772 msgid "crossref:committers-guide[admin, Administrative Details]" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3765 +#: documentation/content/en/articles/committers-guide/_index.adoc:3773 msgid "crossref:committers-guide[conventions-everyone, For Everyone]" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3769 +#: documentation/content/en/articles/committers-guide/_index.adoc:3777 msgid "" "Get your mentor to add you to the \"Additional Contributors\" " "([.filename]#doc/shared/contrib-additional.adoc#), if you are not already " @@ -8452,48 +8814,48 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3771 +#: documentation/content/en/articles/committers-guide/_index.adoc:3779 msgid "crossref:committers-guide[developer.relations, Developer Relations]" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3772 +#: documentation/content/en/articles/committers-guide/_index.adoc:3780 msgid "crossref:committers-guide[ssh.guide, SSH Quick-Start Guide]" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3773 +#: documentation/content/en/articles/committers-guide/_index.adoc:3781 msgid "" "crossref:committers-guide[rules, The FreeBSD Committers' Big List of Rules]" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3775 +#: documentation/content/en/articles/committers-guide/_index.adoc:3783 #, no-wrap msgid "Information About Google Analytics" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3778 +#: documentation/content/en/articles/committers-guide/_index.adoc:3786 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:3782 +#: documentation/content/en/articles/committers-guide/_index.adoc:3790 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:3787 +#: documentation/content/en/articles/committers-guide/_index.adoc:3795 #, 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:3791 +#: documentation/content/en/articles/committers-guide/_index.adoc:3799 msgid "" "`people.FreeBSD.org` is the same as `freefall.FreeBSD.org`. Just create a " "[.filename]#public_html# directory. Anything you place in that directory " @@ -8502,45 +8864,45 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3792 +#: documentation/content/en/articles/committers-guide/_index.adoc:3800 #, no-wrap msgid "Where are the mailing list archives stored?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3795 +#: documentation/content/en/articles/committers-guide/_index.adoc:3803 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:3796 +#: documentation/content/en/articles/committers-guide/_index.adoc:3804 #, 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:3799 +#: documentation/content/en/articles/committers-guide/_index.adoc:3807 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:3801 +#: documentation/content/en/articles/committers-guide/_index.adoc:3809 #, no-wrap msgid "Benefits and Perks for FreeBSD Committers" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3804 +#: documentation/content/en/articles/committers-guide/_index.adoc:3812 #, no-wrap msgid "Recognition" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3808 +#: documentation/content/en/articles/committers-guide/_index.adoc:3816 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 " @@ -8548,33 +8910,33 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3810 +#: documentation/content/en/articles/committers-guide/_index.adoc:3818 #, no-wrap msgid "FreeBSD Mall" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3813 +#: documentation/content/en/articles/committers-guide/_index.adoc:3821 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:3815 +#: documentation/content/en/articles/committers-guide/_index.adoc:3823 #, no-wrap msgid "`Gandi.net`" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3818 +#: documentation/content/en/articles/committers-guide/_index.adoc:3826 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:3822 +#: documentation/content/en/articles/committers-guide/_index.adoc:3830 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 " @@ -8584,20 +8946,20 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3824 +#: documentation/content/en/articles/committers-guide/_index.adoc:3832 #, no-wrap msgid "`rsync.net`" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3827 +#: documentation/content/en/articles/committers-guide/_index.adoc:3835 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:3828 +#: documentation/content/en/articles/committers-guide/_index.adoc:3836 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/" |