diff options
Diffstat (limited to 'documentation/content/en/articles')
41 files changed, 3932 insertions, 3308 deletions
diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index 71bb302151..1a61f5f7e4 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 @@ -533,7 +532,7 @@ e.g.: .... so that won't be covered in depth here. -If you want to build a custom kernel, extref:{handbook}[the kernel config section, kernelconfig] of the FreeBSD Handbook recommends creating a file MYKERNEL under sys/${ARCH}/conf with your changes against GENERIC. +If you want to build a custom kernel, extref:{handbook}kernelconfig[the kernel config section, kernelconfig] of the FreeBSD Handbook recommends creating a file MYKERNEL under sys/${ARCH}/conf with your changes against GENERIC. To have MYKERNEL disregarded by Git, it can be added to .git/info/exclude. ===== Updating @@ -688,9 +687,9 @@ The ports tree operates the same way. The branch names are different and the repositories are in different locations. The cgit repository web interface for use with web browsers is at https://cgit.FreeBSD.org/ports/ . -The production Git repository is at https://git.FreeBSD.org/ports.git and at ssh://anongit@git.FreeBSD.org/ports.git (or anongit@git.FreeBSD.org:ports.git). +The production Git repository is at https://git.FreeBSD.org/ports.git and at ssh://anongit@git.FreeBSD.org/ports.git (or `anongit@git.FreeBSD.org:ports.git`). -There is also a mirror on GitHub, see extref:{handbook}/mirrors[External mirrors, mirrors] for an overview. +There is also a mirror on GitHub, see extref:{handbook}mirrors[External mirrors, mirrors] for an overview. The _latest_ branch is `main`. The _quarterly_ branches are named `yyyyQn` for year 'yyyy' and quarter 'n'. @@ -1396,7 +1395,7 @@ Here 'good' means: . All the right files, and none of the wrong ones, were merged into contrib/glorbnitz. . No other changes are in the tree. . 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. -. UPDATING should be updated if there is anything of note, such as user visible changes, important upgrade concerns, etc. +. `RELNOTES` and `UPDATING` should be updated if there is anything of note, such as user visible changes, important upgrade concerns, etc. [NOTE] ==== @@ -1976,11 +1975,11 @@ 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]. [source,shell] -```` +.... % git remote -v freebsd https://git.freebsd.org/src.git (fetch) freebsd ssh://git@gitrepo.freebsd.org/src.git (push) -```` +.... 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/getting-started-with-github/fork-a-repo[guidelines]. The destination of the fork should be your own, personal, GitHub account (gvnn3 in my case). @@ -2200,6 +2199,12 @@ It is very important to have a current PGP/GnuPG key in the repository. The key [.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. + Add an entry for each additional mentor/mentee relationship in the bottom section. +. Update git mailmap file ++ +[.filename]#src/.mailmap#, [.filename]#doc/.mailmap#, and [.filename]#ports/.mailmap# - Add an entry for commits you created prior to becoming a FreeBSD committer. ++ +Mapping to your FreeBSD address allows us to track external committers who may be ready for a commit bit more easily. +You can also use this to correct old names, mispelled names, etc in the default `git log` output. . Generate a Kerberos Password + 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). @@ -2654,6 +2659,10 @@ We include the commit title so that the referenced commit can be located even in |`Relnotes:` |If the change is a candidate for inclusion in the release notes for the next release from the branch, set to `yes`. +|Candidates are user-visible changes, new features, compatibility breaks, etc.. +|If you forget to set this line, or want to provide more details, add an entry to the `RELNOTES` file in the root of the src tree. +|The `RELNOTES` file is used to generate release notes for the next release. +|Do not use the `Relnotes:` line to describe the change: its only valid value is `yes`. |`Security:` |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. @@ -3154,7 +3163,7 @@ When in doubt, ask for review! . Respect existing maintainers if listed. + Many parts of FreeBSD are not "owned" in the sense that any specific individual will jump up and yell if you commit a change to "their" area, but it still pays to check first. -One convention we use is to put a maintainer line in the [.filename]#Makefile# for any package or subtree which is being actively maintained by one or more people; see extref:{developers-handbook}[Source Tree Guidelines and Policies, policies] for documentation on this. +One convention we use is to put a maintainer line in the [.filename]#Makefile# for any package or subtree which is being actively maintained by one or more people; see extref:{developers-handbook}policies[Source Tree Guidelines and Policies, policies] for documentation on this. Where sections of code have several maintainers, commits to affected areas by one maintainer need to be reviewed by at least one other maintainer. In cases where the "maintainer-ship" of something is not clear, look at the repository logs for the files in question and see if someone has been working recently or predominantly in that area. . Any disputed change must be backed out pending resolution of the dispute if requested by a maintainer. Security related changes may override a maintainer's wishes at the Security Officer's discretion. @@ -3294,9 +3303,32 @@ Developers should be mindful of this, and ensure any compiler specific flags are The versions of supported compilers for a given branch such as `main` or `stable/X` varies over time. The authoritative source for supported compiler versions are automated CI jobs tested in GitHub's cross-build actions and Jenkins. -For `main`, the in-tree compiler is currently Clang 19. -Currently, GCC 12, 13, and 14 are tested for amd64 via CI jobs in Jenkins. -Clang 14 and 18 are tested for aarch64 and arm64 in GitHub's cross-build actions. +[.tblbasic] +[cols="10*",options="header",] +|=== +|Branch | In-tree Compiler +|llvm12 | llvm13 | llvm14 | llvm15 | llvm18 +|amd64-gcc12 | amd64-gcc13 | amd64-gcc14 + +|main | llvm 19 +| | | | Y | Y +| Y | Y | Y + +|stable/15 | llvm 19 +| | | Y | | Y +| Y | Y | Y + +|stable/14 | llvm 19 +| Y | Y | Y | | +| Y | | Y + +|stable/13 | llvm 19 +| Y | Y | Y | | +| Y | | Y +|=== + +GCC toolchains are tested for amd64 via CI jobs in Jenkins. +LLVM toolchains are tested for aarch64 and arm64 in GitHub's cross-build actions. === Other Suggestions @@ -3650,7 +3682,7 @@ The `-x` parameter ensures the hash `$HASH` of the `main` branch is included in [[ports-qa-new-category-how]] ==== What is the procedure for creating a new category? -Please see extref:{porters-handbook}[Proposing a New Category, proposing-categories] in the Porter's Handbook. +Please see extref:{porters-handbook}makefiles[Proposing a New Category, proposing-categories] in the Porter's Handbook. Once that procedure has been followed and the PR has been assigned to the {portmgr}, it is their decision whether or not to approve it. If they do, it is their responsibility to: @@ -3684,7 +3716,7 @@ To do this, use the [.filename]#chkorigin.sh# tool: `env PORTSDIR=/path/to/ports . Once this is done, you can commit the updated [.filename]#ports/Makefile# to connect the new category to the build and also commit the [.filename]#Makefile# changes for the old category or categories. . Add appropriate entries to [.filename]#ports/MOVED#. . Update the documentation by modifying: -** the extref:{porters-handbook}[list of categories, PORTING-CATEGORIES] in the Porter's Handbook +** the extref:{porters-handbook}makefiles[list of categories, porting-categories] in the Porter's Handbook + . 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 previous locations in the repository. ==== @@ -3693,7 +3725,7 @@ To do this, use the [.filename]#chkorigin.sh# tool: `env PORTSDIR=/path/to/ports This is much simpler than a physical category. Only a few modifications are needed: -* the extref:{porters-handbook}[list of categories, PORTING-CATEGORIES] in the Porter's Handbook +* the extref:{porters-handbook}makefiles[list of categories, porting-categories] in the Porter's Handbook [[ports-qa-misc-questions]] === Miscellaneous Questions @@ -3719,7 +3751,7 @@ No unauthorized commits may ever be made to ports maintained by those groups. The packages are built multiple times each week. If a port fails, the maintainer will receive an email from `pkg-fallout@FreeBSD.org`. -Reports for all the package builds (official, experimental, and non-regression) are aggregated at link:pkg-status.FreeBSD.org[pkg-status.FreeBSD.org]. +Reports for all the package builds (official, experimental, and non-regression) are aggregated at link:https://pkg-status.FreeBSD.org[pkg-status.FreeBSD.org]. [[ports-qa-misc-INDEX]] ==== I added a new port. Do I need to add it to the [.filename]#INDEX#? diff --git a/documentation/content/en/articles/committers-guide/_index.po b/documentation/content/en/articles/committers-guide/_index.po index 9585f882ca..2746286d86 100644 --- a/documentation/content/en/articles/committers-guide/_index.po +++ b/documentation/content/en/articles/committers-guide/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2025-06-29 21:20+0100\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -394,20 +394,20 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:193 +#: documentation/content/en/articles/committers-guide/_index.adoc:192 msgid "" "Committing the new key is shown in crossref:committers-guide[commit-steps, " "Steps for New Committers]." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:195 +#: documentation/content/en/articles/committers-guide/_index.adoc:194 #, no-wrap msgid "Kerberos and LDAP web Password for FreeBSD Cluster" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:200 +#: documentation/content/en/articles/committers-guide/_index.adoc:199 msgid "" "The FreeBSD cluster requires a Kerberos password to access certain " "services. The Kerberos password also serves as the LDAP web password, since " @@ -416,48 +416,43 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:202 +#: documentation/content/en/articles/committers-guide/_index.adoc:201 msgid "https://bugs.freebsd.org/bugzilla[Bugzilla]" msgstr "" #. type: delimited block = 4 #: documentation/content/en/articles/committers-guide/_index.adoc:203 -msgid "https://ci.freebsd.org[Jenkins]" -msgstr "" - -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:205 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:207 #, 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:212 msgid "This must be done from a machine outside of the FreeBSD.org cluster." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:217 +#: documentation/content/en/articles/committers-guide/_index.adoc:215 msgid "" "A Kerberos password can also be set manually by logging into " "`freefall.FreeBSD.org` and running:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:221 +#: documentation/content/en/articles/committers-guide/_index.adoc:219 #, no-wrap msgid "% kpasswd\n" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:227 +#: documentation/content/en/articles/committers-guide/_index.adoc:225 msgid "" "Unless the Kerberos-authenticated services of the FreeBSD.org cluster have " "been used previously, `Client unknown` will be shown. This error means that " @@ -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:228 #, 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:234 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:240 #, 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:241 #, no-wrap msgid "__Responsible__" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:245 +#: documentation/content/en/articles/committers-guide/_index.adoc:243 #, no-wrap msgid "__Tree Components__" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:246 +#: documentation/content/en/articles/committers-guide/_index.adoc:244 #, no-wrap msgid "src" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:247 +#: documentation/content/en/articles/committers-guide/_index.adoc:245 #, no-wrap msgid "srcmgr@" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:249 +#: documentation/content/en/articles/committers-guide/_index.adoc:247 #, no-wrap msgid "src/" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:250 +#: documentation/content/en/articles/committers-guide/_index.adoc:248 #, no-wrap msgid "doc" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:251 +#: documentation/content/en/articles/committers-guide/_index.adoc:249 #, no-wrap msgid "doceng@" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:253 +#: documentation/content/en/articles/committers-guide/_index.adoc:251 #, no-wrap msgid "doc/, ports/, src/ documentation" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:254 +#: documentation/content/en/articles/committers-guide/_index.adoc:252 #, no-wrap msgid "ports" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:255 +#: documentation/content/en/articles/committers-guide/_index.adoc:253 #, no-wrap msgid "portmgr@" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:256 +#: documentation/content/en/articles/committers-guide/_index.adoc:254 #, no-wrap msgid "ports/" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:261 +#: documentation/content/en/articles/committers-guide/_index.adoc:259 msgid "" "Commit bits allocated prior to the development of the notion of areas of " "authority may be appropriate for use in many parts of the tree. However, " @@ -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:261 msgid "" "Committers are encouraged to seek review for their work as part of the " "normal development process, regardless of the area of the tree where the " @@ -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:262 #, 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:265 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:266 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:268 msgid "" "Any committer may make changes to any other tree with an \"Approved by\" " "from a non-mentored committer with the appropriate bit. Mentored committers " @@ -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:269 msgid "" "Committers can acquire an additional bit by the usual process of finding a " "mentor who will propose them to srcmgr, doceng, or portmgr, as appropriate. " @@ -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:271 #, 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:275 msgid "" "Some types of fixes have \"blanket approval\" from the {doceng}, allowing " "any committer to fix those categories of problems on any part of the doc " @@ -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:277 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:279 msgid "Typos" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:282 +#: documentation/content/en/articles/committers-guide/_index.adoc:280 msgid "Trivial fixes" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:284 +#: documentation/content/en/articles/committers-guide/_index.adoc:282 msgid "" "Punctuation, URLs, dates, paths and file names with outdated or incorrect " "information, and other common mistakes that may confound the readers." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:287 +#: documentation/content/en/articles/committers-guide/_index.adoc:285 msgid "" "Over the years, some implicit approvals were granted in the doc tree. This " "list shows the most common cases:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:289 +#: documentation/content/en/articles/committers-guide/_index.adoc:287 msgid "" "Changes in [.filename]#documentation/content/en/books/porters-handbook/" "versions/_index.adoc#" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:291 +#: documentation/content/en/articles/committers-guide/_index.adoc:289 msgid "" "extref:{porters-handbook}versions/[__FreeBSD_version Values (Porter's " "Handbook)], mainly used for src committers." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:292 +#: documentation/content/en/articles/committers-guide/_index.adoc:290 msgid "Changes in [.filename]#doc/shared/contrib-additional.adoc#" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:294 +#: documentation/content/en/articles/committers-guide/_index.adoc:292 msgid "" "extref:{contributors}[Additional FreeBSD Contributors, contrib-additional] " "maintenance." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:295 +#: documentation/content/en/articles/committers-guide/_index.adoc:293 msgid "All link:#commit-steps[Steps for New Committers], doc related" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:296 +#: documentation/content/en/articles/committers-guide/_index.adoc:294 msgid "Security advisories; Errata Notices; Releases;" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:298 +#: documentation/content/en/articles/committers-guide/_index.adoc:296 msgid "Used by {security-officer} and {re}." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:299 +#: documentation/content/en/articles/committers-guide/_index.adoc:297 msgid "Changes in [.filename]#website/content/en/donations/donors.adoc#" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:301 +#: documentation/content/en/articles/committers-guide/_index.adoc:299 msgid "Used by {donations}." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:303 +#: documentation/content/en/articles/committers-guide/_index.adoc:301 msgid "" "Before any commit, a build test is necessary; see the 'Overview' and 'The " "FreeBSD Documentation Build Process' sections of the extref:{fdp-primer}" @@ -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:303 #, 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:306 #, 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:313 msgid "" "When one searches for \"Git Primer\" a number of good ones come up. Daniel " "Miessler's link:https://danielmiessler.com/study/git/[A git primer] and " @@ -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:315 msgid "" "This document will assume that you've read through it and will try not to " "belabor the basics (though it will cover them briefly)." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:319 +#: documentation/content/en/articles/committers-guide/_index.adoc:317 #, no-wrap msgid "Git Mini Primer" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:322 +#: documentation/content/en/articles/committers-guide/_index.adoc:320 msgid "" "This primer is less ambitiously scoped than the old Subversion Primer, but " "should cover the basics." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:323 +#: documentation/content/en/articles/committers-guide/_index.adoc:321 #, no-wrap msgid "Scope" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:329 +#: documentation/content/en/articles/committers-guide/_index.adoc:327 msgid "" "If you want to download FreeBSD, compile it from sources, and generally keep " "up to date that way, this primer is for you. It covers getting the sources, " @@ -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:331 msgid "" "The goal of this section is to highlight those bits of Git needed to track " "sources. They assume a basic understanding of Git. There are many primers " @@ -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:333 #, 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:336 msgid "" "This section describes the read-write access for committers to push the " "commits from developers or contributors." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:340 +#: documentation/content/en/articles/committers-guide/_index.adoc:338 #, no-wrap msgid "Daily use" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:345 +#: documentation/content/en/articles/committers-guide/_index.adoc:343 msgid "" "In the examples below, replace `${repo}` with the name of the desired " "FreeBSD repository: `doc`, `ports`, or `src`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:348 +#: documentation/content/en/articles/committers-guide/_index.adoc:346 msgid "Clone the repository:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:352 +#: documentation/content/en/articles/committers-guide/_index.adoc:350 #, no-wrap msgid "% git clone -o freebsd --config remote.freebsd.fetch='+refs/notes/*:refs/notes/*' https://git.freebsd.org/${repo}.git\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:355 +#: documentation/content/en/articles/committers-guide/_index.adoc:353 msgid "Then you should have the official mirrors as your remote:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:361 +#: documentation/content/en/articles/committers-guide/_index.adoc:359 #, 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:362 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:365 msgid "" "The commit hook in repo.freebsd.org checks the \"Commit\" field matches the " "committer's information in FreeBSD.org. The easiest way to get the " @@ -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:372 #, 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:375 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:379 #, no-wrap msgid "% git remote set-url --push freebsd git@gitrepo.freebsd.org:${repo}.git\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:384 +#: documentation/content/en/articles/committers-guide/_index.adoc:382 msgid "" "Then you should have separated fetch and push URLs as the most efficient " "setup:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:390 +#: documentation/content/en/articles/committers-guide/_index.adoc:388 #, 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:391 msgid "" "Again, note that `gitrepo.freebsd.org` has been canonicalized to " "`repo.freebsd.org`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:395 +#: documentation/content/en/articles/committers-guide/_index.adoc:393 msgid "Install commit message template hook:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:397 +#: documentation/content/en/articles/committers-guide/_index.adoc:395 msgid "For doc repository:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:402 +#: documentation/content/en/articles/committers-guide/_index.adoc:400 #, 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:403 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:407 #, 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:410 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:415 #, 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:418 #, 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:421 msgid "" "The `access` and `mentors` files are stored in an orphan branch, `internal/" "admin`, in each repository." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:425 +#: documentation/content/en/articles/committers-guide/_index.adoc:423 msgid "" "Following example is how to check out the `internal/admin` branch to a local " "branch named `admin`:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:431 +#: documentation/content/en/articles/committers-guide/_index.adoc:429 #, 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:431 msgid "Alternatively, you can add a worktree for the `admin` branch:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:437 +#: documentation/content/en/articles/committers-guide/_index.adoc:435 #, no-wrap msgid "git worktree add -b admin ../${repo}-admin internal/admin\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:441 +#: documentation/content/en/articles/committers-guide/_index.adoc:439 msgid "" "For browsing `internal/admin` branch on web: `https://cgit.freebsd.org/$" "{repo}/log/?h=internal/admin`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:443 +#: documentation/content/en/articles/committers-guide/_index.adoc:441 msgid "For pushing, specify the full refspec:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:447 +#: documentation/content/en/articles/committers-guide/_index.adoc:445 #, no-wrap msgid "git push freebsd HEAD:refs/internal/admin\n" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:449 +#: documentation/content/en/articles/committers-guide/_index.adoc:447 #, no-wrap msgid "Keeping Current With The FreeBSD src Tree" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:456 +#: documentation/content/en/articles/committers-guide/_index.adoc:454 msgid "" "First step: cloning a tree. This downloads the entire tree. There are two " "ways to download. Most people will want to do a deep clone of the " @@ -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:455 #, 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:457 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:459 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:461 msgid "For FreeBSD-STABLE, branch names include `stable/12` and `stable/13`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:465 +#: documentation/content/en/articles/committers-guide/_index.adoc:463 msgid "" "For FreeBSD-RELEASE, release engineering branch names include `releng/12.4` " "and `releng/13.2`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:467 +#: documentation/content/en/articles/committers-guide/_index.adoc:465 msgid "https://www.freebsd.org/releng/[] shows:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:469 +#: documentation/content/en/articles/committers-guide/_index.adoc:467 msgid "`main` and `stable/⋯` branches open" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:470 +#: documentation/content/en/articles/committers-guide/_index.adoc:468 msgid "`releng/⋯` branches, each of which is frozen when a release is tagged." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:472 +#: documentation/content/en/articles/committers-guide/_index.adoc:470 msgid "Examples:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:474 +#: documentation/content/en/articles/committers-guide/_index.adoc:472 msgid "" "tag https://cgit.freebsd.org/src/tag/?h=release/13.1.0[release/13.1.0] on " "the https://cgit.freebsd.org/src/log/?h=releng/13.1[releng/13.1] branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:475 +#: documentation/content/en/articles/committers-guide/_index.adoc:473 msgid "" "tag https://cgit.freebsd.org/src/tag/?h=release/13.2.0[release/13.2.0] on " "the https://cgit.freebsd.org/src/log/?h=releng/13.2[releng/13.2] branch." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:476 +#: documentation/content/en/articles/committers-guide/_index.adoc:474 #, no-wrap msgid "Repositories" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:479 +#: documentation/content/en/articles/committers-guide/_index.adoc:477 msgid "" "Please see the crossref:committers-guide[admin,Administrative Details] for " "the latest information on where to get FreeBSD sources. $URL below can be " @@ -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:480 msgid "" "Note: The project doesn't use submodules as they are a poor fit for our " "workflows and development model. How we track changes in third-party " @@ -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:481 #, 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:485 msgid "" "A deep clone pulls in the entire tree, as well as all the history and " "branches. It is the easiest to do. It also allows you to use Git's " @@ -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:488 #, no-wrap msgid "% git clone -o freebsd $URL -b branch [<directory>]\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:495 +#: documentation/content/en/articles/committers-guide/_index.adoc:493 msgid "" "will create a deep clone. `branch` should be one of the branches listed in " "the previous section. If no `branch` is given: the default (`main`) will be " @@ -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:498 msgid "" "You will want a deep clone if you are interested in the history, plan on " "making local changes, or plan on working on more than one branch. It is the " @@ -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:499 #, 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:505 msgid "" "A shallow clone copies just the most current code, but none or little of the " "history. This can be useful when you need to build a specific revision of " @@ -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:509 #, no-wrap msgid "% git clone -o freebsd -b branch --depth 1 $URL [dir]\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:516 +#: documentation/content/en/articles/committers-guide/_index.adoc:514 msgid "" "This clones the repository, but only has the most recent version in the " "repository. The rest of the history is not downloaded. Should you change " @@ -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:519 msgid "" "When you make a shallow clone, you will lose the commit count in your uname " "output. This can make it more difficult to determine if your system needs " @@ -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:521 #, 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:525 msgid "" "Once you've downloaded, building is done as described in the handbook, e.g.:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:534 +#: documentation/content/en/articles/committers-guide/_index.adoc:532 #, no-wrap msgid "" "% cd src\n" @@ -1211,40 +1206,41 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:536 +#: documentation/content/en/articles/committers-guide/_index.adoc:534 msgid "so that won't be covered in depth here." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:539 +#: documentation/content/en/articles/committers-guide/_index.adoc:537 msgid "" -"If you want to build a custom kernel, extref:{handbook}[the kernel config " -"section, kernelconfig] of the FreeBSD Handbook recommends creating a file " -"MYKERNEL under sys/${ARCH}/conf with your changes against GENERIC. To have " -"MYKERNEL disregarded by Git, it can be added to .git/info/exclude." +"If you want to build a custom kernel, extref:{handbook}kernelconfig[the " +"kernel config section, kernelconfig] of the FreeBSD Handbook recommends " +"creating a file MYKERNEL under sys/${ARCH}/conf with your changes against " +"GENERIC. To have MYKERNEL disregarded by Git, it can be added to .git/info/" +"exclude." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:540 +#: documentation/content/en/articles/committers-guide/_index.adoc:538 #, no-wrap msgid "Updating" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:544 +#: documentation/content/en/articles/committers-guide/_index.adoc:542 msgid "" "To update both types of trees uses the same commands. This pulls in all the " "revisions since your last update." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:547 +#: documentation/content/en/articles/committers-guide/_index.adoc:545 #, no-wrap msgid "% git pull --ff-only\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:552 +#: documentation/content/en/articles/committers-guide/_index.adoc:550 msgid "" "will update the tree. In Git, a 'fast forward' merge is one that only needs " "to set a new branch pointer and doesn't need to re-create the commits. By " @@ -1254,7 +1250,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:555 +#: documentation/content/en/articles/committers-guide/_index.adoc:553 msgid "" "See below for how to manage local changes. The simplest is to use `--" "autostash` on the `git pull` command, but more sophisticated options are " @@ -1262,20 +1258,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:556 +#: documentation/content/en/articles/committers-guide/_index.adoc:554 #, no-wrap msgid "Selecting a Specific Version" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:560 +#: documentation/content/en/articles/committers-guide/_index.adoc:558 msgid "" "In Git, `git checkout` checks out both branches and specific versions. " "Git's versions are the long hashes rather than a sequential number." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:562 +#: documentation/content/en/articles/committers-guide/_index.adoc:560 msgid "" "When you checkout a specific version, just specify the hash you want on the " "command line (the git log command can help you decide which hash you might " @@ -1283,26 +1279,26 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:565 +#: documentation/content/en/articles/committers-guide/_index.adoc:563 #, no-wrap msgid "% git checkout 08b8197a74\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:568 +#: documentation/content/en/articles/committers-guide/_index.adoc:566 msgid "" "and you have that checked out. You will be greeted with a message similar " "to the following:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:571 +#: documentation/content/en/articles/committers-guide/_index.adoc:569 #, no-wrap msgid "Note: checking out '08b8197a742a96964d2924391bf9fdfeb788865d'.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:575 +#: documentation/content/en/articles/committers-guide/_index.adoc:573 #, no-wrap msgid "" "You are in a 'detached HEAD' state. You can look around, make experimental\n" @@ -1311,28 +1307,29 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:578 +#: documentation/content/en/articles/committers-guide/_index.adoc:576 +#: documentation/content/en/articles/committers-guide/_index.adoc:1745 #, no-wrap msgid "" "If you want to create a new branch to retain commits you create, you may\n" "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:578 +#: documentation/content/en/articles/committers-guide/_index.adoc:1747 #, no-wrap msgid " git checkout -b <new-branch-name>\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:582 +#: documentation/content/en/articles/committers-guide/_index.adoc:580 #, no-wrap msgid "HEAD is now at 08b8197a742a hook gpiokeys.4 to the build\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:586 +#: documentation/content/en/articles/committers-guide/_index.adoc:584 msgid "" "where the last line is generated from the hash you are checking out and the " "first line of the commit message from that revision. The hash can be " @@ -1341,13 +1338,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:587 +#: documentation/content/en/articles/committers-guide/_index.adoc:585 #, no-wrap msgid "Bisecting" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:591 +#: documentation/content/en/articles/committers-guide/_index.adoc:589 msgid "" "Sometimes, things go wrong. The last version worked, but the one you just " "updated to does not. A developer may ask you to bisect the problem to track " @@ -1355,7 +1352,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:596 +#: documentation/content/en/articles/committers-guide/_index.adoc:594 msgid "" "Git makes bisecting changes easy with a powerful `git bisect` command. " "Here's a brief outline of how to use it. For more information, you can view " @@ -1367,7 +1364,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:603 +#: documentation/content/en/articles/committers-guide/_index.adoc:601 msgid "" "`git bisect start --first-parent` will start the bisection process. Next, " "you need to tell a range to go through. `git bisect good XXXXXX` will tell " @@ -1380,14 +1377,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:607 +#: documentation/content/en/articles/committers-guide/_index.adoc:605 msgid "" "If you want to know the last version you checked out, you should use `git " "reflog`:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:612 +#: documentation/content/en/articles/committers-guide/_index.adoc:610 #, no-wrap msgid "" "5ef0bd68b515 (HEAD -> main, freebsd/main, freebsd/HEAD) HEAD@{0}: pull --ff-only: Fast-forward\n" @@ -1396,7 +1393,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:616 +#: documentation/content/en/articles/committers-guide/_index.adoc:614 msgid "" "shows me moving the working tree to the `main` branch (a816...) and then " "updating from upstream (to 5ef0...). In this case, bad would be HEAD (or " @@ -1407,7 +1404,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:620 +#: documentation/content/en/articles/committers-guide/_index.adoc:618 msgid "" "Set the 'good' version first, then set the bad (though the order doesn't " "matter). When you set the bad version, it will give you some statistics on " @@ -1415,7 +1412,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:627 +#: documentation/content/en/articles/committers-guide/_index.adoc:625 #, no-wrap msgid "" "% git bisect start --first-parent\n" @@ -1426,7 +1423,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:636 +#: documentation/content/en/articles/committers-guide/_index.adoc:634 msgid "" "You would then build/install that version. If it's good you'd type `git " "bisect good` otherwise `git bisect bad`. If the version doesn't compile, " @@ -1439,13 +1436,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:638 +#: documentation/content/en/articles/committers-guide/_index.adoc:636 #, no-wrap msgid "Signing the commits, tags, and pushes, with GnuPG" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:643 +#: documentation/content/en/articles/committers-guide/_index.adoc:641 msgid "" "Git knows how to sign commits, tags, and pushes. When you sign a Git commit " "or a tag, you can prove that the code you submitted came from you and wasn't " @@ -1454,7 +1451,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:645 +#: documentation/content/en/articles/committers-guide/_index.adoc:643 msgid "" "A more in-depth documentation on signing commits and tags can be found in " "the https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work[Git Tools - " @@ -1462,7 +1459,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:647 +#: documentation/content/en/articles/committers-guide/_index.adoc:645 msgid "" "The rationale behind signing pushes can be found in the https://github.com/" "git/git/commit/a85b377d0419a9dfaca8af2320cc33b051cbed04[commit that " @@ -1470,14 +1467,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:650 +#: documentation/content/en/articles/committers-guide/_index.adoc:648 msgid "" "The best way is to simply tell Git you always want to sign commits, tags, " "and pushes. You can do this by setting a few configuration variables:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:657 +#: documentation/content/en/articles/committers-guide/_index.adoc:655 #, no-wrap msgid "" "% git config --add user.signingKey LONG-KEY-ID\n" @@ -1488,14 +1485,14 @@ msgstr "" #. push.gpgSign should probably be set to `yes` once we enable it, or be set with --global, so that it is enabled for all repositories. #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:665 +#: documentation/content/en/articles/committers-guide/_index.adoc:663 msgid "" "To avoid possible collisions, make sure you give a long key id to Git. You " "can get the long id with: `gpg --list-secret-keys --keyid-format LONG`." msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:671 +#: documentation/content/en/articles/committers-guide/_index.adoc:669 msgid "" "To use specific subkeys, and not have GnuPG to resolve the subkey to a " "primary key, attach `!` to the key. For example, to encrypt for the subkey " @@ -1503,20 +1500,20 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:673 +#: documentation/content/en/articles/committers-guide/_index.adoc:671 #, no-wrap msgid "Verifying signatures" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:676 +#: documentation/content/en/articles/committers-guide/_index.adoc:674 msgid "" "Commit signatures can be verified by running either `git verify-commit " "<commit hash>`, or `git log --show-signature`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:678 +#: documentation/content/en/articles/committers-guide/_index.adoc:676 msgid "" "Tag signatures can be verified with `git verify-tag <tag name>`, or `git tag " "-v <tag name>`." @@ -1528,43 +1525,43 @@ msgstr "" #. Git pushes are a bit different, they live in a special ref in the repository. #. TODO: write how to verify them #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:687 +#: documentation/content/en/articles/committers-guide/_index.adoc:685 #, no-wrap msgid "Ports Considerations" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:690 +#: documentation/content/en/articles/committers-guide/_index.adoc:688 msgid "" "The ports tree operates the same way. The branch names are different and " "the repositories are in different locations." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:693 +#: documentation/content/en/articles/committers-guide/_index.adoc:691 msgid "" "The cgit repository web interface for use with web browsers is at https://" "cgit.FreeBSD.org/ports/ . The production Git repository is at https://" "git.FreeBSD.org/ports.git and at ssh://anongit@git.FreeBSD.org/ports.git (or " -"anongit@git.FreeBSD.org:ports.git)." +"`anongit@git.FreeBSD.org:ports.git`)." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:697 +#: documentation/content/en/articles/committers-guide/_index.adoc:695 msgid "" -"There is also a mirror on GitHub, see extref:{handbook}/mirrors[External " +"There is also a mirror on GitHub, see extref:{handbook}mirrors[External " "mirrors, mirrors] for an overview. The _latest_ branch is `main`. The " "_quarterly_ branches are named `yyyyQn` for year 'yyyy' and quarter 'n'." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:699 +#: documentation/content/en/articles/committers-guide/_index.adoc:697 #, no-wrap msgid "Commit message formats" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:703 +#: documentation/content/en/articles/committers-guide/_index.adoc:701 msgid "" "A hook is available in the ports repository to help you write up your commit " "messages in https://cgit.freebsd.org/ports/tree/.hooks/prepare-commit-" @@ -1573,32 +1570,32 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:705 +#: documentation/content/en/articles/committers-guide/_index.adoc:703 msgid "" "The main point being that a commit message should be formatted in the " "following way:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:708 +#: documentation/content/en/articles/committers-guide/_index.adoc:706 #, no-wrap msgid "category/port: Summary.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:710 +#: documentation/content/en/articles/committers-guide/_index.adoc:708 #, no-wrap msgid "Description of why the changes where made.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:712 +#: documentation/content/en/articles/committers-guide/_index.adoc:710 #, no-wrap msgid "PR:\t 12345\n" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:718 +#: documentation/content/en/articles/committers-guide/_index.adoc:716 msgid "" "The first line is the subject of the commit, it contains what port was " "changed, and a summary of the commit. It should contain 50 characters or " @@ -1606,39 +1603,39 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:720 +#: documentation/content/en/articles/committers-guide/_index.adoc:718 msgid "A blank line should separate it from the rest of the commit message." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:722 +#: documentation/content/en/articles/committers-guide/_index.adoc:720 msgid "" "The rest of the commit message should be wrapped at the 72 characters " "boundary." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:724 +#: documentation/content/en/articles/committers-guide/_index.adoc:722 msgid "" "Another blank line should be added if there are any metadata fields, so that " "they are easily distinguishable from the commit message." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:726 +#: documentation/content/en/articles/committers-guide/_index.adoc:724 #, no-wrap msgid "Managing Local Changes" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:729 +#: documentation/content/en/articles/committers-guide/_index.adoc:727 msgid "" "This section addresses tracking local changes. If you have no local changes " "you can skip this section." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:735 +#: documentation/content/en/articles/committers-guide/_index.adoc:733 msgid "" "One item that is important for all of them: all changes are local until " "pushed. Unlike Subversion, Git uses a distributed model. For users, for " @@ -1649,13 +1646,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:736 +#: documentation/content/en/articles/committers-guide/_index.adoc:734 #, no-wrap msgid "Keeping local changes" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:743 +#: documentation/content/en/articles/committers-guide/_index.adoc:741 msgid "" "The simplest way to keep local changes (especially trivial ones) is to use " "`git stash`. In its simplest form, you use `git stash` to record the " @@ -1667,7 +1664,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:747 +#: documentation/content/en/articles/committers-guide/_index.adoc:745 msgid "" "This method is suitable when you have tiny tweaks to the tree. When you " "have anything non trivial, you'll likely be better off keeping a local " @@ -1676,13 +1673,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:748 +#: documentation/content/en/articles/committers-guide/_index.adoc:746 #, no-wrap msgid "Keeping a local branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:755 +#: documentation/content/en/articles/committers-guide/_index.adoc:753 msgid "" "It is much easier to keep a local branch with Git than Subversion. In " "Subversion you need to merge the commit, and resolve the conflicts. This is " @@ -1693,7 +1690,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:759 +#: documentation/content/en/articles/committers-guide/_index.adoc:757 msgid "" "In addition to merging, Git supports the concept of 'rebasing' which avoids " "these issues. The `git rebase` command replays all the commits of a branch " @@ -1702,12 +1699,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:761 +#: documentation/content/en/articles/committers-guide/_index.adoc:759 msgid "====== Create a branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:766 +#: documentation/content/en/articles/committers-guide/_index.adoc:764 msgid "" "Let's say you want to make a change to FreeBSD's ls command to never, ever " "do color. There are many reasons to do this, but this example will use that " @@ -1717,7 +1714,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:788 +#: documentation/content/en/articles/committers-guide/_index.adoc:786 #, no-wrap msgid "" "% cd src\n" @@ -1743,7 +1740,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:795 +#: documentation/content/en/articles/committers-guide/_index.adoc:793 msgid "" "The commit will pop you into an editor to describe what you've done. Once " "you enter that, you have your own **local** branch in the Git repo. Build " @@ -1755,12 +1752,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:797 +#: documentation/content/en/articles/committers-guide/_index.adoc:795 msgid "====== Time to update" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:802 +#: documentation/content/en/articles/committers-guide/_index.adoc:800 msgid "" "When it is time to bring in a new version, it is almost the same as w/o the " "branches. You would update like you would above, but there is one extra " @@ -1770,7 +1767,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:808 +#: documentation/content/en/articles/committers-guide/_index.adoc:806 #, no-wrap msgid "" "% git checkout main\n" @@ -1779,7 +1776,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:813 +#: documentation/content/en/articles/committers-guide/_index.adoc:811 msgid "" "This will bring up an editor that lists all the commits in it. For this " "example, do not change it at all. This is typically what you are doing " @@ -1788,14 +1785,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:815 +#: documentation/content/en/articles/committers-guide/_index.adoc:813 msgid "" "Once you are done with the above, you have to move the commits to ls.c " "forward from the old version of FreeBSD to the newer one." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:822 +#: documentation/content/en/articles/committers-guide/_index.adoc:820 msgid "" "Sometimes there are merge conflicts. That is OK. Do not panic. Instead, " "handle them the same as any other merge conflicts. To keep it simple, I " @@ -1804,7 +1801,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:825 +#: documentation/content/en/articles/committers-guide/_index.adoc:823 msgid "" "Let's say the includes changes upstream in a radical shift to terminfo as " "well as a name change for the option. When you updated, you might see " @@ -1812,7 +1809,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:835 +#: documentation/content/en/articles/committers-guide/_index.adoc:833 #, no-wrap msgid "" "Auto-merging bin/ls/ls.c\n" @@ -1826,14 +1823,19 @@ msgid "" 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):" +#: documentation/content/en/articles/committers-guide/_index.adoc:835 +msgid "which looks scary." msgstr "" #. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:837 +msgid "" +"If you bring up an editor, you will see it is a typical 3-way merge conflict " +"resolution that you may be familiar with from other source code systems (the " +"rest of ls.c has been omitted):" +msgstr "" + +#. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:847 #, no-wrap msgid "" @@ -1847,130 +1849,138 @@ msgid "" " >>>>>>> 646e0f9cda11... no color ls\n" msgstr "" -#. type: delimited block . 4 -#: 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" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:850 +msgid "The new code is first, and your code is second." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:855 -msgid "#undef COLORLS_NEW #ifdef COLORLS_NEW #include <terminfo.h>" +#: documentation/content/en/articles/committers-guide/_index.adoc:852 +msgid "" +"The right fix here is to just add a #undef COLORLS_NEW before #ifdef and " +"then delete the old changes:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:859 +#: documentation/content/en/articles/committers-guide/_index.adoc:857 #, 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:862 -msgid "% git add ls.c % git rebase --continue" +#: documentation/content/en/articles/committers-guide/_index.adoc:859 +msgid "save the file." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:861 +msgid "The rebase was interrupted, so you have to complete it:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:867 +#: documentation/content/en/articles/committers-guide/_index.adoc:865 #, 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:870 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 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:875 -#, no-wrap 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: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:878 +msgid "" +"For more on this topic, https://www.freecodecamp.org/news/the-ultimate-guide-" +"to-git-merge-and-git-rebase/ provides a rather extensive treatment. It is a " +"good resource for issues that arise occasionally but are too obscure for " +"this guide." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:876 +#: documentation/content/en/articles/committers-guide/_index.adoc:879 #, no-wrap msgid "Switching to a Different FreeBSD Branch" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:880 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:882 msgid "" "If you wish to shift from stable/12 to the current branch. If you have a " -"deep clone, the following will suffice: [source,shell]" -msgstr "" - -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:883 -msgid "% git checkout main % # build and install here..." +"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:886 #, 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:891 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:896 #, 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:903 +msgid "" +"What the above does is checkout no-color-ls. Then create a new name for it " +"(no-color-ls-stable-12) in case you need to get back to it. Then you rebase " +"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:905 #, 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:906 #, 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:910 msgid "" "MFC workflow can be summarized as `git cherry-pick -x` plus `git commit --" "amend` to adjust the commit message. For multiple commits, use `git rebase " @@ -1978,194 +1988,157 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:908 +#: documentation/content/en/articles/committers-guide/_index.adoc:911 #, no-wrap msgid "Single commit MFC" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc: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]" -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 +#: documentation/content/en/articles/committers-guide/_index.adoc:917 #, no-wrap 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" -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 -#, no-wrap -msgid "[source,shell]\n" +"% git checkout stable/X\n" +"% git cherry-pick -x $HASH --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" +#: documentation/content/en/articles/committers-guide/_index.adoc:921 +msgid "" +"For MFC commits, for example a vendor import, you would need to specify one " +"parent for cherry-pick purposes. Normally, that would be the \"first " +"parent\" of the branch you are cherry-picking from, so:" 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" +msgid "" +"% git checkout stable/X\n" +"% git cherry-pick -x $HASH -m 1 --edit\n" msgstr "" -#. type: delimited block . 4 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:929 -#, no-wrap 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" +"If things go wrong, you'll either need to abort the cherry-pick with `git " +"cherry-pick --abort` or fix it up and do a `git cherry-pick --continue`." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:932 +msgid "" +"Once the cherry-pick is finished, push with `git push`. If you get an error " +"due to losing the commit race, use `git pull --rebase` and try to push again." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:930 +#: documentation/content/en/articles/committers-guide/_index.adoc:933 #, 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:937 msgid "" "MFCs to branches that require approval require a bit more care. The process " "is the same for either a typical merge or an exceptional direct commit." msgstr "" -#. type: delimited block . 4 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:939 -#, no-wrap 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:940 +msgid "" +"Use the hash that's in the `stable/X` branch for the MFC to `releng/X.Y` " +"branch." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:941 +msgid "Leave both \"cherry picked from\" lines in the commit message." 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:942 +msgid "Be sure to add the `Approved by:` line when you are in the editor." msgstr "" #. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc: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" +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:950 +msgid "" +"If you forget to to add the `Approved by:` line, you can do a `git commit --" +"amend` to edit the commit message before you push the change." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:948 +#: documentation/content/en/articles/committers-guide/_index.adoc:951 #, no-wrap msgid "Multiple commit MFC" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:959 -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" -msgstr "" - #. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:962 #, 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:965 +msgid "If the push fails due to losing the commit race, rebase and try again:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:973 #, 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:976 +msgid "Once the MFC is complete, you can delete the temporary branch:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:981 +#, 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:983 #, 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:988 msgid "" "Vendor imports are the only thing in the tree that creates a merge commit in " "the `main` branch. Cherry picking merge commits into stable/XX presents an " @@ -2174,128 +2147,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 #, 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:995 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" +#: documentation/content/en/articles/committers-guide/_index.adoc:999 +msgid "" +"There are some, hopefully, rare cases where it's possible that the `main` " +"branch was merged backwards by the conversion script. Should that be the " +"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:1003 #, 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:1005 +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:1006 #, no-wrap msgid "Redoing a MFC" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1008 -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" +msgid "" +"If you do a MFC, and it goes horribly wrong and you want to start over, then " +"the easiest way is to use `git reset --hard` like so:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:1013 #, no-wrap +msgid "% git reset --hard freebsd/stable/12\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1016 msgid "" -"though if you have some revs you want to keep, and others you don't,\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:1017 #, 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:1020 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:1022 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 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1023 -#, no-wrap -msgid "With Subversion, we used the following practices to achieve these goals:\n" +msgid "Avoid introducing known breakage into stable and releng branches." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1027 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1024 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" +"Allow developers to determine which changes have or have not been landed " +"from one branch to another." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1031 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1026 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 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:1028 +msgid "" +"Using `MFC` and `MFS` tags to mark commits that merged changes from another " +"branch." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1029 +msgid "Squashing fixup commits into the main commit when merging a change." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1030 +msgid "Recording mergeinfo so that `svn mergeinfo --show-revs` worked." +msgstr "" + +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1034 -#, no-wrap 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" +"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: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1037 +msgid "" +"One general note: due to technical differences with Git, we will not be " +"using Git \"merge commits\" (created via `git merge`) in stable or releng " +"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:1038 #, 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:1044 msgid "" "Git provides some built-in support for this via the `git cherry` and `git " "log --cherry` commands. These commands compare the raw diffs of commits " @@ -2309,42 +2305,45 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1042 +#: documentation/content/en/articles/committers-guide/_index.adoc:1045 #, no-wrap msgid "Commit message standards" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1043 +#: documentation/content/en/articles/committers-guide/_index.adoc:1046 #, 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:1049 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:1051 +msgid "" +"Use the `-x` flag with `git cherry-pick`. This adds a line to the commit " +"message that includes the hash of the original commit when merging. Since it " +"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:1053 +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:1054 #, 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:1058 msgid "" "One area that was not clearly documented with Subversion (or even CVS) is " "how to format metadata in log messages for MFC commits. Should it include " @@ -2352,8 +2351,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:1067 msgid "" "Historical practice has varied, though some of the variance is by field. " "For example, MFCs that are relevant to a PR generally include the PR field " @@ -2371,8 +2370,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:1071 msgid "" "For MFCs regulated by re@, new metadata fields are added, such as the " "Approved by tag for approved commits. This new metadata will have to be " @@ -2381,15 +2380,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:1074 msgid "" "Preserving existing metadata provides a very simple workflow. Developers " "use `git cherry-pick -x` without having to edit the log message." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1074 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1077 msgid "" "If instead we choose to adjust metadata in MFCs, developers will have to " "edit log messages explicitly via the use of `git cherry-pick --edit` or `git " @@ -2398,66 +2397,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:1079 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:1081 #, 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:1084 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:1085 #, 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:1088 msgid "" "All vendor branches and tags start with `vendor/`. These branches and tags " "are visible by default." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1091 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1093 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:1097 msgid "" "We will explore an example for updating NetBSD's mtree that is in our tree. " "The vendor branch for this is `vendor/NetBSD/mtree`." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1095 +#: documentation/content/en/articles/committers-guide/_index.adoc:1098 #, 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:1104 msgid "" "The vendor trees usually have only the subset of the third-party software " "that is appropriate to FreeBSD. These trees are usually tiny in comparison " @@ -2466,26 +2460,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:1108 +#, 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:1110 #, 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:1113 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:1117 msgid "" "This example assumes the NetBSD source is checked out from their GitHub " "mirror in `~/git/NetBSD`. Note that \"upstream\" might have added or " @@ -2493,8 +2488,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:1131 #, no-wrap msgid "" "% cd ../mtree\n" @@ -2510,87 +2505,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:1144 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:1148 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:1151 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:1156 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:1157 #, 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" +#: documentation/content/en/articles/committers-guide/_index.adoc:1160 +msgid "At this point you can push the import to `vendor` into our repo." msgstr "" #. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:1164 #, 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:1167 +msgid "" +"`--follow-tags` tells `git push` to also push tags associated with the " +"locally committed revision." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1165 +#: documentation/content/en/articles/committers-guide/_index.adoc:1168 #, 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:1172 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:1178 msgid "" "From time to time, we may have to make changes to the contributed code to " "better satisfy FreeBSD's needs. Whenever possible, please try to contribute " @@ -2599,115 +2593,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:1183 #, 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:1193 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:1207 +msgid "" +"Some open-source software includes a `configure` script that generates files " +"used to define how the code is built; usually, these generated files like " +"`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:1214 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:1215 #, 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:1218 msgid "" "Because the current policy recommends against using merges, if the upstream " "FreeBSD `main` moved forward before you get a chance to push, you would have " "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:1221 msgid "" "Regular `git rebase` or `git pull --rebase` doesn't know how to rebase a " "merge commit **as a merge commit**, so instead of that you would have to " "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:1223 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:1225 +msgid "cd to the top of the repo" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1226 +msgid "Create a side branch `XXX` with the **contents** of the merged tree." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1227 +msgid "" +"Update this side branch `XXX` to be merged and up-to-date with FreeBSD's " +"`main` branch." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1228 +msgid "" +"In the worst case scenario, you would still have to resolve merge conflicts, " +"if there was any, but this should be really rare." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1229 +msgid "" +"Resolve conflicts, and collapse multiple commits down to 1 if need be " +"(without conflicts, there's no collapse needed)" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1230 +msgid "checkout `main`" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1231 +msgid "create a branch `YYY` (allows for easier unwinding if things go wrong)" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1232 +msgid "Re-do the subtree merge" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1233 +msgid "" +"Instead of resolving any conflicts from the subtree merge, checkout the " +"contents of XXX on top of it." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1234 +msgid "" +"The trailing `.` is important, as is being at the top level of the repo." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1235 +msgid "" +"Rather than switching branches to XXX, it splats the contents of XXX on top " +"of the repo" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1236 +msgid "" +"Commit the results with the prior commit message (the example assumes " +"there's only one merge on the XXX branch)." +msgstr "" + +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1237 -#, no-wrap +msgid "Make sure the branches are the same." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1238 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" +"Do whatever review you need, including having others check it out if you " +"think that's needed." msgstr "" -#. type: delimited block . 4 +#. 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 "" +"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:1240 +msgid "Delete the branches once the commit is upstream. They are throw-a-way." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1252 +#: documentation/content/en/articles/committers-guide/_index.adoc:1242 +msgid "" +"The commands one would use, following the above example of mtree, would be " +"like so (the `#` starts a comment to help link commands to descriptions " +"above):" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1255 #, no-wrap msgid "" "% cd ../src\t\t\t# CD to top of tree\n" @@ -2722,29 +2792,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 -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" -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" +"Note: if things go wrong with the commit, you can reset the `YYY` branch by " +"reissuing the checkout command that created it with -B to start over:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1261 +#, no-wrap +msgid "% git checkout -B YYY freebsd/main # Create new throw-away YYY branch if starting over is just going to be easier\n" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1260 +#: documentation/content/en/articles/committers-guide/_index.adoc:1263 #, 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:1268 msgid "" "Once you think you have a set of changes that are good, you can push it to a " "fork off GitHub or GitLab for others to review. One nice thing about Git is " @@ -2754,71 +2822,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:1270 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:1276 +#, 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:1283 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:1284 #, 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:1288 msgid "" "If you've tried to do the push in the previous section and it fails, then " "you should do the following to 'redo' things. This sequence keeps the " "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 -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" -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" +msgid "" +"% 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: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1300 +msgid "Then go check it out as above and push as above when ready." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:1298 +#: documentation/content/en/articles/committers-guide/_index.adoc:1301 #, 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:1308 msgid "" "There are a number of ways to create a new vendor branch. The recommended " "way is to create a new repository and then merge that with FreeBSD. If one " @@ -2829,142 +2899,172 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1306 +#: documentation/content/en/articles/committers-guide/_index.adoc:1309 #, no-wrap msgid "Create the repo" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1315 -msgid "" -"% cd /some/where % mkdir glorbnitz % cd glorbnitz % git init % git checkout " -"-b vendor/glorbnitz" -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" +msgid "" +"% 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: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:1321 +msgid "" +"At this point, you have a new repo, where all new commits will go on the " +"`vendor/glorbnitz` branch." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1323 +msgid "" +"Git experts can also do this right in their FreeBSD clone, using `git " +"checkout --orphan vendor/glorbnitz` if they are more comfortable with that." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1321 +#: documentation/content/en/articles/committers-guide/_index.adoc:1324 #, 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:1328 msgid "" "Since this is a new import, you can just cp the sources in, or use tar or " "even rsync as shown above. And we will add everything, assuming no dot " "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 #, 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\"" +#: documentation/content/en/articles/committers-guide/_index.adoc:1336 +msgid "" +"At this point, you should have a pristine copy of glorbnitz ready to commit." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1342 +#: documentation/content/en/articles/committers-guide/_index.adoc:1340 #, no-wrap +msgid "% git commit -m \"Import GlorbNitz frobnosticator revision 3.1415\"\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1345 msgid "" -"As above, I used `-m` for simplicity, but you should likely create a commit message that explains what a Glorb is and why you'd use a Nitz to get it.\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:1346 #, 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:1349 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:1355 +#, 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:1359 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:1361 #, 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:1364 msgid "" "Steps from here on out are much the same as they are in the case of updating " "a vendor branch, though without the updating the vendor branch step." msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1369 -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" -msgstr "" - #. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:1372 #, no-wrap -msgid "By 'good' we mean:\n" +msgid "" +"% 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 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1375 +msgid "By 'good' we mean:" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1377 +msgid "All the right files are present" +msgstr "" + +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1378 -#, no-wrap +msgid "None of the wrong files are present" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1379 +msgid "The vendor branch points at something sensible" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1380 +msgid "The tag looks good, and is annotated" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1381 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:1382 #, 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:1391 #, no-wrap msgid "" "% cd ../src\n" @@ -2974,41 +3074,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:1394 +msgid "Here 'good' means:" msgstr "" -#. type: delimited block . 4 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1396 -#, no-wrap 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:1397 +msgid "No other changes are in the tree." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1398 +msgid "" +"The commit messages look crossref:committers-guide[commit-log-message,good]. " +"It should contain a summary of what's changed since the last merge to the " +"FreeBSD `main` branch and any caveats." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1399 +msgid "" +"`RELNOTES` and `UPDATING` should be updated if there is anything of note, " +"such as user visible changes, important upgrade concerns, etc." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1404 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:1406 #, 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:1412 msgid "" "So, time passes. It's time now to update the tree for the latest changes " "upstream. When you checkout `main` make sure that you have no diffs. It's " @@ -3016,281 +3129,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:1415 msgid "" "If you are used to `git pull`, we strongly recommend using the `--ff-only` " "option, and further setting it as the default option. Alternatively, `git " "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 #, 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:1422 +msgid "" +"You may need to omit the --global if you want this setting to apply to only " +"this repository." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1429 +#: documentation/content/en/articles/committers-guide/_index.adoc:1428 #, no-wrap msgid "" -"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:1432 +msgid "" +"There is a common trap, that the combination command `git pull` will try to " +"perform a merge, which would sometimes creates a merge commit that didn't " +"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:1434 +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:1441 #, 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" +#: documentation/content/en/articles/committers-guide/_index.adoc:1446 +msgid "" +"These commands reset your tree to the `main` branch, and then update it from " +"where you pulled the tree from originally. It's important to switch to " +"`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:1450 #, 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:1457 +msgid "" +"This will bring up an interactive screen to change the defaults. For now, " +"just exit the editor. Everything should just apply. If not, then you'll " +"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:1459 #, no-wrap msgid "Time to push changes upstream" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1459 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1462 msgid "" "First, ensure that the push URL is properly configured for the upstream " "repository." msgstr "" -#. type: 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" -msgstr "" - #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1467 +#: documentation/content/en/articles/committers-guide/_index.adoc:1466 #, no-wrap -msgid "" -"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:1470 +msgid "" +"Then, verify that user name and email are configured right. We require that " +"they exactly match the passwd entry in FreeBSD cluster." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1473 -msgid "freefall% gen-gitconfig.sh" +#: documentation/content/en/articles/committers-guide/_index.adoc:1472 +msgid "Use" msgstr "" #. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:1476 #, 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:1479 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" +#: documentation/content/en/articles/committers-guide/_index.adoc:1484 +msgid "" +"The below command merges the `working` branch into the upstream `main` " +"branch. It's important that you curate your changes to be just like you " +"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 #, 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:1491 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 #, 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:1501 #, 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:1506 msgid "" "Some people find it easier to merge their changes to their local `main` " "before pushing to the remote repository. Also, `git arc stage` moves " "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 +#: documentation/content/en/articles/committers-guide/_index.adoc:1511 #, 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" +#: documentation/content/en/articles/committers-guide/_index.adoc:1514 +msgid "If you lose the race, then try again with" msgstr "" #. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:1518 #, 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:1521 +msgid "" +"These commands will fetch the most recent `freebsd/main` and then rebase the " +"local `main` changes on top of that, which is what you want when you lose " +"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:1522 #, 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:1526 msgid "" "You'll need to make sure that you've fetched the notes (see the " "crossref:committers-guide[git-mini-daily-use, Daily use]for details). Once " "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 #, 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" +#: documentation/content/en/articles/committers-guide/_index.adoc:1533 +msgid "If you have a specific version in mind, you can use this construct:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1538 +#: documentation/content/en/articles/committers-guide/_index.adoc:1537 #, no-wrap -msgid "" -"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:1541 +msgid "" +"to find the specific revision. The hex number after 'commit' is the hash " +"you can use to refer to this commit." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:1540 +#: documentation/content/en/articles/committers-guide/_index.adoc:1543 #, 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:1546 msgid "" "This section provides a number of targeted answers to questions that are " "likely to come up often for users and developers." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1549 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1551 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:1553 #, no-wrap msgid "Users" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1552 +#: documentation/content/en/articles/committers-guide/_index.adoc:1555 #, no-wrap msgid "How do I track -current and -stable with only one copy of the repository?" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1557 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1560 #, no-wrap msgid "" "**Q:** Although disk space is not a huge issue, it's more efficient to use only one copy of the repository.\n" @@ -3298,8 +3412,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:1564 #, no-wrap msgid "" "**A:** You can use Git worktrees.\n" @@ -3307,101 +3421,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 +#: documentation/content/en/articles/committers-guide/_index.adoc:1567 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 #, 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:1574 +msgid "then once that's cloned, you can simply create a worktree from it:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1580 +#: documentation/content/en/articles/committers-guide/_index.adoc:1579 #, no-wrap msgid "" -"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:1583 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 #, 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:1596 +msgid "" +"I recommend using `--ff-only` because it's safer and you avoid accidentally " +"getting into a 'merge nightmare' where you have an extra change in your " +"tree, forcing a complicated merge rather than a simple one." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1598 +msgid "" +"Here's https://adventurist.me/posts/00296[a good writeup] that goes into " +"more detail." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1596 +#: documentation/content/en/articles/committers-guide/_index.adoc:1599 #, no-wrap msgid "Developers" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1598 +#: documentation/content/en/articles/committers-guide/_index.adoc:1601 #, 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:1604 #, no-wrap msgid "**Q:** From time to time, I goof up and mistakenly commit to the `main` branch. What do I do?\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1603 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1606 #, 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:1610 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:1612 +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:1618 #, no-wrap msgid "" "% git checkout -b issue # Create the 'issue' branch\n" @@ -3410,21 +3532,21 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1617 +#: documentation/content/en/articles/committers-guide/_index.adoc:1620 #, 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:1624 #, no-wrap msgid "" "**Q:** I was working on feature on the `wilma` branch, but accidentally committed a change relevant to the `fred` branch in 'wilma'.\n" "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:1628 #, no-wrap msgid "" "**A:** The answer is similar to the previous one, but with cherry picking.\n" @@ -3432,23 +3554,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 #, 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:1639 +msgid "" +"If it is not the last commit, you can cherry-pick that one change from wilma " +"onto fred, then use `git rebase -i` to remove the change from wilma." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1646 #, no-wrap msgid "" "# We're on branch wilma\n" @@ -3457,14 +3582,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:1649 #, no-wrap msgid "**Q:** But what if I want to commit a few changes to `main`, but keep the rest in `wilma` for some reason?\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1652 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1655 #, no-wrap msgid "" "**A:** The same technique above also works if you are wanting to 'land' parts of the branch you are working on into `main` before the rest of the branch is ready (say you noticed an unrelated typo, or fixed an incidental bug).\n" @@ -3474,14 +3599,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:1657 #, 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:1663 #, no-wrap msgid "" "**A:** The more general answer would be the same as the previous.\n" @@ -3491,34 +3616,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:1668 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 +#: documentation/content/en/articles/committers-guide/_index.adoc:1675 #, 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 -#: documentation/content/en/articles/committers-guide/_index.adoc:1680 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1679 +msgid "" +"The last step is optional. If you are going to try again to split, you'd " +"omit it." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1683 #, no-wrap msgid "" "**Q:** But I did things as I read along and didn't see your advice at the end to create a branch, and now `fred` and `wilma` are all screwed up.\n" @@ -3526,306 +3654,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 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1685 #, no-wrap msgid "**A:** All is not lost. You can figure out it, so long as it hasn't been too long, or too many commits (hundreds).\n" msgstr "" -#. type: delimited block . 4 -#: 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" -msgstr "" - #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1701 +#: documentation/content/en/articles/committers-guide/_index.adoc:1689 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:1704 #, 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:1712 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:1720 +msgid "" +"Next, 'Encourage contributions' was the last commit I made to `wilma` before " +"I decided to split things up. You can also see the same hash is there when " +"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:1725 #, 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:1732 +msgid "" +"and you are ready to try again. The `checkout -B` with the hash combines " +"checking out and creating a branch for it. The `-B` instead of `-b` forces " +"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 -#: documentation/content/en/articles/committers-guide/_index.adoc:1739 +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1738 +#, 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 +#. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:1742 +#, 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 #, 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:1753 +msgid "" +"this produces the same effect, but I have to read a lot more and severed " +"heads aren't an image I like to contemplate." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1751 +#: documentation/content/en/articles/committers-guide/_index.adoc:1754 #, no-wrap msgid "Ooops! I did a `git pull` and it created a merge commit, what do I do?" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1755 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1758 #, no-wrap msgid "" "**Q:** I was on autopilot and did a `git pull` for my development tree and that created a merge commit on `main`.\n" "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:1760 #, 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 +#. type: Plain text #: 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" +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:1765 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 +#: documentation/content/en/articles/committers-guide/_index.adoc:1770 #, 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" +#: documentation/content/en/articles/committers-guide/_index.adoc:1774 +msgid "" +"From those logs, you can easily identify which commit is your development " +"work. Then you simply reset your branch to the corresponding `HEAD^#`:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:1778 #, 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:1781 +msgid "" +"In addition, a `git pull --rebase` at this stage will rebase your changes to " +"'main' to the latest 'freebsd/main'." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1783 #, 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:1786 #, 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:1790 #, no-wrap +msgid "git branch -f main freebsd/main\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1795 msgid "" -"There's nothing magical about branches in Git: they are just labels on a graph that are automatically moved forward by making commits.\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:1796 #, 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:1800 #, no-wrap msgid "" "**Q:** So I have two branches `worker` and `async` that I'd like to combine into one branch called `feature`\n" "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:1802 #, 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:1808 +#, 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:1813 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:1815 #, no-wrap msgid "**Q:** I have a branch called `driver` and I'd like to break it up into `kernel` and `userland` so I can evolve them separately and commit each branch as it becomes ready.\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1815 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1818 #, no-wrap msgid "" "**A:** This takes a little bit of prep work, but `git rebase` will do the heavy\n" "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:1824 #, 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" +#: documentation/content/en/articles/committers-guide/_index.adoc:1829 +msgid "" +"Now you have two identical branches. So, it's time to separate out the " +"commits. We'll assume first that all the commits in `driver` go into either " +"the `kernel` or the `userland` branch, but not both." msgstr "" #. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:1833 #, 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" +#: documentation/content/en/articles/committers-guide/_index.adoc:1836 +msgid "" +"and just include the changes you want (with a 'p' or 'pick' line) and just " +"delete the commits you don't (this sounds scary, but if worse comes to " +"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 #, 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 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1843 +msgid "and do the same thing you did with the `kernel` branch." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1846 #, 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:1849 #, 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:1855 +#, 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:1861 #, no-wrap msgid "" "**Q:** OK. I have the same situation as the above, but my commits are all mixed up.\n" @@ -3834,81 +3980,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:1864 #, 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^" +#: documentation/content/en/articles/committers-guide/_index.adoc:1869 +msgid "" +"So let's assume that there's just one commit with a clean tree. You can " +"either use `git rebase` with an `edit` line, or you can use this with the " +"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 #, 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 -#: documentation/content/en/articles/committers-guide/_index.adoc:1877 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1876 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 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1880 -#, no-wrap 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" +#: documentation/content/en/articles/committers-guide/_index.adoc:1883 +msgid "" +"If you are not lucky, you'll need to split apart files. There's another " +"tool to do that which you can apply one file at a time." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1890 +#: documentation/content/en/articles/committers-guide/_index.adoc:1887 #, no-wrap +msgid "git add -i foo/bar.c\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1893 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:1894 #, 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:1897 #, 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:1901 #, no-wrap msgid "" "**A:** Please see https://wiki.freebsd.org/GitHub#Joining_the_Organisation[our GitHub Wiki Info] page for details.\n" @@ -3917,140 +4066,146 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1899 +#: documentation/content/en/articles/committers-guide/_index.adoc:1902 #, 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:1905 #, 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 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1907 #, no-wrap msgid "**A:** If all you want to do is mirror, then\n" msgstr "" -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1908 -msgid "% git clone --mirror $URL" -msgstr "" - #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1912 +#: documentation/content/en/articles/committers-guide/_index.adoc:1911 #, no-wrap -msgid "" -"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 -#: documentation/content/en/articles/committers-guide/_index.adoc:1916 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1915 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:1919 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 #, 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 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1930 -#, no-wrap 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:1933 +msgid "" +"The second disadvantage is that Git normally rewrites the refs (branch name, " +"tags, etc) from upstream so that your local refs can evolve independently of " +"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 +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:1935 #, 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 +#: documentation/content/en/articles/committers-guide/_index.adoc:1938 #, 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 #, no-wrap -msgid "which says just fetch the branch refs.\n" +msgid " fetch = +refs/heads/*:refs/remotes/freebsd/*\n" msgstr "" -#. type: delimited block . 4 -#: 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" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1945 +msgid "which says just fetch the branch refs." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1950 -msgid "git config --add remote.freebsd.fetch '+refs/*:refs/freebsd/*'" +#: documentation/content/en/articles/committers-guide/_index.adoc:1949 +msgid "" +"However, the FreeBSD repository has a number of other things in it. To see " +"those, you can add explicit refspecs for each ref namespace, or you can " +"fetch everything. To setup your repository to do that:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1954 +#: documentation/content/en/articles/committers-guide/_index.adoc:1953 #, no-wrap -msgid "" -"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:1957 +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" +#: documentation/content/en/articles/committers-guide/_index.adoc:1959 +msgid "" +"You'll need to refer to these 'refs' with their full name because they " +"aren't in and of Git's regular namespaces." msgstr "" #. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:1963 #, 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:1966 +msgid "" +"would look at the log for the vendor branch for zlib starting at 1.2.10." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:1964 +#: documentation/content/en/articles/committers-guide/_index.adoc:1967 #, 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:1971 msgid "" "One of the keys to good software development on a project as large as " "FreeBSD is the ability to collaborate with others before you push your " @@ -4061,15 +4216,15 @@ 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:1973 msgid "" "The following instructions show how to set up a user-generated branch, based " "on the FreeBSD `main` branch, and push it to GitHub." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1973 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1976 msgid "" "Before you begin, make sure that your local Git repo is up to date and has " "the correct origins set crossref:committers-guide[keeping_current,as shown " @@ -4077,14 +4232,16 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1980 +#: documentation/content/en/articles/committers-guide/_index.adoc:1982 +#, no-wrap 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\n" +"freebsd https://git.freebsd.org/src.git (fetch)\n" +"freebsd ssh://git@gitrepo.freebsd.org/src.git (push)\n" 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:1986 msgid "" "The first step is to create a fork of https://github.com/freebsd/freebsd-" "src[FreeBSD] on GitHub following these https://docs.github.com/en/github/" @@ -4092,65 +4249,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:1988 +msgid "Now add a remote on your local system that points to your fork:" msgstr "" #. type: delimited block . 4 #: documentation/content/en/articles/committers-guide/_index.adoc:1996 #, 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" +#: documentation/content/en/articles/committers-guide/_index.adoc:1999 +msgid "" +"With this in place you can create a branch crossref:committers-" +"guide[keeping_a_local_branch,as shown above]." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2004 +#: documentation/content/en/articles/committers-guide/_index.adoc:2003 #, no-wrap -msgid "" -"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:2007 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:2013 #, 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 #, 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:2018 +msgid "Setting the push as +git+ advises allows it to succeed:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2036 #, no-wrap msgid "" "% git push --set-upstream github gnn-feature\n" @@ -4166,24 +4326,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:2039 +msgid "Subsequent changes to the same branch will push correctly by default:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc: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:2052 #, no-wrap msgid "" "% git push\n" @@ -4198,28 +4351,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:2056 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:2058 #, 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:2063 msgid "" "This section documents how to land a GitHub pull request that's submitted " "against the FreeBSD Git mirrors at GitHub. While this is not an official " @@ -4231,124 +4377,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:2067 msgid "" "Before beginning, make sure that the local Git repo is up to date and has " "the correct origins set crossref:committers-guide[keeping_current,as shown " -"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:2074 #, 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:2089 +msgid "" +"Often pull requests are simple: requests that contain only a single commit. " +"In this case, a streamlined approach may be used, though the approach in the " +"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 +#. type: delimited block = 6 #: documentation/content/en/articles/committers-guide/_index.adoc:2093 -#, no-wrap -msgid "Author: github-user <38923459+github-user@users.noreply.github.com>\n" +msgid "" +"In addition, please check to make sure that the pull request author name is " +"not anonymous. Github's web editing interface generates names like:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2097 +#: documentation/content/en/articles/committers-guide/_index.adoc:2096 #, no-wrap -msgid "" -"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:2099 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:2112 #, 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:2122 -#, no-wrap +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2117 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" +"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:2119 +msgid "checkout the pull request `git checkout github/pull/XXX`" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2120 +msgid "create a branch to rebase `git checkout -b staging`" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2121 +msgid "" +"rebase the `staging` branch to the latest `main` with `git rebase -i main " +"staging`" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2122 +msgid "resolve conflicts and do whatever testing is needed" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2123 +msgid "fast forward the `staging` branch into `main` as above" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2124 +msgid "final sanity check of changes to make sure all is well" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2125 +msgid "push to FreeBSD's Git repository." +msgstr "" + +#. type: delimited block = 4 #: documentation/content/en/articles/committers-guide/_index.adoc:2127 -#, no-wrap 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:2130 +msgid "" +"Once finished with the pull request, close it using GitHub's web interface. " +"It is worth noting that if your `github` origin uses `https://`, the only " +"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:2132 #, 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:2135 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:2141 msgid "" "The FreeBSD source repository switched from CVS to Subversion on May 31st, " "2008. The first real SVN commit is __r179447__. The source repository " @@ -4357,8 +4539,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:2147 msgid "" "The FreeBSD `doc/www` repository switched from CVS to Subversion on May " "19th, 2012. The first real SVN commit is __r38821__. The documentation " @@ -4367,8 +4549,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:2153 msgid "" "The FreeBSD `ports` repository switched from CVS to Subversion on July 14th, " "2012. The first real SVN commit is __r300894__. The ports repository " @@ -4377,226 +4559,395 @@ 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:2155 #, 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:2160 msgid "" "There are a number of things to do as a new developer. The first set of " "steps is specific to committers only. These steps must be done by a mentor " "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:2162 #, 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:2165 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:2167 +msgid "Get mentor approval before committing each of these changes!" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2168 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:2173 #, no-wrap +msgid "*Steps for New Committers*\n" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2175 +msgid "Add an Author Entity" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2177 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 -#: documentation/content/en/articles/committers-guide/_index.adoc:2217 -#, no-wrap +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2178 +msgid "Update the List of Developers and Contributors" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2180 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" +"[.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 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2182 +msgid "" +"[.filename]#doc/shared/contrib-additional.adoc# - _Remove_ the entry. " +"Entries are sorted by first name." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2183 +msgid "Add a News Item" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2185 +msgid "" +"[.filename]#doc/website/data/en/news/news.toml# - Add an entry. Look for the " +"other entries that announce new committers and follow the format. Use the " +"date from the commit bit approval email." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2186 +msgid "Add a PGP Key" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2188 +msgid "" +"`{des}` has written a shell script ([.filename]#doc/documentation/tools/" +"addkey.sh#) to make this easier. See the https://cgit.freebsd.org/doc/plain/" +"documentation/static/pgpkeys/README[README] file for more information." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2190 +msgid "" +"Use [.filename]#doc/documentation/tools/checkkey.sh# to verify that keys " +"meet minimal best-practices standards." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2192 +msgid "" +"After adding and checking a key, add both updated files to source control " +"and then commit them. Entries in this file are sorted by last name." +msgstr "" + +#. type: delimited block = 6 +#: documentation/content/en/articles/committers-guide/_index.adoc:2196 +msgid "" +"It is very important to have a current PGP/GnuPG key in the repository. The " +"key may be required for positive identification of a committer. For example, " +"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:2198 +msgid "Update Mentor and Mentee Information" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2200 +msgid "" +"[.filename]#src/share/misc/committers-<repository>.dot# - Add an entry to " +"the current committers section, where _repository_ is `doc`, `ports`, or " +"`src`, depending on the commit privileges granted." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2202 +msgid "" +"Add an entry for each additional mentor/mentee relationship in the bottom " +"section." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2203 +msgid "Update git mailmap file" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2205 +msgid "" +"[.filename]#src/.mailmap#, [.filename]#doc/.mailmap#, and " +"[.filename]#ports/.mailmap# - Add an entry for commits you created prior to " +"becoming a FreeBSD committer." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2208 +msgid "" +"Mapping to your FreeBSD address allows us to track external committers who " +"may be ready for a commit bit more easily. You can also use this to correct " +"old names, mispelled names, etc in the default `git log` output." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2209 +msgid "Generate a Kerberos Password" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2211 +msgid "" +"See crossref:committers-guide[kerberos-ldap, Kerberos and LDAP web Password " +"for FreeBSD Cluster] to generate or set a Kerberos account for use with " +"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:2212 +msgid "Optional: Enable Wiki Account" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2216 +msgid "" +"link:https://wiki.freebsd.org[FreeBSD Wiki] Account - A wiki account allows " +"sharing projects and ideas. Those who do not yet have an account can follow " +"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:2217 +msgid "Optional: Update Wiki Information" +msgstr "" + +#. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:2219 -#, no-wrap -msgid "[[conventions-everyone]]\n" +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:2220 +msgid "Optional: Update Ports with Personal Information" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2222 +msgid "" +"[.filename]#ports/astro/xearth/files/freebsd.committers.markers# and " +"[.filename]#src/usr.bin/calendar/calendars/calendar.freebsd# - Some people " +"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:2223 +msgid "Optional: Prevent Duplicate Mailings" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2225 +msgid "" +"Subscribers to {dev-commits-doc-all}, {dev-commits-ports-all} or {dev-" +"commits-src-all} might wish to unsubscribe to avoid receiving duplicate " +"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:2228 #, no-wrap msgid "For Everyone" msgstr "" -#. type: delimited block . 4 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2234 +msgid "" +"Introduce yourself to the other developers, otherwise no one will have any " +"idea who you are or what you are working on. The introduction need not be a " +"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: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2235 +msgid "" +"Log into `freefall.FreeBSD.org` and create a [.filename]#/var/forward/user# " +"(where _user_ is your username) file containing the e-mail address where you " +"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: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. ====== ====" +"If your e-mail system uses SPF with strict rules, you should exclude " +"`mx2.FreeBSD.org` from SPF checks." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2241 -msgid "[[smtp-setup]]" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2242 +msgid "" +"Due to the severe load dealing with SPAM places on the central mail servers " +"that do the mailing list processing, the front-end server does do some basic " +"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:2246 +msgid "" +"Those who are developers but not committers will not be subscribed to the " +"committers or developers mailing lists. The subscriptions are derived from " +"the access rights." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:2241 +#: documentation/content/en/articles/committers-guide/_index.adoc:2250 #, no-wrap msgid "SMTP Access Setup" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2244 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2253 msgid "" "For those willing to send e-mail messages through the FreeBSD.org " "infrastructure, follow the instructions below:" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2266 -#, no-wrap +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2257 +msgid "Point your mail client at `smtp.FreeBSD.org:587`." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2258 +msgid "Enable STARTTLS." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2259 +msgid "Ensure your `From:` address is set to `_yourusername_@FreeBSD.org`." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2261 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" +"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 . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2268 +#. type: delimited block = 6 +#: documentation/content/en/articles/committers-guide/_index.adoc:2265 +msgid "Do not include `@FreeBSD.org` when entering in your username." +msgstr "" + +#. type: Block title +#: documentation/content/en/articles/committers-guide/_index.adoc:2267 #, no-wrap -msgid "[[smtp-setup-local-mta]]\n" +msgid "Additional Notes" +msgstr "" + +#. type: delimited block = 6 +#: documentation/content/en/articles/committers-guide/_index.adoc:2271 +msgid "" +"Will only accept mail from `_yourusername_@FreeBSD.org`. If you are " +"authenticated as one user, you are not permitted to send mail from another." +msgstr "" + +#. type: delimited block = 6 +#: documentation/content/en/articles/committers-guide/_index.adoc:2272 +msgid "" +"A header will be appended with the SASL username: (`Authenticated sender: " +"_username_`)." +msgstr "" + +#. type: delimited block = 6 +#: documentation/content/en/articles/committers-guide/_index.adoc:2273 +msgid "" +"Host has various rate limits in place to cut down on brute force attempts." msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:2268 +#: documentation/content/en/articles/committers-guide/_index.adoc:2277 #, no-wrap msgid "Using a Local MTA to Forward Emails to the FreeBSD.org SMTP Service" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2271 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2280 msgid "" "It is also possible to use a local MTA to forward locally sent emails to the " "FreeBSD.org SMTP servers." msgstr "" -#. type: 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:2282 +#, 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:2287 msgid "" "To tell a local Postfix instance that anything from " "`_yourusername_@FreeBSD.org` should be forwarded to the FreeBSD.org servers, " @@ -4604,149 +4955,135 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2280 -msgid "[.programlisting]" +#: documentation/content/en/articles/committers-guide/_index.adoc:2295 +#, no-wrap +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:2286 +#: documentation/content/en/articles/committers-guide/_index.adoc:2298 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" +"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: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:2302 #, no-wrap -msgid "[.programlisting]\n" +msgid "yourusername@FreeBSD.org [smtp.freebsd.org]:587\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2293 -msgid "yourusername@FreeBSD.org [smtp.freebsd.org]:587" +#: documentation/content/en/articles/committers-guide/_index.adoc:2305 +msgid "" +"Create [.filename]#/usr/local/etc/postfix/sasl_passwd# with the following " +"content:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2296 +#: documentation/content/en/articles/committers-guide/_index.adoc:2309 #, no-wrap -msgid "Create [.filename]#/usr/local/etc/postfix/sasl_passwd# with the following content:\n" +msgid "[smtp.freebsd.org]:587 yourusername:yourpassword\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2300 -#, no-wrap -msgid "[smtp.freebsd.org]:587 yourusername:yourpassword\n" +#: documentation/content/en/articles/committers-guide/_index.adoc:2312 +msgid "" +"If the email server is used by other people, you may want to prevent them " +"from sending e-mails from your address. To achieve this, add this to your " +"[.filename]#main.cf#:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2303 +#: documentation/content/en/articles/committers-guide/_index.adoc:2317 #, 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 "" +"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:2308 +#: documentation/content/en/articles/committers-guide/_index.adoc:2320 msgid "" -"smtpd_sender_login_maps = hash:/usr/local/etc/postfix/sender_login_maps " -"smtpd_sender_restrictions = reject_known_sender_login_mismatch" +"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:2311 +#: documentation/content/en/articles/committers-guide/_index.adoc:2324 #, no-wrap -msgid "Create [.filename]#/usr/local/etc/postfix/sender_login_maps# with the following content:\n" +msgid "yourusername@FreeBSD.org yourlocalusername\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2315 -msgid "yourusername@FreeBSD.org yourlocalusername" +#: documentation/content/en/articles/committers-guide/_index.adoc:2327 +msgid "" +"Where _yourlocalusername_ is the SASL username used to connect to the local " +"instance of Postfix." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2319 +#. type: Block title +#: documentation/content/en/articles/committers-guide/_index.adoc:2330 #, no-wrap -msgid "" -"Where _yourlocalusername_ is the SASL username used to connect to the local instance of Postfix.\n" -"====\n" +msgid "Using OpenSMTPD" 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:2335 msgid "" -"[[smtp-setup-local-opensmtpd]]\n" -".Using OpenSMTPD\n" -"[example]\n" -"====\n" +"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:2326 +#: documentation/content/en/articles/committers-guide/_index.adoc:2340 #, 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 "" +"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: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2331 +#: documentation/content/en/articles/committers-guide/_index.adoc:2343 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\"" +"Where _yourlocalusername_ is the SASL username used to connect to the local " +"instance of OpenSMTPD." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2334 -#, no-wrap -msgid "Where _yourlocalusername_ is the SASL username used to connect to the local instance of OpenSMTPD.\n" +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2345 +msgid "" +"Create [.filename]#/usr/local/etc/mail/secrets# with the following content:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2336 +#: documentation/content/en/articles/committers-guide/_index.adoc:2349 #, no-wrap -msgid "Create [.filename]#/usr/local/etc/mail/secrets# with the following content:\n" -msgstr "" - -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2340 -msgid "freebsd\tyourusername:yourpassword" +msgid "freebsd\tyourusername:yourpassword\n" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2347 +#. type: Block title +#: documentation/content/en/articles/committers-guide/_index.adoc:2353 #, no-wrap -msgid "" -"====\n" -"[[smtp-setup-local-exim]]\n" -".Using Exim\n" -"[example]\n" -"====\n" +msgid "Using Exim" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2350 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2359 #, no-wrap msgid "" "To direct a local Exim instance to forward all mail from `_example_@FreeBSD.org`\n" " 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:2368 #, no-wrap msgid "" "Routers section: (at the top of the list):\n" @@ -4757,8 +5094,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:2380 #, no-wrap msgid "" "Transport Section:\n" @@ -4774,8 +5111,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:2387 #, no-wrap msgid "" "Authenticators:\n" @@ -4786,37 +5123,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" +#: documentation/content/en/articles/committers-guide/_index.adoc:2390 +msgid "" +"Create [.filename]#/usr/local/etc/exim/freebsd_send# with the following " +"content:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2390 +#: documentation/content/en/articles/committers-guide/_index.adoc:2394 #, 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:2399 #, 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:2404 msgid "" "All new developers have a mentor assigned to them for the first few months. " "A mentor is responsible for teaching the mentee the rules and conventions of " @@ -4825,16 +5152,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:2407 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:2412 msgid "" "When the mentor decides that a mentee has learned the ropes and is ready to " "commit on their own, the mentor announces it with a commit to " @@ -4843,19 +5170,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:2414 #, 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:2419 msgid "" "Code review is one way to increase the quality of software. The following " "guidelines apply to commits to the `main` (-CURRENT) branch of the `src` " @@ -4864,80 +5186,129 @@ msgid "" "review:" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2416 -#, no-wrap +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2421 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 -#: 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" +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2422 +msgid "" +"Reviews may be conducted by email, in Bugzilla, in Phabricator, or by " +"another mechanism. Where possible, reviews should be public." msgstr "" -#. type: delimited block . 4 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2423 +msgid "" +"The developer responsible for a code change is also responsible for making " +"all necessary review-related changes." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2424 +msgid "" +"Code review can be an iterative process, which continues until the patch is " +"ready to be committed. Specifically, once a patch is sent out for review, it " +"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:2425 -#, no-wrap +msgid "Timeouts are not a substitute for review." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2427 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" +"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 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2429 +msgid "" +"Review other people's patches. If you help out, everybody will be more " +"willing to do the same for you; goodwill is our currency." +msgstr "" + +#. type: delimited block = 4 #: documentation/content/en/articles/committers-guide/_index.adoc:2430 -#, no-wrap 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" +"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:2433 -#, no-wrap +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2431 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" +"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:2435 -#, no-wrap -msgid "[[commit-log-message]]\n" +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2432 +msgid "" +"Split your patch into multiple smaller patches that build on each other. The " +"smaller your patch, the higher the probability that somebody will take a " +"quick look at it." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2434 +msgid "" +"When making large changes, it is helpful to keep this in mind from the " +"beginning of the effort as breaking large changes into smaller ones is often " +"difficult after the fact." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2439 +msgid "" +"Developers should participate in code reviews as both reviewers and " +"reviewees. If someone is kind enough to review your code, you should return " +"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:2442 +msgid "" +"In some cases, no subject-matter expert may be available. In those cases, a " +"review by an experienced developer is sufficient when coupled with " +"appropriate testing." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2435 +#: documentation/content/en/articles/committers-guide/_index.adoc:2444 #, no-wrap msgid "Commit Log Messages" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2438 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2447 msgid "" "This section contains some suggestions and traditions for how commit logs " "are formatted." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2439 +#: documentation/content/en/articles/committers-guide/_index.adoc:2448 #, no-wrap msgid "Why are commit messages important?" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2443 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2452 msgid "" "When you commit a change in Git, Subversion, or another version control " "system (VCS), you're prompted to write some text describing the commit -- a " @@ -4946,16 +5317,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:2455 msgid "" "Most projects have more than one developer and last for some length of " "time. Commit messages are a very important method of communicating with " "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:2458 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 +5334,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:2460 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:2462 +msgid "Communicating with other developers" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2467 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 -#: documentation/content/en/articles/committers-guide/_index.adoc:2464 -#, no-wrap +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2469 +msgid "Making Changes Discoverable" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2473 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 -#: documentation/content/en/articles/committers-guide/_index.adoc:2470 -#, no-wrap +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2475 +msgid "Providing historical documentation" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2479 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:2481 +msgid "" +"The `git blame` command annotates each line of a source file with the change " +"(hash and subject line) that brought it in." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc: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:2483 +msgid "" +"Having established the importance, here are elements of a good FreeBSD " +"commit message:" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2475 +#: documentation/content/en/articles/committers-guide/_index.adoc:2484 #, no-wrap msgid "Start with a subject line" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2479 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2488 msgid "" "Commit messages should start with a single-line subject that briefly " "summarizes the change. The subject should, by itself, allow the reader to " @@ -5029,102 +5413,103 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2480 +#: documentation/content/en/articles/committers-guide/_index.adoc:2489 #, no-wrap msgid "Keep subject lines short" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2485 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2494 msgid "" "The subject line should be as short as possible while still retaining the " "required information. This is to make browsing Git log more efficient, and " "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:2495 #, no-wrap msgid "Prefix the subject line with a component, if applicable" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2489 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2499 msgid "" "If the change relates to a specific component the subject line may be " -"prefixed with that component name and a colon (:)." +"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:2501 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:2503 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:2504 #, 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:2508 msgid "" "Capitalize the first letter of the subject itself. The prefix, if any, is " "not capitalized unless necessary (e.g., `USB:` is capitalized)." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2499 +#: documentation/content/en/articles/committers-guide/_index.adoc:2509 #, no-wrap msgid "Do not end the subject line with punctuation" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2503 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2513 msgid "" "Do not end with a period or other punctuation. In this regard the subject " "line is like a newspaper headline." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2504 +#: documentation/content/en/articles/committers-guide/_index.adoc:2514 #, no-wrap msgid "Separate the subject and body with a blank line" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2507 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2517 msgid "Separate the body from the subject with a blank line." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2509 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2519 msgid "" "Some trivial commits do not require a body, and will have only a subject." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2511 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2521 msgid "✓ `ls: Fix typo in usage text`" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2512 +#: documentation/content/en/articles/committers-guide/_index.adoc:2522 #, no-wrap msgid "Limit messages to 72 columns" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2518 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2528 msgid "" "`git log` and `git format-patch` indent the commit message by four spaces. " "Wrapping at 72 columns provides a matching margin on the right edge. " @@ -5135,13 +5520,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2519 +#: documentation/content/en/articles/committers-guide/_index.adoc:2529 #, no-wrap msgid "Use the present tense, imperative mood" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2524 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2534 msgid "" "This facilitates short subject lines and provides consistency, including " "with automatically generated commit messages (e.g., as generated by git " @@ -5150,8 +5535,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:2539 #, no-wrap msgid "" "✓ `foo: Implement the -k (keep) option`\n" @@ -5161,41 +5546,41 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2530 +#: documentation/content/en/articles/committers-guide/_index.adoc:2540 #, no-wrap msgid "Focus on what and why, not how" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2533 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2543 msgid "" "Explain what the change accomplishes and why it is being done, rather than " "how." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2537 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2547 msgid "" "Do not assume that the reader is familiar with the issue. Explain the " "background and motivation for the change. Include benchmark data if you " "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:2549 msgid "" "If there are limitations or incomplete aspects of the change, describe them " "in the commit message." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2540 +#: documentation/content/en/articles/committers-guide/_index.adoc:2550 #, no-wrap msgid "Consider whether parts of the commit message could be code comments instead" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2543 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2553 msgid "" "Sometimes while writing a commit message you may find yourself writing a " "sentence or two explaining some tricky or confusing aspect of the change. " @@ -5204,13 +5589,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2544 +#: documentation/content/en/articles/committers-guide/_index.adoc:2554 #, no-wrap msgid "Write commit messages for your future self" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2548 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2558 msgid "" "While writing the commit message for a change you have all of the context in " "mind - what prompted the change, alternate approaches that were considered " @@ -5220,13 +5605,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2549 +#: documentation/content/en/articles/committers-guide/_index.adoc:2559 #, no-wrap msgid "Commit messages should stand alone" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2553 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2563 msgid "" "You may include references to mailing list postings, benchmark result web " "sites, or code review links. However, the commit message should contain all " @@ -5234,8 +5619,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:2567 msgid "" "Similarly, a commit may refer to a previous commit, for example in the case " "of a bug fix or revert. In addition to the commit identifier (revision or " @@ -5246,66 +5631,58 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2558 +#: documentation/content/en/articles/committers-guide/_index.adoc:2568 #, no-wrap msgid "Include appropriate metadata in a footer" msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2561 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2571 msgid "" "As well as including an informative message with each commit, some " "additional information may be needed." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2563 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2573 msgid "" "This information consists of one or more lines containing the key word or " "phrase, a colon, tabs for formatting, and then the additional information." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2565 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2575 msgid "" "For key words where multiple values make sense (e.g., `PR:` with a comma-" "separated list of PRs), it is permitted to use the same keyword multiple " "times to avoid ambiguity or improve readability." msgstr "" -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2567 +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2577 msgid "The key words or phrases are:" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2572 -#, no-wrap -msgid "" -"[.informaltable]\n" -"[cols=\"20%,80%\", frame=\"none\"]" -msgstr "" - -#. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2573 +#: documentation/content/en/articles/committers-guide/_index.adoc:2583 #, no-wrap msgid "`PR:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2575 +#: documentation/content/en/articles/committers-guide/_index.adoc:2585 #, no-wrap msgid "The problem report (if any) which is affected (typically, by being closed) by this commit. Multiple PRs may be specified on one line, separated by commas or spaces." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2576 +#: documentation/content/en/articles/committers-guide/_index.adoc:2586 #, no-wrap msgid "`Reported by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2580 +#: documentation/content/en/articles/committers-guide/_index.adoc:2590 #, no-wrap msgid "" "The name and e-mail address of the person that reported the issue; for developers, just the username on the FreeBSD cluster.\n" @@ -5314,7 +5691,7 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2582 +#: documentation/content/en/articles/committers-guide/_index.adoc:2592 #, no-wrap msgid "" "`Submitted by:` +\n" @@ -5322,19 +5699,19 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2584 +#: documentation/content/en/articles/committers-guide/_index.adoc:2594 #, no-wrap msgid "This has been deprecated with git; submitted patches should have the author set by using `git commit --author` with a full name and valid email." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2585 +#: documentation/content/en/articles/committers-guide/_index.adoc:2595 #, no-wrap msgid "`Reviewed by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2600 +#: documentation/content/en/articles/committers-guide/_index.adoc:2610 #, no-wrap msgid "" "The name and e-mail address of the person or people that reviewed the change; for developers, just the username on the FreeBSD cluster. If a patch was submitted to a mailing list for review, and the review was favorable, then just include the list name. If the reviewer is not a member of the project, provide the name, email, and if ports an external role like maintainer:\n" @@ -5353,25 +5730,25 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2601 +#: documentation/content/en/articles/committers-guide/_index.adoc:2611 #, no-wrap msgid "`Tested by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2603 +#: documentation/content/en/articles/committers-guide/_index.adoc:2613 #, no-wrap msgid "The name and e-mail address of the person or people that tested the change; for developers, just the username on the FreeBSD cluster." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2604 +#: documentation/content/en/articles/committers-guide/_index.adoc:2614 #, no-wrap msgid "`Discussed with:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2607 +#: documentation/content/en/articles/committers-guide/_index.adoc:2617 #, no-wrap msgid "" "The name and e-mail address of the person or people that contributed to the patch by providing meaningful feedback; for developers, just the username on the FreeBSD cluster.\n" @@ -5379,13 +5756,13 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2608 +#: documentation/content/en/articles/committers-guide/_index.adoc:2618 #, no-wrap msgid "`Approved by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2634 +#: documentation/content/en/articles/committers-guide/_index.adoc:2644 #, no-wrap msgid "" "The name and e-mail address of the person or people that approved the change; for developers, just the username on the FreeBSD cluster.\n" @@ -5414,25 +5791,25 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2635 +#: documentation/content/en/articles/committers-guide/_index.adoc:2645 #, no-wrap msgid "`Obtained from:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2637 +#: documentation/content/en/articles/committers-guide/_index.adoc:2647 #, no-wrap msgid "The name of the project (if any) from which the code was obtained. Do not use this line for the name of an individual person." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2638 +#: documentation/content/en/articles/committers-guide/_index.adoc:2648 #, no-wrap msgid "`Fixes:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2641 +#: documentation/content/en/articles/committers-guide/_index.adoc:2651 #, no-wrap msgid "" "The Git short hash and the title line of a commit that is fixed by this change as returned by `git log -n 1 --pretty=format:'%h (\"%s\")' GIT-COMMIT-HASH`.\n" @@ -5440,97 +5817,121 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2642 +#: documentation/content/en/articles/committers-guide/_index.adoc:2652 #, no-wrap msgid "`MFC after:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2644 +#: documentation/content/en/articles/committers-guide/_index.adoc:2654 #, no-wrap msgid "To receive an e-mail reminder to MFC at a later date, specify the number of days, weeks, or months after which an MFC is planned." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2645 +#: documentation/content/en/articles/committers-guide/_index.adoc:2655 #, no-wrap msgid "`MFC to:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2647 +#: documentation/content/en/articles/committers-guide/_index.adoc:2657 #, no-wrap msgid "If the commit should be merged to a subset of stable branches, specify the branch names." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2648 +#: documentation/content/en/articles/committers-guide/_index.adoc:2658 #, no-wrap msgid "`MFH:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2650 +#: documentation/content/en/articles/committers-guide/_index.adoc:2660 #, no-wrap msgid "If the commit is to be merged into a ports quarterly branch name, specify the quarterly branch. For example `2021Q2`." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2651 +#: documentation/content/en/articles/committers-guide/_index.adoc:2661 #, no-wrap msgid "`Relnotes:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2653 +#: documentation/content/en/articles/committers-guide/_index.adoc:2662 #, no-wrap msgid "If the change is a candidate for inclusion in the release notes for the next release from the branch, set to `yes`." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2654 +#: documentation/content/en/articles/committers-guide/_index.adoc:2663 +#, no-wrap +msgid "Candidates are user-visible changes, new features, compatibility breaks, etc.." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2664 +#, no-wrap +msgid "If you forget to set this line, or want to provide more details, add an entry to the `RELNOTES` file in the root of the src tree." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2665 +#, no-wrap +msgid "The `RELNOTES` file is used to generate release notes for the next release." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2667 +#, no-wrap +msgid "Do not use the `Relnotes:` line to describe the change: its only valid value is `yes`." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2668 #, no-wrap msgid "`Security:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2656 +#: documentation/content/en/articles/committers-guide/_index.adoc:2670 #, no-wrap msgid "If the change is related to a security vulnerability or security exposure, include one or more references or a description of the issue. If possible, include a VuXML URL or a CVE ID." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2657 +#: documentation/content/en/articles/committers-guide/_index.adoc:2671 #, no-wrap msgid "`Event:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2659 +#: documentation/content/en/articles/committers-guide/_index.adoc:2673 #, no-wrap msgid "The description for the event where this commit was made. If this is a recurring event, add the year or even the month to it. For example, this could be `FooBSDcon 2019`. The idea behind this line is to put recognition to conferences, gatherings, and other types of meetups and to show that these are useful to have. Please do not use the `Sponsored by:` line for this as that is meant for organizations sponsoring certain features or developers working on them." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2660 +#: documentation/content/en/articles/committers-guide/_index.adoc:2674 #, no-wrap msgid "`Sponsored by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2662 +#: documentation/content/en/articles/committers-guide/_index.adoc:2676 #, no-wrap msgid "Sponsoring organizations for this change, if any. Separate multiple organizations with commas. If only a portion of the work was sponsored, or different amounts of sponsorship were provided to different authors, please give appropriate credit in parentheses after each sponsor name. For example, `Example.com (alice, code refactoring), Wormulon (bob), Momcorp (cindy)` shows that Alice was sponsored by Example.com to do code refactoring, while Wormulon sponsored Bob's work and Momcorp sponsored Cindy's work. Other authors were either not sponsored or chose not to list sponsorship." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2663 +#: documentation/content/en/articles/committers-guide/_index.adoc:2677 #, no-wrap msgid "`Pull Request:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2667 +#: documentation/content/en/articles/committers-guide/_index.adoc:2681 #, no-wrap msgid "" "This change was submitted as a pull request or merge request against one of FreeBSD's public read-only Git repositories.\n" @@ -5539,13 +5940,13 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2668 +#: documentation/content/en/articles/committers-guide/_index.adoc:2682 #, no-wrap msgid "`Co-authored-by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2671 +#: documentation/content/en/articles/committers-guide/_index.adoc:2685 #, no-wrap msgid "" "The name and email address of an additional author of the commit.\n" @@ -5553,73 +5954,73 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2672 +#: documentation/content/en/articles/committers-guide/_index.adoc:2686 #, no-wrap msgid "`Signed-off-by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2674 +#: documentation/content/en/articles/committers-guide/_index.adoc:2688 #, no-wrap msgid "ID certifies compliance with https://developercertificate.org/" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2675 +#: documentation/content/en/articles/committers-guide/_index.adoc:2689 #, no-wrap msgid "`Differential Revision:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2677 +#: documentation/content/en/articles/committers-guide/_index.adoc:2691 #, no-wrap msgid "The full URL of the Phabricator review. This line __must be the last line__. For example: `https://reviews.freebsd.org/D1708`." msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2679 +#: documentation/content/en/articles/committers-guide/_index.adoc:2693 #, no-wrap msgid "Commit Log for a Commit Based on a PR" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2685 +#: documentation/content/en/articles/committers-guide/_index.adoc:2699 msgid "" "The commit is based on a patch from a PR submitted by John Smith. The " "commit message \"PR\" field is filled." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc: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:2703 +#: documentation/content/en/articles/committers-guide/_index.adoc:2721 +#: documentation/content/en/articles/committers-guide/_index.adoc:2736 +#: documentation/content/en/articles/committers-guide/_index.adoc:2752 +#: documentation/content/en/articles/committers-guide/_index.adoc:2767 #, no-wrap msgid "...\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2691 +#: documentation/content/en/articles/committers-guide/_index.adoc:2705 #, no-wrap msgid "PR:\t\t12345\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2694 +#: documentation/content/en/articles/committers-guide/_index.adoc:2708 msgid "" "The committer sets the author of the patch with `git commit --author \"John " "Smith <John.Smith@example.com>\"`." msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2697 +#: documentation/content/en/articles/committers-guide/_index.adoc:2711 #, no-wrap msgid "Commit Log for a Commit Needing Review" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2703 +#: documentation/content/en/articles/committers-guide/_index.adoc:2717 msgid "" "The virtual memory system is being changed. After posting patches to the " "appropriate mailing list (in this case, `freebsd-arch`) and the changes have " @@ -5627,73 +6028,73 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2709 +#: documentation/content/en/articles/committers-guide/_index.adoc:2723 #, no-wrap msgid "Reviewed by:\t-arch\n" msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2713 +#: documentation/content/en/articles/committers-guide/_index.adoc:2727 #, no-wrap msgid "Commit Log for a Commit Needing Approval" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2718 +#: documentation/content/en/articles/committers-guide/_index.adoc:2732 msgid "" "Commit a port, after working with the listed MAINTAINER, who said to go " "ahead and commit." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2724 +#: documentation/content/en/articles/committers-guide/_index.adoc:2738 #, no-wrap msgid "Approved by:\tabc (maintainer)\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2727 +#: documentation/content/en/articles/committers-guide/_index.adoc:2741 msgid "Where _abc_ is the account name of the person who approved." msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2729 +#: documentation/content/en/articles/committers-guide/_index.adoc:2743 #, no-wrap msgid "Commit Log for a Commit Bringing in Code from OpenBSD" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2734 +#: documentation/content/en/articles/committers-guide/_index.adoc:2748 msgid "Committing some code based on work done in the OpenBSD project." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2740 +#: documentation/content/en/articles/committers-guide/_index.adoc:2754 #, no-wrap msgid "Obtained from:\tOpenBSD\n" msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2744 +#: documentation/content/en/articles/committers-guide/_index.adoc:2758 #, no-wrap msgid "Commit Log for a Change to FreeBSD-CURRENT with a Planned Commit to FreeBSD-STABLE to Follow at a Later Date." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2749 +#: documentation/content/en/articles/committers-guide/_index.adoc:2763 msgid "" "Committing some code which will be merged from FreeBSD-CURRENT into the " "FreeBSD-STABLE branch after two weeks." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2755 +#: documentation/content/en/articles/committers-guide/_index.adoc:2769 #, no-wrap msgid "MFC after:\t2 weeks\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2758 +#: documentation/content/en/articles/committers-guide/_index.adoc:2772 msgid "" "Where _2_ is the number of days, weeks, or months after which an MFC is " "planned. The _weeks_ option may be `day`, `days`, `week`, `weeks`, `month`, " @@ -5701,12 +6102,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2761 +#: documentation/content/en/articles/committers-guide/_index.adoc:2775 msgid "It is often necessary to combine these." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2765 +#: documentation/content/en/articles/committers-guide/_index.adoc:2779 msgid "" "Consider the situation where a user has submitted a PR containing code from " "the NetBSD project. Looking at the PR, the developer sees it is not an area " @@ -5716,19 +6117,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2767 +#: documentation/content/en/articles/committers-guide/_index.adoc:2781 msgid "" "The extra information to include in the commit would look something like" msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2768 +#: documentation/content/en/articles/committers-guide/_index.adoc:2782 #, no-wrap msgid "Example Combined Commit Log" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2779 +#: documentation/content/en/articles/committers-guide/_index.adoc:2793 #, no-wrap msgid "" "PR:\t\t54321\n" @@ -5739,13 +6140,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2784 +#: documentation/content/en/articles/committers-guide/_index.adoc:2798 #, no-wrap msgid "Preferred License for New Files" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2790 +#: documentation/content/en/articles/committers-guide/_index.adoc:2804 msgid "" "The FreeBSD Project's full license policy can be found at link:https://" "www.FreeBSD.org/internal/software-license/[https://www.FreeBSD.org/internal/" @@ -5755,14 +6156,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2792 +#: documentation/content/en/articles/committers-guide/_index.adoc:2806 msgid "" "The FreeBSD Project suggests and uses this text as the preferred license " "scheme:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2823 +#: documentation/content/en/articles/committers-guide/_index.adoc:2837 #, no-wrap msgid "" "/*\n" @@ -5796,7 +6197,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2829 +#: documentation/content/en/articles/committers-guide/_index.adoc:2843 msgid "" "The FreeBSD project strongly discourages the so-called \"advertising " "clause\" in new code. Due to the large number of contributors to the " @@ -5807,7 +6208,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2833 +#: documentation/content/en/articles/committers-guide/_index.adoc:2847 msgid "" "The FreeBSD project discourages completely new licenses and variations on " "the standard licenses. New licenses require the approval of {core-email} to " @@ -5818,7 +6219,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2837 +#: documentation/content/en/articles/committers-guide/_index.adoc:2851 msgid "" "Project policy dictates that code under some non-BSD licenses must be placed " "only in specific sections of the repository, and in some cases, compilation " @@ -5829,7 +6230,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2840 +#: documentation/content/en/articles/committers-guide/_index.adoc:2854 msgid "" "Developers are reminded that in open source, getting \"open\" right is just " "as important as getting \"source\" right, as improper handling of " @@ -5838,13 +6239,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2842 +#: documentation/content/en/articles/committers-guide/_index.adoc:2856 #, no-wrap msgid "Keeping Track of Licenses Granted to the FreeBSD Project" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2847 +#: documentation/content/en/articles/committers-guide/_index.adoc:2861 msgid "" "Various software or data exist in the repositories where the FreeBSD project " "has been granted a special license to be able to use them. A case in point " @@ -5855,7 +6256,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2852 +#: documentation/content/en/articles/committers-guide/_index.adoc:2866 msgid "" "It is clearly sensible to keep a record of any such license grants. To that " "end, the {core-email} has decided to keep an archive of them. Whenever the " @@ -5865,13 +6266,13 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2854 +#: documentation/content/en/articles/committers-guide/_index.adoc:2868 msgid "" "Contact details for people or organizations granting the special license." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2855 +#: documentation/content/en/articles/committers-guide/_index.adoc:2869 msgid "" "What files, directories etc. in the repositories are covered by the license " "grant including the revision numbers where any specially licensed material " @@ -5879,7 +6280,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2856 +#: documentation/content/en/articles/committers-guide/_index.adoc:2870 msgid "" "The date the license comes into effect from. Unless otherwise agreed, this " "will be the date the license was issued by the authors of the software in " @@ -5887,24 +6288,24 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2857 +#: documentation/content/en/articles/committers-guide/_index.adoc:2871 msgid "The license text." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2858 +#: documentation/content/en/articles/committers-guide/_index.adoc:2872 msgid "" "A note of any restrictions, limitations or exceptions that apply " "specifically to FreeBSD's usage of the licensed material." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2859 +#: documentation/content/en/articles/committers-guide/_index.adoc:2873 msgid "Any other relevant information." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2862 +#: documentation/content/en/articles/committers-guide/_index.adoc:2876 msgid "" "Once the {core-email} is satisfied that all the necessary details have been " "gathered and are correct, the secretary will send a PGP-signed " @@ -5914,7 +6315,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2865 +#: documentation/content/en/articles/committers-guide/_index.adoc:2879 msgid "" "The license archive should contain only details of license grants; this is " "not the place for any discussions around licensing or other subjects. " @@ -5923,13 +6324,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2867 +#: documentation/content/en/articles/committers-guide/_index.adoc:2881 #, no-wrap msgid "SPDX Tags in the tree" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2878 +#: documentation/content/en/articles/committers-guide/_index.adoc:2892 msgid "" "The project uses https://spdx.dev[SPDX] tags in our source base. At " "present, these tags are indented to help automated tools reconstruct license " @@ -5948,20 +6349,20 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2880 +#: documentation/content/en/articles/committers-guide/_index.adoc:2894 msgid "" "As of March 2021, approximately 25,000 out of 90,000 files in the tree have " "been marked." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2881 +#: documentation/content/en/articles/committers-guide/_index.adoc:2895 #, no-wrap msgid "Developer Relations" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2887 +#: documentation/content/en/articles/committers-guide/_index.adoc:2901 msgid "" "When working directly on your own code or on code which is already well " "established as your responsibility, then there is probably little need to " @@ -5974,7 +6375,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2891 +#: documentation/content/en/articles/committers-guide/_index.adoc:2905 msgid "" "To determine if an area of the tree is maintained, check the MAINTAINERS " "file at the root of the tree. If nobody is listed, scan the revision " @@ -5985,27 +6386,27 @@ msgid "" msgstr "" #. type: delimited block - 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2895 +#: documentation/content/en/articles/committers-guide/_index.adoc:2909 #, no-wrap msgid "% git -C /path/to/repo shortlog -sne --since=\"2 years\" -- relative/path/to/file\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2898 +#: documentation/content/en/articles/committers-guide/_index.adoc:2912 msgid "" "If queries go unanswered or the committer otherwise indicates a lack of " "interest in the area affected, go ahead and commit it." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2903 +#: documentation/content/en/articles/committers-guide/_index.adoc:2917 msgid "" "Avoid sending private emails to maintainers. Other people might be " "interested in the conversation, not just the final output." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2909 +#: documentation/content/en/articles/committers-guide/_index.adoc:2923 msgid "" "If there is any doubt about a commit for any reason at all, have it reviewed " "before committing. Better to have it flamed then and there rather than when " @@ -6016,7 +6417,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2913 +#: documentation/content/en/articles/committers-guide/_index.adoc:2927 msgid "" "Do not impugn the intentions of others. If they see a different solution to " "a problem, or even a different problem, it is probably not because they are " @@ -6026,7 +6427,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2916 +#: documentation/content/en/articles/committers-guide/_index.adoc:2930 msgid "" "Disagree honestly. Argue your position from its merits, be honest about any " "shortcomings it may have, and be open to seeing their solution, or even " @@ -6034,7 +6435,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2922 +#: documentation/content/en/articles/committers-guide/_index.adoc:2936 msgid "" "Accept correction. We are all fallible. When you have made a mistake, " "apologize and get on with life. Do not beat up yourself, and certainly do " @@ -6043,7 +6444,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2926 +#: documentation/content/en/articles/committers-guide/_index.adoc:2940 msgid "" "Ask for help. Seek out (and give) peer reviews. One of the ways open " "source software is supposed to excel is in the number of eyeballs applied to " @@ -6051,20 +6452,20 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2928 +#: documentation/content/en/articles/committers-guide/_index.adoc:2942 #, no-wrap msgid "If in Doubt..." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2932 +#: documentation/content/en/articles/committers-guide/_index.adoc:2946 msgid "" "When unsure about something, whether it be a technical issue or a project " "convention be sure to ask. If you stay silent you will never make progress." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2936 +#: documentation/content/en/articles/committers-guide/_index.adoc:2950 msgid "" "If it relates to a technical issue ask on the public mailing lists. Avoid " "the temptation to email the individual person that knows the answer. This " @@ -6072,32 +6473,32 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2938 +#: documentation/content/en/articles/committers-guide/_index.adoc:2952 msgid "For project specific or administrative questions ask, in order:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2940 +#: documentation/content/en/articles/committers-guide/_index.adoc:2954 msgid "Your mentor or former mentor." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2941 +#: documentation/content/en/articles/committers-guide/_index.adoc:2955 msgid "An experienced committer on IRC, email, etc." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2942 +#: documentation/content/en/articles/committers-guide/_index.adoc:2956 msgid "Any team with a \"hat\", as they can give you a definitive answer." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2943 +#: documentation/content/en/articles/committers-guide/_index.adoc:2957 msgid "If still not sure, ask on {developers-name}." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2945 +#: documentation/content/en/articles/committers-guide/_index.adoc:2959 msgid "" "Once your question is answered, if no one pointed you to documentation that " "spelled out the answer to your question, document it, as others will have " @@ -6105,13 +6506,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2947 +#: documentation/content/en/articles/committers-guide/_index.adoc:2961 #, no-wrap msgid "Bugzilla" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2952 +#: documentation/content/en/articles/committers-guide/_index.adoc:2966 msgid "" "The FreeBSD Project utilizes Bugzilla for tracking bugs and change " "requests. If you commit a fix or suggestion found in the PR database, be " @@ -6120,26 +6521,26 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2954 +#: documentation/content/en/articles/committers-guide/_index.adoc:2968 msgid "" "Committers with non-``FreeBSD.org`` Bugzilla accounts can have the old " "account merged with the `FreeBSD.org` account by following these steps:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2958 +#: documentation/content/en/articles/committers-guide/_index.adoc:2972 msgid "Log in using your old account." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2959 +#: documentation/content/en/articles/committers-guide/_index.adoc:2973 msgid "" "Open new bug. Choose `Services` as the Product, and `Bug Tracker` as the " "Component. In bug description list accounts you wish to be merged." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2961 +#: documentation/content/en/articles/committers-guide/_index.adoc:2975 msgid "" "Log in using `FreeBSD.org` account and post comment to newly opened bug to " "confirm ownership. See crossref:committers-guide[kerberos-ldap, Kerberos and " @@ -6148,35 +6549,35 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2962 +#: documentation/content/en/articles/committers-guide/_index.adoc:2976 msgid "" "If there are more than two accounts to merge, post comments from each of " "them." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2965 +#: documentation/content/en/articles/committers-guide/_index.adoc:2979 msgid "You can find out more about Bugzilla at:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2967 +#: documentation/content/en/articles/committers-guide/_index.adoc:2981 msgid "extref:{pr-guidelines}[FreeBSD Problem Report Handling Guidelines]" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2968 +#: documentation/content/en/articles/committers-guide/_index.adoc:2982 msgid "link:https://www.FreeBSD.org/support/[https://www.FreeBSD.org/support]" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2970 +#: documentation/content/en/articles/committers-guide/_index.adoc:2984 #, no-wrap msgid "Phabricator" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2974 +#: documentation/content/en/articles/committers-guide/_index.adoc:2988 msgid "" "The FreeBSD Project utilizes https://reviews.freebsd.org[Phabricator] for " "code review requests. See the https://wiki.freebsd.org/" @@ -6184,19 +6585,28 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2976 +#: documentation/content/en/articles/committers-guide/_index.adoc:2991 +msgid "" +"Please use the `git arc` command provided by `devel/freebsd-git-devtools` " +"(install the port or package, then type `git help arc` for documentation) to " +"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:2993 msgid "" "Committers with non-``FreeBSD.org`` Phabricator accounts can have the old " "account renamed to the ``FreeBSD.org`` account by following these steps:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2980 +#: documentation/content/en/articles/committers-guide/_index.adoc:2997 msgid "Change your Phabricator account email to your `FreeBSD.org` email." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2982 +#: documentation/content/en/articles/committers-guide/_index.adoc:2999 msgid "" "Open new bug on our bug tracker using your `FreeBSD.org` account, see " "crossref:committers-guide[bugzilla, Bugzilla] for more information. Choose " @@ -6207,19 +6617,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2987 +#: documentation/content/en/articles/committers-guide/_index.adoc:3004 msgid "" "Phabricator accounts cannot be merged, please do not open a new account." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2990 +#: documentation/content/en/articles/committers-guide/_index.adoc:3007 #, no-wrap msgid "Who's Who" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2993 +#: documentation/content/en/articles/committers-guide/_index.adoc:3010 msgid "" "Besides the repository meisters, there are other FreeBSD project members and " "teams whom you will probably get to know in your role as a committer. " @@ -6227,13 +6637,13 @@ msgid "" msgstr "" #. type: Labeled list -#: documentation/content/en/articles/committers-guide/_index.adoc:2994 +#: documentation/content/en/articles/committers-guide/_index.adoc:3011 #, no-wrap msgid "`{doceng}`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3000 +#: documentation/content/en/articles/committers-guide/_index.adoc:3017 msgid "" "doceng is the group responsible for the documentation build infrastructure, " "approving new documentation committers, and ensuring that the FreeBSD " @@ -6247,13 +6657,13 @@ msgid "" msgstr "" #. type: Labeled list -#: documentation/content/en/articles/committers-guide/_index.adoc:3001 +#: documentation/content/en/articles/committers-guide/_index.adoc:3018 #, no-wrap msgid "`{re-members}`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3006 +#: documentation/content/en/articles/committers-guide/_index.adoc:3023 msgid "" "These are the members of the `{re}`. This team is responsible for setting " "release deadlines and controlling the release process. During code freezes, " @@ -6264,20 +6674,20 @@ msgid "" msgstr "" #. type: Labeled list -#: documentation/content/en/articles/committers-guide/_index.adoc:3007 +#: documentation/content/en/articles/committers-guide/_index.adoc:3024 #, no-wrap msgid "`{so}`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3009 +#: documentation/content/en/articles/committers-guide/_index.adoc:3026 msgid "" "`{so-name}` is the link:https://www.FreeBSD.org/security/[FreeBSD Security " "Officer] and oversees the `{security-officer}`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3014 +#: documentation/content/en/articles/committers-guide/_index.adoc:3031 msgid "" "{committers-name}:: {dev-src-all}, {dev-ports-all} and {dev-doc-all} are the " "mailing lists that the version control system uses to send commit messages " @@ -6286,7 +6696,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3019 +#: documentation/content/en/articles/committers-guide/_index.adoc:3036 msgid "" "{developers-name}:: All committers are subscribed to -developers. This list " "was created to be a forum for the committers \"community\" issues. Examples " @@ -6294,7 +6704,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3023 +#: documentation/content/en/articles/committers-guide/_index.adoc:3040 msgid "" "The {developers-name} is for the exclusive use of FreeBSD committers. To " "develop FreeBSD, committers must have the ability to openly discuss matters " @@ -6304,7 +6714,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3027 +#: documentation/content/en/articles/committers-guide/_index.adoc:3044 msgid "" "All FreeBSD committers are expected not to not publish or forward messages " "from the {developers-name} outside the list membership without permission of " @@ -6314,7 +6724,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3033 +#: documentation/content/en/articles/committers-guide/_index.adoc:3050 msgid "" "This list is _not_ intended as a place for code reviews or for any technical " "discussion. In fact using it as such hurts the FreeBSD Project as it gives " @@ -6327,13 +6737,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3034 +#: documentation/content/en/articles/committers-guide/_index.adoc:3051 #, no-wrap msgid "SSH Quick-Start Guide" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3039 +#: documentation/content/en/articles/committers-guide/_index.adoc:3056 msgid "" "If you do not wish to type your password in every time you use man:ssh[1], " "and you use keys to authenticate, man:ssh-agent[1] is there for your " @@ -6344,19 +6754,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3040 +#: documentation/content/en/articles/committers-guide/_index.adoc:3057 msgid "" "Generate a key pair using man:ssh-keygen[1]. The key pair will wind up in " "your [.filename]#$HOME/.ssh/# directory." msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3044 +#: documentation/content/en/articles/committers-guide/_index.adoc:3061 msgid "Only ECDSA, Ed25519 or RSA keys are supported." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3046 +#: documentation/content/en/articles/committers-guide/_index.adoc:3063 msgid "" "Send your public key ([.filename]#$HOME/.ssh/id_ecdsa.pub#, " "[.filename]#$HOME/.ssh/id_ed25519.pub#, or [.filename]#$HOME/.ssh/" @@ -6365,7 +6775,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3051 +#: documentation/content/en/articles/committers-guide/_index.adoc:3068 msgid "" "Now man:ssh-add[1] can be used for authentication once per session. It " "prompts for the private key's pass phrase, and then stores it in the " @@ -6374,32 +6784,32 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3053 +#: documentation/content/en/articles/committers-guide/_index.adoc:3070 msgid "Test with a simple remote command: `ssh freefall.FreeBSD.org ls /usr`." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3055 +#: documentation/content/en/articles/committers-guide/_index.adoc:3072 msgid "" "For more information, see package:security/openssh-portable[], man:ssh[1], " "man:ssh-add[1], man:ssh-agent[1], man:ssh-keygen[1], and man:scp[1]." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3057 +#: documentation/content/en/articles/committers-guide/_index.adoc:3074 msgid "" "For information on adding, changing, or removing man:ssh[1] keys, see " "https://wiki.freebsd.org/clusteradm/ssh-keys[this article]." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3059 +#: documentation/content/en/articles/committers-guide/_index.adoc:3076 #, no-wrap msgid "Coverity(R) Availability for FreeBSD Committers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3063 +#: documentation/content/en/articles/committers-guide/_index.adoc:3080 msgid "" "All FreeBSD developers can obtain access to Coverity analysis results of all " "FreeBSD Project software. All who are interested in obtaining access to the " @@ -6408,7 +6818,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3066 +#: documentation/content/en/articles/committers-guide/_index.adoc:3083 msgid "" "The FreeBSD wiki includes a mini-guide for developers who are interested in " "working with the Coverity(R) analysis reports: https://wiki.freebsd.org/" @@ -6419,7 +6829,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3068 +#: documentation/content/en/articles/committers-guide/_index.adoc:3085 msgid "" "Finally, all FreeBSD developers who are going to use Coverity(R) are always " "encouraged to ask for more details and usage information, by posting any " @@ -6427,13 +6837,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3070 +#: documentation/content/en/articles/committers-guide/_index.adoc:3087 #, no-wrap msgid "The FreeBSD Committers' Big List of Rules" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3075 +#: documentation/content/en/articles/committers-guide/_index.adoc:3092 msgid "" "Everyone involved with the FreeBSD project is expected to abide by the _Code " "of Conduct_ available from link:https://www.FreeBSD.org/internal/code-of-" @@ -6444,25 +6854,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:3094 +#: documentation/content/en/articles/committers-guide/_index.adoc:3124 msgid "Respect other committers." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3078 -#: documentation/content/en/articles/committers-guide/_index.adoc:3123 +#: documentation/content/en/articles/committers-guide/_index.adoc:3095 +#: documentation/content/en/articles/committers-guide/_index.adoc:3140 msgid "Respect other contributors." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3079 -#: documentation/content/en/articles/committers-guide/_index.adoc:3138 +#: documentation/content/en/articles/committers-guide/_index.adoc:3096 +#: documentation/content/en/articles/committers-guide/_index.adoc:3155 msgid "Discuss any significant change _before_ committing." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3080 +#: documentation/content/en/articles/committers-guide/_index.adoc:3097 msgid "" "Respect existing maintainers (if listed in the `MAINTAINER` field in " "[.filename]#Makefile# or in [.filename]#MAINTAINER# in the top-level " @@ -6470,8 +6880,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:3098 +#: documentation/content/en/articles/committers-guide/_index.adoc:3170 msgid "" "Any disputed change must be backed out pending resolution of the dispute if " "requested by a maintainer. Security related changes may override a " @@ -6479,7 +6889,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3082 +#: documentation/content/en/articles/committers-guide/_index.adoc:3099 msgid "" "Changes go to FreeBSD-CURRENT before FreeBSD-STABLE unless specifically " "permitted by the release engineer or unless they are not applicable to " @@ -6491,40 +6901,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:3100 +#: documentation/content/en/articles/committers-guide/_index.adoc:3185 msgid "Do not fight in public with other committers; it looks bad." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3084 +#: documentation/content/en/articles/committers-guide/_index.adoc:3101 msgid "" "Respect all code freezes and read the `committers` and `developers` mailing " "lists in a timely manner so you know when a code freeze is in effect." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3085 -#: documentation/content/en/articles/committers-guide/_index.adoc:3183 +#: documentation/content/en/articles/committers-guide/_index.adoc:3102 +#: documentation/content/en/articles/committers-guide/_index.adoc:3200 msgid "When in doubt on any procedure, ask first!" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3086 -#: documentation/content/en/articles/committers-guide/_index.adoc:3188 +#: documentation/content/en/articles/committers-guide/_index.adoc:3103 +#: documentation/content/en/articles/committers-guide/_index.adoc:3205 msgid "Test your changes before committing them." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3087 -#: documentation/content/en/articles/committers-guide/_index.adoc:3198 +#: documentation/content/en/articles/committers-guide/_index.adoc:3104 +#: documentation/content/en/articles/committers-guide/_index.adoc:3215 msgid "" "Do not commit to contributed software without _explicit_ approval from the " "respective maintainers." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3098 +#: documentation/content/en/articles/committers-guide/_index.adoc:3115 msgid "" "As noted, breaking some of these rules can be grounds for suspension or, " "upon repeated offense, permanent removal of commit privileges. Individual " @@ -6550,7 +6960,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3102 +#: documentation/content/en/articles/committers-guide/_index.adoc:3119 msgid "" "In all other aspects of project operation, core is a subset of committers " "and is bound by the __same rules__. Just because someone is in core this " @@ -6561,13 +6971,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3103 +#: documentation/content/en/articles/committers-guide/_index.adoc:3120 #, no-wrap msgid "Details" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3111 +#: documentation/content/en/articles/committers-guide/_index.adoc:3128 msgid "" "This means that you need to treat other committers as the peer-group " "developers that they are. Despite our occasional attempts to prove the " @@ -6579,7 +6989,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3113 +#: documentation/content/en/articles/committers-guide/_index.adoc:3130 msgid "" "Being able to work together long term is this project's greatest asset, one " "far more important than any set of changes to the code, and turning " @@ -6589,7 +6999,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3119 +#: documentation/content/en/articles/committers-guide/_index.adoc:3136 msgid "" "To comply with this rule, do not send email when you are angry or otherwise " "behave in a manner which is likely to strike others as needlessly " @@ -6608,7 +7018,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3122 +#: documentation/content/en/articles/committers-guide/_index.adoc:3139 msgid "" "All of this is never an option which the project's leadership enjoys in the " "slightest, but unity comes first. No amount of code or good advice is worth " @@ -6616,7 +7026,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3135 +#: documentation/content/en/articles/committers-guide/_index.adoc:3152 msgid "" "You were not always a committer. At one time you were a contributor. " "Remember that at all times. Remember what it was like trying to get help " @@ -6630,14 +7040,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3137 +#: documentation/content/en/articles/committers-guide/_index.adoc:3154 msgid "" "Consider the points raised under crossref:committers-guide[respect,Respect " "other committers] and apply them also to contributors." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3144 +#: documentation/content/en/articles/committers-guide/_index.adoc:3161 msgid "" "The repository is not where changes are initially submitted for correctness " "or argued over, that happens first in the mailing lists or by use of the " @@ -6653,25 +7063,25 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3146 +#: documentation/content/en/articles/committers-guide/_index.adoc:3163 msgid "When in doubt, ask for review!" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3147 +#: documentation/content/en/articles/committers-guide/_index.adoc:3164 msgid "Respect existing maintainers if listed." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3152 +#: documentation/content/en/articles/committers-guide/_index.adoc:3169 msgid "" "Many parts of FreeBSD are not \"owned\" in the sense that any specific " "individual will jump up and yell if you commit a change to \"their\" area, " "but it still pays to check first. One convention we use is to put a " "maintainer line in the [.filename]#Makefile# for any package or subtree " "which is being actively maintained by one or more people; see extref:" -"{developers-handbook}[Source Tree Guidelines and Policies, policies] for " -"documentation on this. Where sections of code have several maintainers, " +"{developers-handbook}policies[Source Tree Guidelines and Policies, policies] " +"for documentation on this. Where sections of code have several maintainers, " "commits to affected areas by one maintainer need to be reviewed by at least " "one other maintainer. In cases where the \"maintainer-ship\" of something " "is not clear, look at the repository logs for the files in question and see " @@ -6679,7 +7089,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3158 +#: documentation/content/en/articles/committers-guide/_index.adoc:3175 msgid "" "This may be hard to swallow in times of conflict (when each side is " "convinced that they are in the right, of course) but a version control " @@ -6697,7 +7107,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3159 +#: documentation/content/en/articles/committers-guide/_index.adoc:3176 msgid "" "Changes go to FreeBSD-CURRENT before FreeBSD-STABLE unless specifically " "permitted by the release engineer or unless they are not applicable to " @@ -6708,7 +7118,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3165 +#: documentation/content/en/articles/committers-guide/_index.adoc:3182 msgid "" "This is another \"do not argue about it\" issue since it is the release " "engineer who is ultimately responsible (and gets beaten up) if a change " @@ -6727,7 +7137,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3167 +#: documentation/content/en/articles/committers-guide/_index.adoc:3184 msgid "" "Changes to the security branches (for example, `releng/9.3`) must be " "approved by a member of the `{security-officer}`, or in some cases, by a " @@ -6735,7 +7145,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3178 +#: documentation/content/en/articles/committers-guide/_index.adoc:3195 msgid "" "This project has a public image to uphold and that image is very important " "to all of us, especially if we are to continue to attract new members. " @@ -6760,14 +7170,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3179 +#: documentation/content/en/articles/committers-guide/_index.adoc:3196 msgid "" "Respect all code freezes and read the `committers` and `developers` mailing " "list on a timely basis so you know when a code freeze is in effect." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3182 +#: documentation/content/en/articles/committers-guide/_index.adoc:3199 msgid "" "Committing unapproved changes during a code freeze is a really big mistake " "and committers are expected to keep up-to-date on what is going on before " @@ -6778,7 +7188,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3187 +#: documentation/content/en/articles/committers-guide/_index.adoc:3204 msgid "" "Many mistakes are made because someone is in a hurry and just assumes they " "know the right way of doing something. If you have not done it before, " @@ -6790,7 +7200,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3197 +#: documentation/content/en/articles/committers-guide/_index.adoc:3214 msgid "" "If your changes are to the kernel, make sure you can still compile both " "GENERIC and LINT. If your changes are anywhere else, make sure you can " @@ -6806,14 +7216,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3200 +#: documentation/content/en/articles/committers-guide/_index.adoc:3217 msgid "" "Contributed software is anything under the [.filename]#src/contrib#, " "[.filename]#src/crypto#, or [.filename]#src/sys/contrib# trees." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3205 +#: documentation/content/en/articles/committers-guide/_index.adoc:3222 msgid "" "The trees mentioned above are for contributed software usually imported onto " "a vendor branch. Committing something there may cause unnecessary headaches " @@ -6823,7 +7233,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3209 +#: documentation/content/en/articles/committers-guide/_index.adoc:3226 msgid "" "Reasons for modifying upstream software range from wanting strict control " "over a tightly coupled dependency to lack of portability in the canonical " @@ -6835,7 +7245,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3212 +#: documentation/content/en/articles/committers-guide/_index.adoc:3229 msgid "" "If a particular piece of software lacks a maintainer, you are encouraged to " "take up ownership. If you are unsure of the current maintainership email " @@ -6843,27 +7253,27 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3213 +#: documentation/content/en/articles/committers-guide/_index.adoc:3230 #, no-wrap msgid "Policy on Multiple Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3216 +#: documentation/content/en/articles/committers-guide/_index.adoc:3233 msgid "" "In an effort to make it easier to keep FreeBSD portable across the platforms " "we support, core has developed this mandate:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3219 +#: documentation/content/en/articles/committers-guide/_index.adoc:3236 msgid "" "Major design work (including major API and ABI changes) must prove itself on " "at least one Tier 1 platform before it may be committed to the source tree." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3223 +#: documentation/content/en/articles/committers-guide/_index.adoc:3240 msgid "" "Developers should also be aware of our Tier Policy for the long term support " "of hardware architectures. The rules here are intended to provide guidance " @@ -6874,13 +7284,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3225 +#: documentation/content/en/articles/committers-guide/_index.adoc:3242 #, no-wrap msgid "Policy on Multiple Compilers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3239 +#: documentation/content/en/articles/committers-guide/_index.adoc:3256 msgid "" "The FreeBSD base system builds with both Clang and GCC. The project does " "this in a careful and controlled way to maximize benefits from this extra " @@ -6907,7 +7317,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3244 +#: documentation/content/en/articles/committers-guide/_index.adoc:3261 msgid "" "The FreeBSD base system includes an in-tree Clang compiler. Due to being in " "the tree, this compiler is the most supported compiler. All changes must " @@ -6916,7 +7326,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3259 +#: documentation/content/en/articles/committers-guide/_index.adoc:3276 msgid "" "The FreeBSD base system also supports various versions of Clang and GCC as " "out-of-tree compilers. For large or risky changes, committers should do a " @@ -6937,7 +7347,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3263 +#: documentation/content/en/articles/committers-guide/_index.adoc:3280 msgid "" "The FreeBSD project also has some CI pipelines on github. For pull requests " "on github and some branches pushed to github forks, a number of cross " @@ -6946,7 +7356,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3269 +#: documentation/content/en/articles/committers-guide/_index.adoc:3286 msgid "" "The FreeBSD project is also upgrading compilers. Both Clang and GCC are " "fast moving targets. Some work to change things in the tree, for example " @@ -6959,7 +7369,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3273 +#: documentation/content/en/articles/committers-guide/_index.adoc:3290 msgid "" "In addition to the compiler, LLVM's LLD and GNU's binutils are used " "indirectly by the compiler. Committers should be mindful of variations in " @@ -6969,7 +7379,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3279 +#: documentation/content/en/articles/committers-guide/_index.adoc:3296 msgid "" "The FreeBSD project provides headers and libraries that allow other " "compilers to be used to build software not in the base system. These " @@ -6984,7 +7394,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3284 +#: documentation/content/en/articles/committers-guide/_index.adoc:3301 msgid "" "The FreeBSD build system currently accommodates these different " "environments. As new warnings are added to compilers, the project tries to " @@ -6996,13 +7406,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3285 +#: documentation/content/en/articles/committers-guide/_index.adoc:3302 #, no-wrap msgid "Current Compiler Versions" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3288 +#: documentation/content/en/articles/committers-guide/_index.adoc:3305 msgid "" "The versions of supported compilers for a given branch such as `main` or " "`stable/X` varies over time. The authoritative source for supported " @@ -7010,30 +7420,139 @@ msgid "" "actions and Jenkins." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3292 +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3309 +#, no-wrap +msgid "Branch" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3310 +#, no-wrap +msgid "In-tree Compiler" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3310 +#, no-wrap +msgid "llvm12" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3310 +#, no-wrap +msgid "llvm13" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3310 +#, no-wrap +msgid "llvm14" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3310 +#, no-wrap +msgid "llvm15" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3311 +#, no-wrap +msgid "llvm18" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3311 +#, no-wrap +msgid "amd64-gcc12" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3311 +#, no-wrap +msgid "amd64-gcc13" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3313 +#, no-wrap +msgid "amd64-gcc14" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3313 +#, no-wrap +msgid "main" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3314 +#: documentation/content/en/articles/committers-guide/_index.adoc:3318 +#: documentation/content/en/articles/committers-guide/_index.adoc:3322 +#: documentation/content/en/articles/committers-guide/_index.adoc:3326 +#, no-wrap +msgid "llvm 19" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3314 +#: documentation/content/en/articles/committers-guide/_index.adoc:3315 +#: documentation/content/en/articles/committers-guide/_index.adoc:3317 +#: documentation/content/en/articles/committers-guide/_index.adoc:3318 +#: documentation/content/en/articles/committers-guide/_index.adoc:3319 +#: documentation/content/en/articles/committers-guide/_index.adoc:3321 +#: documentation/content/en/articles/committers-guide/_index.adoc:3322 +#: documentation/content/en/articles/committers-guide/_index.adoc:3323 +#: documentation/content/en/articles/committers-guide/_index.adoc:3325 +#: documentation/content/en/articles/committers-guide/_index.adoc:3326 +#: documentation/content/en/articles/committers-guide/_index.adoc:3327 +#: documentation/content/en/articles/committers-guide/_index.adoc:3328 +#, no-wrap +msgid "Y" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3317 +#, no-wrap +msgid "stable/15" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3321 +#, no-wrap +msgid "stable/14" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:3325 +#, no-wrap +msgid "stable/13" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3332 msgid "" -"For `main`, the in-tree compiler is currently Clang 19. Currently, GCC 12, " -"13, and 14 are tested for amd64 via CI jobs in Jenkins. Clang 14 and 18 are " -"tested for aarch64 and arm64 in GitHub's cross-build actions." +"GCC toolchains are tested for amd64 via CI jobs in Jenkins. LLVM toolchains " +"are tested for aarch64 and arm64 in GitHub's cross-build actions." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3293 +#: documentation/content/en/articles/committers-guide/_index.adoc:3333 #, no-wrap msgid "Other Suggestions" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3297 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3337 msgid "" "When committing documentation changes, use a spell checker before " "committing. For all XML docs, verify that the formatting directives are " "correct by running `make lint` and package:textproc/igor[]." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3299 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3339 msgid "" "For manual pages, run package:sysutils/manck[] and package:textproc/igor[] " "over the manual page to verify all of the cross references and file " @@ -7041,8 +7560,8 @@ msgid "" "`MLINKS` installed." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3306 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3346 msgid "" "Do not mix style fixes with new functionality. A style fix is any change " "which does not modify the functionality of the code. Mixing the changes " @@ -7055,35 +7574,35 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3307 +#: documentation/content/en/articles/committers-guide/_index.adoc:3347 #, no-wrap msgid "Deprecating Features" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3310 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3350 msgid "" "When it is necessary to remove functionality from software in the base " "system, follow these guidelines whenever possible:" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3312 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3352 msgid "" "Mention is made in the manual page and possibly the release notes that the " "option, utility, or interface is deprecated. Use of the deprecated feature " "generates a warning." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3313 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3353 msgid "" "The option, utility, or interface is preserved until the next major (point " "zero) release." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3314 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3354 msgid "" "The option, utility, or interface is removed and no longer documented. It is " "now obsolete. It is also generally a good idea to note its removal in the " @@ -7091,31 +7610,31 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3315 +#: documentation/content/en/articles/committers-guide/_index.adoc:3355 #, no-wrap msgid "Privacy and Confidentiality" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3318 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3358 msgid "Most FreeBSD business is done in public." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3321 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3361 msgid "" "FreeBSD is an _open_ project. Which means that not only can anyone use the " "source code, but that most of the development process is open to public " "scrutiny." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3322 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3362 msgid "Certain sensitive matters must remain private or held under embargo." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3328 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3368 msgid "" "There unfortunately cannot be complete transparency. As a FreeBSD developer " "you will have a certain degree of privileged access to information. " @@ -7125,15 +7644,15 @@ msgid "" "of not releasing private communications." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3329 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3369 msgid "" "The Security Officer has sole control over the release of security " "advisories." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3334 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3374 msgid "" "Where there are security problems that affect many different operating " "systems, FreeBSD frequently depends on early access to be able to prepare " @@ -7145,14 +7664,14 @@ msgid "" "developer with relevant knowledge to prepare security fixes." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3335 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3375 msgid "" "Communications with Core are kept confidential for as long as necessary." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3340 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3380 msgid "" "Communications to core will initially be treated as confidential. " "Eventually however, most of Core's business will be summarized into the " @@ -7162,28 +7681,28 @@ msgid "" "archives." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3341 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3381 msgid "" "Non-disclosure Agreements may be required for access to certain commercially " "sensitive data." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3344 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3384 msgid "" "Access to certain commercially sensitive data may only be available under a " "Non-Disclosure Agreement. The FreeBSD Foundation legal staff must be " "consulted before any binding agreements are entered into." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3345 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3385 msgid "Private communications must not be made public without permission." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3348 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3388 msgid "" "Beyond the specific requirements above there is a general expectation not to " "publish private communications between developers without the consent of all " @@ -7192,15 +7711,15 @@ msgid "" "other than the original correspondents." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3349 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3389 msgid "" "Communications on project-only or restricted access channels must be kept " "private." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3352 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3392 msgid "" "Similarly to personal communications, certain internal communications " "channels, including FreeBSD Committer only mailing lists and restricted " @@ -7208,13 +7727,13 @@ msgid "" "required to publish material from these sources." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3353 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3393 msgid "Core may approve publication." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3355 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3395 msgid "" "Where it is impractical to obtain permission due to the number of " "correspondents or where permission to publish is unreasonably withheld, Core " @@ -7223,13 +7742,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3357 +#: documentation/content/en/articles/committers-guide/_index.adoc:3397 #, no-wrap msgid "Support for Multiple Architectures" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3364 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3404 msgid "" "FreeBSD is a highly portable operating system intended to function on many " "different types of hardware architectures. Maintaining clean separation of " @@ -7245,13 +7764,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3365 +#: documentation/content/en/articles/committers-guide/_index.adoc:3405 #, no-wrap msgid "Statement of General Intent" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3370 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3410 msgid "" "The FreeBSD Project targets \"production quality commercial off-the-shelf " "(COTS) workstation, server, and high-end embedded systems\". By retaining a " @@ -7266,8 +7785,8 @@ msgid "" "support." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3377 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3417 msgid "" "The FreeBSD Project differentiates platform targets into four tiers. Each " "tier includes a list of guarantees consumers may rely on as well as " @@ -7281,13 +7800,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3378 +#: documentation/content/en/articles/committers-guide/_index.adoc:3418 #, no-wrap msgid "Platform Targets" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3385 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3425 msgid "" "Support for a hardware platform consists of two components: kernel support " "and userland Application Binary Interfaces (ABIs). Kernel platform support " @@ -7301,8 +7820,8 @@ msgid "" "objects or calling conventions for C functions." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3387 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3427 msgid "" "A FreeBSD kernel also uses an ABI (sometimes referred to as the Kernel " "Binary Interface (KBI)) which includes the semantics and layouts of public " @@ -7310,8 +7829,8 @@ msgid "" "functions within the kernel itself." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3392 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3432 msgid "" "A FreeBSD kernel may support multiple userland ABIs. For example, FreeBSD's " "amd64 kernel supports FreeBSD amd64 and i386 userland ABIs as well as Linux " @@ -7321,21 +7840,21 @@ msgid "" "basic types, etc." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3394 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3434 msgid "" "Tiers are defined for both kernels and userland ABIs. In the common case, a " "platform's kernel and FreeBSD ABIs are assigned to the same tier." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3395 +#: documentation/content/en/articles/committers-guide/_index.adoc:3435 #, no-wrap msgid "Tier 1: Fully-Supported Architectures" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3400 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3440 msgid "" "Tier 1 platforms are the most mature FreeBSD platforms. They are supported " "by the security officer, release engineering, and Ports Management Team. " @@ -7344,43 +7863,43 @@ msgid "" "development environments." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3402 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3442 msgid "" "The FreeBSD Project provides the following guarantees to consumers of Tier 1 " "platforms:" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3404 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3444 msgid "" "Official FreeBSD release images will be provided by the release engineering " "team." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3405 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3445 msgid "" "Binary updates and source patches for Security Advisories and Errata Notices " "will be provided for supported releases." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3406 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3446 msgid "" "Source patches for Security Advisories will be provided for supported " "branches." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3407 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3447 msgid "" "Binary updates and source patches for cross-platform Security Advisories " "will typically be provided at the time of the announcement." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3408 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3448 msgid "" "Changes to userland ABIs will generally include compatibility shims to " "ensure correct operation of binaries compiled against any stable branch " @@ -7389,8 +7908,8 @@ msgid "" "the lack of shims will be clearly documented in the release notes." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3409 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3449 msgid "" "Changes to certain portions of the kernel ABI will include compatibility " "shims to ensure correct operation of kernel modules compiled against the " @@ -7398,65 +7917,65 @@ msgid "" "kernel ABI are protected." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3410 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3450 msgid "" "Official binary packages for third party software will be provided by the " "ports team. For embedded architectures, these packages may be cross-built " "from a different architecture." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3411 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3451 msgid "" "Most relevant ports should either build or have the appropriate filters to " "prevent inappropriate ones from building." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3412 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3452 msgid "" "New features which are not inherently platform-specific will be fully " "functional on all Tier 1 architectures." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3413 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3453 msgid "" "Features and compatibility shims used by binaries compiled against older " "stable branches may be removed in newer major versions. Such removals will " "be clearly documented in the release notes." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3414 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3454 msgid "" "Tier 1 platforms should be fully documented. Basic operations will be " "documented in the FreeBSD Handbook." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3415 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3455 msgid "Tier 1 platforms will be included in the source tree." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3416 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3456 msgid "" "Tier 1 platforms should be self-hosting either via the in-tree toolchain or " "an external toolchain. If an external toolchain is required, official binary " "packages for an external toolchain will be provided." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3418 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3458 msgid "" "To maintain maturity of Tier 1 platforms, the FreeBSD Project will maintain " "the following resources to support development:" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3420 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3460 msgid "" "Build and test automation support either in the FreeBSD.org cluster or some " "other location easily available for all developers. Embedded platforms may " @@ -7464,42 +7983,42 @@ msgid "" "hardware." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3421 -#: documentation/content/en/articles/committers-guide/_index.adoc:3451 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3461 +#: documentation/content/en/articles/committers-guide/_index.adoc:3491 msgid "Inclusion in the `make universe` and `make tinderbox` targets." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3422 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3462 msgid "" "Dedicated hardware in one of the FreeBSD clusters for package building " "(either natively or via qemu-user)." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3424 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3464 msgid "" "Collectively, developers are required to provide the following to maintain " "the Tier 1 status of a platform:" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3426 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3466 msgid "" "Changes to the source tree should not knowingly break the build of a Tier 1 " "platform." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3427 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3467 msgid "" "Tier 1 architectures must have a mature, healthy ecosystem of users and " "active developers." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3428 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3468 msgid "" "Developers should be able to build packages on commonly available, non-" "embedded Tier 1 systems. This can mean either native builds if non-embedded " @@ -7507,16 +8026,16 @@ msgid "" "cross-builds hosted on some other Tier 1 architecture." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3429 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3469 msgid "" "Changes cannot break the userland ABI. If an ABI change is required, ABI " "compatibility for existing binaries should be provided via use of symbol " "versioning or shared library version bumps." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3430 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3470 msgid "" "Changes merged to stable branches cannot break the protected portions of the " "kernel ABI. If a kernel ABI change is required, the change should be " @@ -7524,21 +8043,21 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3431 +#: documentation/content/en/articles/committers-guide/_index.adoc:3471 #, no-wrap msgid "Tier 2: Developmental and Niche Architectures" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3435 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3475 msgid "" "Tier 2 platforms are functional, but less mature FreeBSD platforms. They " "are not supported by the security officer, release engineering, and Ports " "Management Team." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3439 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3479 msgid "" "Tier 2 platforms may be Tier 1 platform candidates that are still under " "active development. Architectures reaching end of life may also be moved " @@ -7547,15 +8066,15 @@ msgid "" "Well-supported niche architectures may also be Tier 2." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3441 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3481 msgid "" "The FreeBSD Project provides the following guarantees to consumers of Tier 2 " "platforms:" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3443 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3483 msgid "" "The ports infrastructure should include basic support for Tier 2 " "architectures sufficient to support building ports and packages. This " @@ -7563,91 +8082,91 @@ msgid "" "guarantee that arbitrary ports will be buildable or functional." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3444 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3484 msgid "" "New features which are not inherently platform-specific should be feasible " "on all Tier 2 architectures if not implemented." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3445 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3485 msgid "Tier 2 platforms will be included in the source tree." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3446 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3486 msgid "" "Tier 2 platforms should be self-hosting either via the in-tree toolchain or " "an external toolchain. If an external toolchain is required, official binary " "packages for an external toolchain will be provided." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3447 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3487 msgid "" "Tier 2 platforms should provide functional kernels and userlands even if an " "official release distribution is not provided." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3449 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3489 msgid "" "To maintain maturity of Tier 2 platforms, the FreeBSD Project will maintain " "the following resources to support development:" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3453 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3493 msgid "" "Collectively, developers are required to provide the following to maintain " "the Tier 2 status of a platform:" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3455 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3495 msgid "" "Changes to the source tree should not knowingly break the build of a Tier 2 " "platform." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3456 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3496 msgid "" "Tier 2 architectures must have an active ecosystem of users and developers." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3457 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3497 msgid "" "While changes are permitted to break the userland ABI, the ABI should not be " "broken gratuitously. Significant userland ABI changes should be restricted " "to major versions." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3458 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3498 msgid "" "New features that are not yet implemented on Tier 2 architectures should " "provide a means of disabling them on those architectures." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3459 +#: documentation/content/en/articles/committers-guide/_index.adoc:3499 #, no-wrap msgid "Tier 3: Experimental Architectures" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3463 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3503 msgid "" "Tier 3 platforms have at least partial FreeBSD support. They are _not_ " "supported by the security officer, release engineering, and Ports Management " "Team." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3466 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3506 msgid "" "Tier 3 platforms are architectures in the early stages of development, for " "non-mainstream hardware platforms, or which are considered legacy systems " @@ -7655,8 +8174,8 @@ msgid "" "exist in a separate repository rather than the main source repository." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3469 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3509 msgid "" "The FreeBSD Project provides no guarantees to consumers of Tier 3 platforms " "and is not committed to maintaining resources to support development. Tier " @@ -7665,20 +8184,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3470 +#: documentation/content/en/articles/committers-guide/_index.adoc:3510 #, no-wrap msgid "Unsupported Architectures" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3474 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3514 msgid "" "Other platforms are not supported in any form by the project. The project " "previously described these as Tier 4 systems." msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3477 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3517 msgid "" "After a platform transitions to unsupported, all support for the platform is " "removed from the source, ports and documentation trees. Note that ports " @@ -7687,13 +8206,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3478 +#: documentation/content/en/articles/committers-guide/_index.adoc:3518 #, no-wrap msgid "Policy on Changing the Tier of an Architecture" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3482 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3522 msgid "" "Systems may only be moved from one tier to another by approval of the " "FreeBSD Core Team, which shall make that decision in collaboration with the " @@ -7703,25 +8222,25 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3484 +#: documentation/content/en/articles/committers-guide/_index.adoc:3524 #, no-wrap msgid "Ports Specific FAQ" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3487 +#: documentation/content/en/articles/committers-guide/_index.adoc:3527 #, no-wrap msgid "Adding a New Port" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3490 +#: documentation/content/en/articles/committers-guide/_index.adoc:3530 #, no-wrap msgid "How do I add a new port?" msgstr "" -#. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3495 +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3535 msgid "" "Adding a port to the tree is relatively simple. Once the port is ready to be " "added, as explained later crossref:committers-guide[ports-qa-add-new-" @@ -7731,20 +8250,20 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3499 +#: documentation/content/en/articles/committers-guide/_index.adoc:3539 #, no-wrap msgid "\tSUBDIR += newport\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3502 +#: documentation/content/en/articles/committers-guide/_index.adoc:3542 msgid "" "Once the port and its category's Makefile are ready, the new port can be " "committed:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3507 +#: documentation/content/en/articles/committers-guide/_index.adoc:3547 #, no-wrap msgid "" "% git add category/Makefile category/newport\n" @@ -7753,7 +8272,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3511 +#: documentation/content/en/articles/committers-guide/_index.adoc:3551 msgid "" "Don't forget to crossref:committers-guide[port-commit-message-formats,setup " "git hooks for the ports tree as explained here]; a specific hook has been " @@ -7761,19 +8280,19 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3514 +#: documentation/content/en/articles/committers-guide/_index.adoc:3554 #, no-wrap msgid "Any other things I need to know when I add a new port?" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3517 +#: documentation/content/en/articles/committers-guide/_index.adoc:3557 msgid "" "Check the port, preferably to make sure it compiles and packages correctly." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3520 +#: documentation/content/en/articles/committers-guide/_index.adoc:3560 msgid "" "The extref:{porters-handbook}testing[Porters Handbook's Testing Chapter] " "contains more detailed instructions. See the extref:{porters-handbook}" @@ -7782,14 +8301,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3522 +#: documentation/content/en/articles/committers-guide/_index.adoc:3562 msgid "" "You do not necessarily have to eliminate all warnings but make sure you have " "fixed the simple ones." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3524 +#: documentation/content/en/articles/committers-guide/_index.adoc:3564 msgid "" "If the port came from a submitter who has not contributed to the Project " "before, add that person's name to the extref:{contributors}[Additional " @@ -7797,14 +8316,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3527 +#: documentation/content/en/articles/committers-guide/_index.adoc:3567 msgid "" "Close the PR if the port came in as a PR. To close a PR, change the state " "to `Issue Resolved` and the resolution as `Fixed`." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3531 +#: documentation/content/en/articles/committers-guide/_index.adoc:3571 msgid "" "If for some reason using extref:{porters-handbook}testing[poudriere, testing-" "poudriere] to test the new port is not possible, the bare minimum of testing " @@ -7812,7 +8331,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3541 +#: documentation/content/en/articles/committers-guide/_index.adoc:3581 #, no-wrap msgid "" "# make install\n" @@ -7825,85 +8344,85 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3544 +#: documentation/content/en/articles/committers-guide/_index.adoc:3584 msgid "" "Note that poudriere is the reference for package building, it the port does " "not build in poudriere, it will be removed." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3547 +#: documentation/content/en/articles/committers-guide/_index.adoc:3587 #, no-wrap msgid "Removing an Existing Port" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3550 +#: documentation/content/en/articles/committers-guide/_index.adoc:3590 #, no-wrap msgid "How do I remove an existing port?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3553 +#: documentation/content/en/articles/committers-guide/_index.adoc:3593 msgid "" "First, please read the section about repository copies. Before you remove " "the port, you have to verify there are no other ports depending on it." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3555 +#: documentation/content/en/articles/committers-guide/_index.adoc:3595 msgid "Make sure there is no dependency on the port in the ports collection:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3556 +#: documentation/content/en/articles/committers-guide/_index.adoc:3596 msgid "The port's PKGNAME appears in exactly one line in a recent INDEX file." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3557 +#: documentation/content/en/articles/committers-guide/_index.adoc:3597 msgid "" "No other ports contains any reference to the port's directory or PKGNAME in " "their Makefiles" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3561 +#: documentation/content/en/articles/committers-guide/_index.adoc:3601 msgid "" "When using Git, consider using man:git-grep[1], it is much faster than `grep " "-r`." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3564 +#: documentation/content/en/articles/committers-guide/_index.adoc:3604 msgid "Then, remove the port:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3568 +#: documentation/content/en/articles/committers-guide/_index.adoc:3608 msgid "Remove the port's files and directory with `git rm`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3569 +#: documentation/content/en/articles/committers-guide/_index.adoc:3609 msgid "" "Remove the `SUBDIR` listing of the port in the parent directory " "[.filename]#Makefile#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3570 -#: documentation/content/en/articles/committers-guide/_index.adoc:3585 +#: documentation/content/en/articles/committers-guide/_index.adoc:3610 +#: documentation/content/en/articles/committers-guide/_index.adoc:3625 msgid "Add an entry to [.filename]#ports/MOVED#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3571 +#: documentation/content/en/articles/committers-guide/_index.adoc:3611 msgid "Remove the port from [.filename]#ports/LEGAL# if it is there." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3576 +#: documentation/content/en/articles/committers-guide/_index.adoc:3616 msgid "" "Alternatively, you can use the rmport script, from [.filename]#ports/Tools/" "scripts#. This script was written by {vd}. When sending questions about " @@ -7912,13 +8431,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3578 +#: documentation/content/en/articles/committers-guide/_index.adoc:3618 #, no-wrap msgid "How do I move a port to a new location?" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3583 +#: documentation/content/en/articles/committers-guide/_index.adoc:3623 msgid "" "Perform a thorough check of the ports collection for any dependencies on the " "old port location/name, and update them. Running `grep` on " @@ -7928,14 +8447,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3584 +#: documentation/content/en/articles/committers-guide/_index.adoc:3624 msgid "" "Remove the `SUBDIR` entry from the old category Makefile and add a `SUBDIR` " "entry to the new category Makefile." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3586 +#: documentation/content/en/articles/committers-guide/_index.adoc:3626 msgid "" "Search for entries in xml files inside [.filename]#ports/security/vuxml# and " "adjust them accordingly. In particular, check for previous packages with the " @@ -7943,51 +8462,51 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3587 +#: documentation/content/en/articles/committers-guide/_index.adoc:3627 msgid "Move the port with `git mv`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3588 -#: documentation/content/en/articles/committers-guide/_index.adoc:3599 +#: documentation/content/en/articles/committers-guide/_index.adoc:3628 +#: documentation/content/en/articles/committers-guide/_index.adoc:3639 msgid "Commit the changes." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3591 +#: documentation/content/en/articles/committers-guide/_index.adoc:3631 #, no-wrap msgid "How do I copy a port to a new location?" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3596 +#: documentation/content/en/articles/committers-guide/_index.adoc:3636 msgid "Copy port with `cp -R old-cat/old-port new-cat/new-port`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3597 +#: documentation/content/en/articles/committers-guide/_index.adoc:3637 msgid "Add the new port to the [.filename]#new-cat/Makefile#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3598 +#: documentation/content/en/articles/committers-guide/_index.adoc:3638 msgid "Change stuff in [.filename]#new-cat/new-port#." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3602 +#: documentation/content/en/articles/committers-guide/_index.adoc:3642 #, no-wrap msgid "Ports Freeze" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3605 +#: documentation/content/en/articles/committers-guide/_index.adoc:3645 #, no-wrap msgid "What is a “ports freeze”?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3612 +#: documentation/content/en/articles/committers-guide/_index.adoc:3652 msgid "" "A “ports freeze” was a restricted state the ports tree was put in before a " "release. It was used to ensure a higher quality for the packages shipped " @@ -7998,7 +8517,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3615 +#: documentation/content/en/articles/committers-guide/_index.adoc:3655 msgid "" "For more information on how to merge commits to the quarterly branch, see " "crossref:committers-guide[ports-qa-misc-request-mfh, What is the procedure " @@ -8006,32 +8525,32 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3617 +#: documentation/content/en/articles/committers-guide/_index.adoc:3657 #, no-wrap msgid "Quarterly Branches" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3620 +#: documentation/content/en/articles/committers-guide/_index.adoc:3660 #, no-wrap msgid "What is the procedure to request authorization for merging a commit to the quarterly branch?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3623 +#: documentation/content/en/articles/committers-guide/_index.adoc:3663 msgid "" "As of November 30, 2020, there is no need to seek explicit approval to " "commit to the quarterly branch." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3625 +#: documentation/content/en/articles/committers-guide/_index.adoc:3665 #, no-wrap msgid "What is the procedure for merging commits to the quarterly branch?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3628 +#: documentation/content/en/articles/committers-guide/_index.adoc:3668 msgid "" "Merging commits to the quarterly branch (a process we call MFH for a " "historical reason) is very similar to MFC'ing a commit in the src " @@ -8039,7 +8558,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3634 +#: documentation/content/en/articles/committers-guide/_index.adoc:3674 #, no-wrap msgid "" "% git checkout 2021Q2\n" @@ -8049,7 +8568,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3638 +#: documentation/content/en/articles/committers-guide/_index.adoc:3678 msgid "" "where `$HASH` is the hash of the commit you want to copy over to the " "quarterly branch. The `-x` parameter ensures the hash `$HASH` of the `main` " @@ -8057,63 +8576,64 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3640 +#: documentation/content/en/articles/committers-guide/_index.adoc:3680 #, no-wrap msgid "Creating a New Category" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3643 +#: documentation/content/en/articles/committers-guide/_index.adoc:3683 #, no-wrap msgid "What is the procedure for creating a new category?" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3648 +#: documentation/content/en/articles/committers-guide/_index.adoc:3688 msgid "" -"Please see extref:{porters-handbook}[Proposing a New Category, proposing-" -"categories] in the Porter's Handbook. Once that procedure has been followed " -"and the PR has been assigned to the {portmgr}, it is their decision whether " -"or not to approve it. If they do, it is their responsibility to:" +"Please see extref:{porters-handbook}makefiles[Proposing a New Category, " +"proposing-categories] in the Porter's Handbook. Once that procedure has " +"been followed and the PR has been assigned to the {portmgr}, it is their " +"decision whether or not to approve it. If they do, it is their " +"responsibility to:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3652 +#: documentation/content/en/articles/committers-guide/_index.adoc:3692 msgid "Perform any needed moves. (This only applies to physical categories.)" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3653 +#: documentation/content/en/articles/committers-guide/_index.adoc:3693 msgid "" "Update the `VALID_CATEGORIES` definition in [.filename]#ports/Mk/" "bsd.port.mk#." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3654 +#: documentation/content/en/articles/committers-guide/_index.adoc:3694 msgid "Assign the PR back to you." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3657 +#: documentation/content/en/articles/committers-guide/_index.adoc:3697 #, no-wrap msgid "What do I need to do to implement a new physical category?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3662 +#: documentation/content/en/articles/committers-guide/_index.adoc:3702 msgid "" "Upgrade each moved port's [.filename]#Makefile#. Do not connect the new " "category to the build yet." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3664 +#: documentation/content/en/articles/committers-guide/_index.adoc:3704 msgid "To do this, you will need to:" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3668 +#: documentation/content/en/articles/committers-guide/_index.adoc:3708 msgid "" "Change the port's `CATEGORIES` (this was the point of the exercise, " "remember?) The new category is listed first. This will help to ensure that " @@ -8121,7 +8641,7 @@ msgid "" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3669 +#: documentation/content/en/articles/committers-guide/_index.adoc:3709 msgid "" "Run a `make describe`. Since the top-level `make index` that you will be " "running in a few steps is an iteration of `make describe` over the entire " @@ -8130,14 +8650,14 @@ msgid "" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3670 +#: documentation/content/en/articles/committers-guide/_index.adoc:3710 msgid "" "If you want to be really thorough, now might be a good time to run " "man:portlint[1]." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3673 +#: documentation/content/en/articles/committers-guide/_index.adoc:3713 msgid "" "Check that the ``PKGORIGIN``s are correct. The ports system uses each port's " "`CATEGORIES` entry to create its `PKGORIGIN`, which is used to connect " @@ -8147,7 +8667,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3675 +#: documentation/content/en/articles/committers-guide/_index.adoc:3715 msgid "" "To do this, use the [.filename]#chkorigin.sh# tool: `env PORTSDIR=/path/to/" "ports sh -e /path/to/ports/Tools/scripts/chkorigin.sh`. This will check " @@ -8157,7 +8677,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3676 +#: documentation/content/en/articles/committers-guide/_index.adoc:3716 msgid "" "On your own local system, test the proposed changes: first, comment out the " "SUBDIR entries in the old ports' categories' [.filename]##Makefile##s; then " @@ -8169,7 +8689,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3677 +#: documentation/content/en/articles/committers-guide/_index.adoc:3717 msgid "" "Once this is done, you can commit the updated [.filename]#ports/Makefile# to " "connect the new category to the build and also commit the " @@ -8177,25 +8697,25 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3678 +#: documentation/content/en/articles/committers-guide/_index.adoc:3718 msgid "Add appropriate entries to [.filename]#ports/MOVED#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3679 +#: documentation/content/en/articles/committers-guide/_index.adoc:3719 msgid "Update the documentation by modifying:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3680 -#: documentation/content/en/articles/committers-guide/_index.adoc:3689 +#: documentation/content/en/articles/committers-guide/_index.adoc:3720 +#: documentation/content/en/articles/committers-guide/_index.adoc:3729 msgid "" -"the extref:{porters-handbook}[list of categories, PORTING-CATEGORIES] in the " -"Porter's Handbook" +"the extref:{porters-handbook}makefiles[list of categories, porting-" +"categories] in the Porter's Handbook" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3682 +#: documentation/content/en/articles/committers-guide/_index.adoc:3722 msgid "" "Only once all the above have been done, and no one is any longer reporting " "problems with the new ports, should the old ports be deleted from their " @@ -8203,38 +8723,38 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3684 +#: documentation/content/en/articles/committers-guide/_index.adoc:3724 #, no-wrap msgid "What do I need to do to implement a new virtual category?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3687 +#: documentation/content/en/articles/committers-guide/_index.adoc:3727 msgid "" "This is much simpler than a physical category. Only a few modifications are " "needed:" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3691 -#: documentation/content/en/articles/committers-guide/_index.adoc:3785 +#: documentation/content/en/articles/committers-guide/_index.adoc:3731 +#: documentation/content/en/articles/committers-guide/_index.adoc:3825 #, no-wrap msgid "Miscellaneous Questions" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3694 +#: documentation/content/en/articles/committers-guide/_index.adoc:3734 #, no-wrap msgid "Are there changes that can be committed without asking the maintainer for approval?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3697 +#: documentation/content/en/articles/committers-guide/_index.adoc:3737 msgid "Blanket approval for most ports applies to these types of fixes:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3699 +#: documentation/content/en/articles/committers-guide/_index.adoc:3739 msgid "" "Most infrastructure changes to a port (that is, modernizing, but not " "changing the functionality). For example, the blanket covers converting to " @@ -8243,19 +8763,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3700 +#: documentation/content/en/articles/committers-guide/_index.adoc:3740 msgid "Trivial and _tested_ build and runtime fixes." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3701 +#: documentation/content/en/articles/committers-guide/_index.adoc:3741 msgid "" "Documentations or metadata changes to ports, like [.filename]#pkg-descr# or " "`COMMENT`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3706 +#: documentation/content/en/articles/committers-guide/_index.adoc:3746 msgid "" "Exceptions to this are anything maintained by the {portmgr}, or the " "{security-officer}. No unauthorized commits may ever be made to ports " @@ -8263,47 +8783,47 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3709 +#: documentation/content/en/articles/committers-guide/_index.adoc:3749 #, no-wrap msgid "How do I know if my port is building correctly or not?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3713 +#: documentation/content/en/articles/committers-guide/_index.adoc:3753 msgid "" "The packages are built multiple times each week. If a port fails, the " "maintainer will receive an email from `pkg-fallout@FreeBSD.org`." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3715 +#: documentation/content/en/articles/committers-guide/_index.adoc:3755 msgid "" "Reports for all the package builds (official, experimental, and non-" -"regression) are aggregated at link:pkg-status.FreeBSD.org[pkg-" +"regression) are aggregated at link:https://pkg-status.FreeBSD.org[pkg-" "status.FreeBSD.org]." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3717 +#: documentation/content/en/articles/committers-guide/_index.adoc:3757 #, no-wrap msgid "I added a new port. Do I need to add it to the [.filename]#INDEX#?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3720 +#: documentation/content/en/articles/committers-guide/_index.adoc:3760 msgid "" "No. The file can either be generated by running `make index`, or a pre-" "generated version can be downloaded with `make fetchindex`." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3722 +#: documentation/content/en/articles/committers-guide/_index.adoc:3762 #, no-wrap msgid "Are there any other files I am not allowed to touch?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3726 +#: documentation/content/en/articles/committers-guide/_index.adoc:3766 msgid "" "Any file directly under [.filename]#ports/#, or any file under a " "subdirectory that starts with an uppercase letter ([.filename]#Mk/#, " @@ -8313,13 +8833,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3728 +#: documentation/content/en/articles/committers-guide/_index.adoc:3768 #, no-wrap msgid "What is the proper procedure for updating the checksum for a port distfile when the file changes without a version change?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3732 +#: documentation/content/en/articles/committers-guide/_index.adoc:3772 msgid "" "When the checksum for a distribution file is updated due to the author " "updating the file without changing the port revision, the commit message " @@ -8332,20 +8852,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3734 +#: documentation/content/en/articles/committers-guide/_index.adoc:3774 #, no-wrap msgid "How can an experimental test build of the ports tree (exp-run) be requested?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3738 +#: documentation/content/en/articles/committers-guide/_index.adoc:3778 msgid "" "An exp-run must be completed before patches with a significant ports impact " "are committed. The patch can be against the ports tree or the base system." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3740 +#: documentation/content/en/articles/committers-guide/_index.adoc:3780 msgid "" "Full package builds will be done with the patches provided by the submitter, " "and the submitter is required to fix detected problems _(fallout)_ before " @@ -8353,22 +8873,22 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3744 +#: documentation/content/en/articles/committers-guide/_index.adoc:3784 msgid "Go to the link:https://bugs.freebsd.org/submit[Bugzilla new PR page]." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3745 +#: documentation/content/en/articles/committers-guide/_index.adoc:3785 msgid "Select the product your patch is about." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3746 +#: documentation/content/en/articles/committers-guide/_index.adoc:3786 msgid "Fill in the bug report as normal. Remember to attach the patch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3747 +#: documentation/content/en/articles/committers-guide/_index.adoc:3787 msgid "" "If at the top it says “Show Advanced Fields” click on it. It will now say " "“Hide Advanced Fields”. Many new fields will be available. If it already " @@ -8376,56 +8896,56 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3748 +#: documentation/content/en/articles/committers-guide/_index.adoc:3788 msgid "" "In the “Flags” section, set the “exp-run” one to `?`. As for all other " "fields, hovering the mouse over any field shows more details." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3749 +#: documentation/content/en/articles/committers-guide/_index.adoc:3789 msgid "Submit. Wait for the build to run." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3750 +#: documentation/content/en/articles/committers-guide/_index.adoc:3790 msgid "{portmgr} will reply with a possible fallout." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3751 +#: documentation/content/en/articles/committers-guide/_index.adoc:3791 msgid "Depending on the fallout:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3752 +#: documentation/content/en/articles/committers-guide/_index.adoc:3792 msgid "" "If there is no fallout, the procedure stops here, and the change can be " "committed, pending any other approval required." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3753 +#: documentation/content/en/articles/committers-guide/_index.adoc:3793 msgid "" "If there is fallout, it _must_ be fixed, either by fixing the ports directly " "in the ports tree, or adding to the submitted patch." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3754 +#: documentation/content/en/articles/committers-guide/_index.adoc:3794 msgid "" "When this is done, go back to step 6 saying the fallout was fixed and wait " "for the exp-run to be run again. Repeat as long as there are broken ports." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3757 +#: documentation/content/en/articles/committers-guide/_index.adoc:3797 #, no-wrap msgid "Issues Specific to Developers Who Are Not Committers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3762 +#: documentation/content/en/articles/committers-guide/_index.adoc:3802 msgid "" "A few people who have access to the FreeBSD machines do not have commit " "bits. Almost all of this document will apply to these developers as well " @@ -8434,17 +8954,17 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3764 +#: documentation/content/en/articles/committers-guide/_index.adoc:3804 msgid "crossref:committers-guide[admin, Administrative Details]" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3765 +#: documentation/content/en/articles/committers-guide/_index.adoc:3805 msgid "crossref:committers-guide[conventions-everyone, For Everyone]" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3769 +#: documentation/content/en/articles/committers-guide/_index.adoc:3809 msgid "" "Get your mentor to add you to the \"Additional Contributors\" " "([.filename]#doc/shared/contrib-additional.adoc#), if you are not already " @@ -8452,48 +8972,48 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3771 +#: documentation/content/en/articles/committers-guide/_index.adoc:3811 msgid "crossref:committers-guide[developer.relations, Developer Relations]" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3772 +#: documentation/content/en/articles/committers-guide/_index.adoc:3812 msgid "crossref:committers-guide[ssh.guide, SSH Quick-Start Guide]" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3773 +#: documentation/content/en/articles/committers-guide/_index.adoc:3813 msgid "" "crossref:committers-guide[rules, The FreeBSD Committers' Big List of Rules]" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3775 +#: documentation/content/en/articles/committers-guide/_index.adoc:3815 #, no-wrap msgid "Information About Google Analytics" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3778 +#: documentation/content/en/articles/committers-guide/_index.adoc:3818 msgid "" "As of December 12, 2012, Google Analytics was enabled on the FreeBSD Project " "website to collect anonymized usage statistics regarding usage of the site." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3782 +#: documentation/content/en/articles/committers-guide/_index.adoc:3822 msgid "" "As of March 3, 2022, Google Analytics was removed from the FreeBSD Project." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3787 +#: documentation/content/en/articles/committers-guide/_index.adoc:3827 #, no-wrap msgid "How do I access people.FreeBSD.org to put up personal or project information?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3791 +#: documentation/content/en/articles/committers-guide/_index.adoc:3831 msgid "" "`people.FreeBSD.org` is the same as `freefall.FreeBSD.org`. Just create a " "[.filename]#public_html# directory. Anything you place in that directory " @@ -8502,45 +9022,45 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3792 +#: documentation/content/en/articles/committers-guide/_index.adoc:3832 #, no-wrap msgid "Where are the mailing list archives stored?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3795 +#: documentation/content/en/articles/committers-guide/_index.adoc:3835 msgid "" "The mailing lists are archived under [.filename]#/local/mail# on " "`freefall.FreeBSD.org`." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3796 +#: documentation/content/en/articles/committers-guide/_index.adoc:3836 #, no-wrap msgid "I would like to mentor a new committer. What process do I need to follow?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3799 +#: documentation/content/en/articles/committers-guide/_index.adoc:3839 msgid "" "See the https://www.freebsd.org/internal/new-account/[New Account Creation " "Procedure] document on the internal pages." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3801 +#: documentation/content/en/articles/committers-guide/_index.adoc:3841 #, no-wrap msgid "Benefits and Perks for FreeBSD Committers" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3804 +#: documentation/content/en/articles/committers-guide/_index.adoc:3844 #, no-wrap msgid "Recognition" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3808 +#: documentation/content/en/articles/committers-guide/_index.adoc:3848 msgid "" "Recognition as a competent software engineer is the longest lasting value. " "In addition, getting a chance to work with some of the best people that " @@ -8548,33 +9068,33 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3810 +#: documentation/content/en/articles/committers-guide/_index.adoc:3850 #, no-wrap msgid "FreeBSD Mall" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3813 +#: documentation/content/en/articles/committers-guide/_index.adoc:3853 msgid "" "FreeBSD committers can get a free 4-CD or DVD set at conferences from http://" "www.freebsdmall.com[FreeBSD Mall, Inc.]." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3815 +#: documentation/content/en/articles/committers-guide/_index.adoc:3855 #, no-wrap msgid "`Gandi.net`" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3818 +#: documentation/content/en/articles/committers-guide/_index.adoc:3858 msgid "" "https://gandi.net[Gandi] provides website hosting, cloud computing, domain " "registration, and X.509 certificate services." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3822 +#: documentation/content/en/articles/committers-guide/_index.adoc:3862 msgid "" "Gandi offers an E-rate discount to all FreeBSD developers. To streamline " "the process of getting the discount first set up a Gandi account, fill in " @@ -8584,20 +9104,20 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3824 +#: documentation/content/en/articles/committers-guide/_index.adoc:3864 #, no-wrap msgid "`rsync.net`" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3827 +#: documentation/content/en/articles/committers-guide/_index.adoc:3867 msgid "" "https://rsync.net[rsync.net] provides cloud storage for offsite backup that " "is optimized for UNIX users. Their service runs entirely on FreeBSD and ZFS." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3828 +#: documentation/content/en/articles/committers-guide/_index.adoc:3868 msgid "" "rsync.net offers a free-forever 500 GB account to FreeBSD developers. Simply " "sign up at https://www.rsync.net/freebsd.html[https://www.rsync.net/" diff --git a/documentation/content/en/articles/contributing/_index.adoc b/documentation/content/en/articles/contributing/_index.adoc index d98ff31de0..44f7b3180b 100644 --- a/documentation/content/en/articles/contributing/_index.adoc +++ b/documentation/content/en/articles/contributing/_index.adoc @@ -93,7 +93,7 @@ If anything is poorly explained, ambiguous, out of date or incorrect, let us kno Even better, send us a fix (AsciiDoc is not difficult to learn, but there is no objection to plain text submissions). . Help translate FreeBSD documentation into your native language. If documentation already exists for your language, you can help translate additional documents or verify that the translations are up-to-date and correct. -First take a look at the extref:{fdp-primer}[Translations FAQ, translations] in the FreeBSD Documentation Project Primer. +First take a look at the extref:{fdp-primer}translations[Translations FAQ, translations] in the FreeBSD Documentation Project Primer. You are not committing yourself to translating every single FreeBSD document by doing this - as a volunteer, you can do as much or as little translation as you desire. Once someone begins translating, others almost always join the effort. If you only have the time or energy to translate one part of the documentation, please translate the installation instructions. @@ -108,9 +108,10 @@ Most of the tasks listed here may require a considerable investment of time, an However, there are also many useful tasks which are suitable for "weekend hackers". . If you run FreeBSD-CURRENT and have a good Internet connection, there is a machine `current.FreeBSD.org` which builds a full release once a day-every now and again, try to install the latest release from it and report any failures in the process. -. Read the {freebsd-bugs}. +. Learn about changes or problems that have already been proposed. There may be a problem you can comment constructively on or with patches you can test. Or you could even try to fix one of the problems yourself. +. One way is to read the {freebsd-bugs} (for issues submitted through Bugzilla). . If you know of any bug fixes which have been successfully applied to -CURRENT but have not been merged into -STABLE after a decent interval (normally a couple of weeks), send the committer a polite reminder. . Move contributed software to [.filename]#src/contrib# in the source tree. . Make sure code in [.filename]#src/contrib# is up to date. @@ -125,12 +126,12 @@ If you are able, figure out how to fix it and include a patch in the PR. If you think the standard is wrong, ask the standards body to consider the question. . Suggest further tasks for this list! -=== Work through the PR Database +=== Work through the Bugzilla Problem Report Database -The https://bugs.FreeBSD.org/search/[FreeBSD PR list] shows all the current active problem reports and requests for enhancement that have been submitted by FreeBSD users. -The PR database includes both programmer and non-programmer tasks. +The https://bugs.FreeBSD.org/search/[FreeBSD Problem Report list] shows all the current active problem reports and requests for enhancement that have been submitted by FreeBSD users via Bugzilla. +This database includes both programmer and non-programmer tasks. Look through the open PRs, and see if anything there takes your interest. -Some of these might be very simple tasks that just need an extra pair of eyes to look over them and confirm that the fix in the PR is a good one. +Some of these might be very simple tasks that just need an extra pair of eyes to look over them and confirm that the fix is a good one. Others might be much more complex, or might not even have a fix included at all. Start with the PRs that have not been assigned to anyone else. @@ -169,7 +170,7 @@ Contributions to the system generally fall into one or more of the following 5 c An idea or suggestion of _general_ technical interest should be mailed to the {freebsd-hackers}. Likewise, people with an interest in such things (and a tolerance for a _high_ volume of mail!) may subscribe to the {freebsd-hackers}. -See extref:{handbook}[The FreeBSD Handbook, eresources-mail] for more information about this and other mailing lists. +See extref:{handbook}eresources[The FreeBSD Handbook, eresources-mail] for more information about this and other mailing lists. If you are submitting a simple patch to the src repo, please consider submitting it to the project's GitHub mirror as https://github.com/freebsd/freebsd-src/pulls[a pull request]. Suitable submissions should: @@ -201,7 +202,7 @@ process crossref:contributing[ports-contributing, Contributing to ports]. The docs team also accepts pull requests via GitHub, but has not established any policy for them yet. -If you find a bug or are submitting a specific change, please report it using the https://bugs.FreeBSD.org/submit/[bug submission form]. +If you find a bug or are submitting a specific change, please report it using the https://bugs.FreeBSD.org/submit/[Bugzilla bug submission form]. Try to fill-in each field of the bug report. Unless they exceed 65KB, include any patches directly in the report. If the patch is suitable to be applied to the source tree put `[PATCH]` in the synopsis of the report. @@ -223,7 +224,7 @@ Send submissions and changes (even small ones are welcome!) using the same metho An addition or change to the existing source code is a somewhat trickier affair and depends a lot on how far out of date you are with the current state of FreeBSD development. There is a special on-going release of FreeBSD known as "FreeBSD-CURRENT" which is made available in a variety of ways for the convenience of developers working actively on the system. -See extref:{handbook}[The FreeBSD Handbook, current-stable] for more information about getting and using FreeBSD-CURRENT. +See extref:{handbook}cutting-edge[The FreeBSD Handbook, current-stable] for more information about getting and using FreeBSD-CURRENT. Working from older sources unfortunately means that your changes may sometimes be too obsolete or too divergent for easy re-integration into FreeBSD. Chances of this can be minimized somewhat by subscribing to the {freebsd-announce} and the {freebsd-current} lists, where discussions on the current state of the system take place. @@ -249,7 +250,7 @@ would generate a set of unified diffs for the given source file or directory hie See man:diff[1] for more information. -Once you have a set of diffs (which you may test with the man:patch[1] command), you should submit them for inclusion with FreeBSD as a bug report. +Once you have a set of diffs (which you may test with the man:patch[1] command), you may submit them for inclusion with FreeBSD as a Bugzilla problem report. _Do not_ just send the diffs to the {freebsd-hackers} or they will get lost! We greatly appreciate your submission (this is a volunteer project!); because we are busy, we may not be able to address it immediately, but it will remain in the PR database until we do. Indicate your submission by including `[PATCH]` in the synopsis of the report. @@ -337,7 +338,7 @@ Also read the extref:{porters-handbook}[Porter's Handbook]. _Please do not commit yourself to more than you feel you can comfortably handle._ You may request maintainership of any unmaintained port as soon as you wish. -Simply set `MAINTAINER` to your own email address and send a PR (Problem Report) with the change. +Simply set `MAINTAINER` to your own email address and send a Problem Report with the change. If the port has build errors or needs updating, you may wish to include any other changes in the same PR. This will help because many committers are less willing to assign maintainership to someone who does not have a known track record with FreeBSD. Submitting PRs that fix build errors or update ports are the best ways to establish one. @@ -425,14 +426,14 @@ This is especially important if your update changes the shared library version; . Submit changes + -Send your update by submitting a PR with an explanation of the changes and a patch containing the differences between the original port and the updated one. +Send your update by submitting a Problem Report with an explanation of the changes and a patch containing the differences between the original port and the updated one. Please refer to extref:{problem-reports}[Writing FreeBSD Problem Reports] for information on how to write a really good PR. + [NOTE] ====== Please do not submit a man:shar[1] archive of the entire port; instead, use man:git-format-patch[1] or man:diff[1] `-ruN`. In this way, committers can much more easily see exactly what changes are being made. -The Porter's Handbook section on extref:{porters-handbook}[Upgrading, port-upgrading] has more information. +The Porter's Handbook section on extref:{porters-handbook}upgrading[Upgrading, port-upgrading] has more information. ====== . Wait + @@ -503,7 +504,7 @@ If so, this may even help their users on other BSD-based systems as well and per Please consider sending any applicable patches to the authors as a courtesy. ==== -===== Investigate bug reports and PRs related to your port +===== Investigate bug reports and Bugzilla Problem Reports related to your port This section is about discovering and fixing bugs. @@ -516,7 +517,7 @@ These are the tasks you need to perform to ensure your port continues to work as ==== . Respond to bug reports + -Bugs may be reported to you through email via the https://bugs.FreeBSD.org/search/[Problem Report database]. +Bugs may be reported to you through email via the https://bugs.FreeBSD.org/search/[Bugzilla Problem Report database]. Bugs may also be reported directly to you by users. + You should respond to PRs and other reports within 14 days, but please try not to take that long. @@ -549,7 +550,7 @@ As with build errors, you will need to sort out a fix to the problem. Again, remember to ask if you are stuck! . Submit or approve changes + -Just as with updating a port, you should now incorporate changes, review and test, and submit your changes in a PR (or send a follow-up if a PR already exists for the problem). +Just as with updating a port, you should now incorporate changes, review and test, and submit your changes in a Bugzilla PR (or send a follow-up if a PR already exists for the problem). If another user has submitted changes in the PR, you can also send a follow-up saying whether or not you approve the changes. ==== @@ -566,7 +567,7 @@ Take the opportunity to tell them that your port is up to date (if it is, of cou Sometimes users and developers will decide that you are a busy person whose time is valuable and do some of the work for you. For example, they might: -* submit a PR or send you patches to update your port, +* submit a Bugzilla PR or send you patches to update your port, * investigate and perhaps provide a fix to a PR, or * otherwise submit changes to your port. @@ -583,7 +584,7 @@ If you can make them feel that their contribution is appreciated (and it should There are some really good places to find a port that needs some attention. -You can use the https://bugs.freebsd.org/search[web interface] to the Problem Report database to search through and view unresolved PRs. +You can use the https://bugs.freebsd.org/search[web interface] to the Problem Report database to search through and view unresolved Bugzilla PRs. The majority of ports PRs are updates, but with a little searching and skimming over synopses you should be able to find something interesting to work on. https://portsfallout.com/[PortsFallout] shows port issues gathered from the FreeBSD package building. @@ -614,11 +615,10 @@ By this, we mean that there are unresolved problems or pending updates that have The extref:{porters-handbook}[Porter's Handbook] is your hitchhiker's guide to the ports system. Keep it handy! -extref:{problem-reports}[Writing FreeBSD Problem Reports] describes how to best formulate and submit a PR. -In 2005 more than eleven thousand ports PRs were submitted! +extref:{problem-reports}[Writing FreeBSD Problem Reports] describes how to best formulate and submit a Problem Report. Following this article will greatly assist us in reducing the time needed to handle your PRs. -The https://bugs.freebsd.org/bugzilla/query.cgi[Problem Report database]. +The https://bugs.freebsd.org/bugzilla/query.cgi[Bugzilla Problem Report database]. The http://portscout.FreeBSD.org[FreeBSD Ports distfile scanner (portscout)] can show you ports for which the distfiles are not fetchable. You can check on your own ports or use it to find ports that need their `MASTER_SITES` updated. diff --git a/documentation/content/en/articles/contributing/_index.po b/documentation/content/en/articles/contributing/_index.po index b5c3a104a4..18598128c7 100644 --- a/documentation/content/en/articles/contributing/_index.po +++ b/documentation/content/en/articles/contributing/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2024-12-29 08:30-0500\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -144,13 +144,14 @@ msgid "" "Help translate FreeBSD documentation into your native language. If " "documentation already exists for your language, you can help translate " "additional documents or verify that the translations are up-to-date and " -"correct. First take a look at the extref:{fdp-primer}[Translations FAQ, " -"translations] in the FreeBSD Documentation Project Primer. You are not " -"committing yourself to translating every single FreeBSD document by doing " -"this - as a volunteer, you can do as much or as little translation as you " -"desire. Once someone begins translating, others almost always join the " -"effort. If you only have the time or energy to translate one part of the " -"documentation, please translate the installation instructions." +"correct. First take a look at the extref:{fdp-primer}" +"translations[Translations FAQ, translations] in the FreeBSD Documentation " +"Project Primer. You are not committing yourself to translating every single " +"FreeBSD document by doing this - as a volunteer, you can do as much or as " +"little translation as you desire. Once someone begins translating, others " +"almost always join the effort. If you only have the time or energy to " +"translate one part of the documentation, please translate the installation " +"instructions." msgstr "" #. type: Plain text @@ -196,8 +197,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/contributing/_index.adoc:115 msgid "" -"If you know of any bug fixes which have been successfully applied to -" -"CURRENT but have not been merged into -STABLE after a decent interval " +"If you know of any bug fixes which have been successfully applied to " +"-CURRENT but have not been merged into -STABLE after a decent interval " "(normally a couple of weeks), send the committer a polite reminder." msgstr "" @@ -330,15 +331,15 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/contributing/_index.adoc:155 msgid "" -"If you have created or adopted a port, be aware of crossref:" -"contributing[maintain-port, The challenge for port maintainers]." +"If you have created or adopted a port, be aware of " +"crossref:contributing[maintain-port, The challenge for port maintainers]." msgstr "" #. type: Plain text #: documentation/content/en/articles/contributing/_index.adoc:156 msgid "" -"When you are looking for a quick challenge you could crossref:" -"contributing[fix-broken, Finding and fixing a broken port]." +"When you are looking for a quick challenge you could " +"crossref:contributing[fix-broken, Finding and fixing a broken port]." msgstr "" #. type: Title === @@ -381,8 +382,8 @@ msgid "" "An idea or suggestion of _general_ technical interest should be mailed to " "the {freebsd-hackers}. Likewise, people with an interest in such things " "(and a tolerance for a _high_ volume of mail!) may subscribe to the {freebsd-" -"hackers}. See extref:{handbook}[The FreeBSD Handbook, eresources-mail] for " -"more information about this and other mailing lists." +"hackers}. See extref:{handbook}eresources[The FreeBSD Handbook, eresources-" +"mail] for more information about this and other mailing lists." msgstr "" #. type: Plain text @@ -474,8 +475,8 @@ msgstr "" msgid "" "Pull requests submitted to the ports repository may or may not see action, " "based on the whims of developers. For now, you will have a better " -"experience if you follow the ports submission process crossref:" -"contributing[ports-contributing, Contributing to ports]." +"experience if you follow the ports submission process " +"crossref:contributing[ports-contributing, Contributing to ports]." msgstr "" #. type: Plain text @@ -543,8 +544,8 @@ msgid "" "state of FreeBSD development. There is a special on-going release of " "FreeBSD known as \"FreeBSD-CURRENT\" which is made available in a variety of " "ways for the convenience of developers working actively on the system. See " -"extref:{handbook}[The FreeBSD Handbook, current-stable] for more information " -"about getting and using FreeBSD-CURRENT." +"extref:{handbook}cutting-edge[The FreeBSD Handbook, current-stable] for more " +"information about getting and using FreeBSD-CURRENT." msgstr "" #. type: Plain text @@ -717,17 +718,18 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/contributing/_index.adoc:299 msgid "" -"The FreeBSD Foundation is also able to accept https://www.freebsdfoundation." -"org/donate/[online donations] through various payment options." +"The FreeBSD Foundation is also able to accept https://" +"www.freebsdfoundation.org/donate/[online donations] through various payment " +"options." msgstr "" #. type: Plain text #: documentation/content/en/articles/contributing/_index.adoc:302 msgid "" -"More information about the FreeBSD Foundation can be found in https://people." -"FreeBSD.org/~jdp/foundation/announcement.html[The FreeBSD Foundation -- an " -"Introduction]. To contact the Foundation by email, write to mailto:" -"info@FreeBSDFoundation.org[info@FreeBSDFoundation.org]." +"More information about the FreeBSD Foundation can be found in https://" +"people.FreeBSD.org/~jdp/foundation/announcement.html[The FreeBSD Foundation " +"-- an Introduction]. To contact the Foundation by email, write to " +"mailto:info@FreeBSDFoundation.org[info@FreeBSDFoundation.org]." msgstr "" #. type: Title ==== @@ -783,8 +785,9 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/contributing/_index.adoc:325 msgid "" -"On https://portsfallout.com/fallout?port=&maintainer=ports%40FreeBSD." -"org[PortsFallout] can be seen a list of unmaintained ports with errors." +"On https://portsfallout.com/fallout?" +"port=&maintainer=ports%40FreeBSD.org[PortsFallout] can be seen a list of " +"unmaintained ports with errors." msgstr "" #. type: Plain text @@ -800,10 +803,11 @@ msgstr "" msgid "" "You can find out whether or not a port has dependencies or secondary ports " "by looking at a primary index of ports called [.filename]#INDEX#. (The name " -"of the file varies by release of FreeBSD; for instance, [." -"filename]#INDEX-13#.) Some ports have conditional dependencies that are not " -"included in a default [.filename]#INDEX# build. We expect you to be able to " -"recognize such ports by looking through other ports' [.filename]#Makefile#'s." +"of the file varies by release of FreeBSD; for instance, " +"[.filename]#INDEX-13#.) Some ports have conditional dependencies that are " +"not included in a default [.filename]#INDEX# build. We expect you to be " +"able to recognize such ports by looking through other ports' " +"[.filename]#Makefile#'s." msgstr "" #. type: Title ==== @@ -1018,9 +1022,9 @@ msgstr "" #: documentation/content/en/articles/contributing/_index.adoc:418 msgid "" "Make sure your port's dependencies are complete. The recommended way of " -"doing this is by installing your own ports tinderbox. See crossref:" -"contributing[resources, Resources for ports maintainers and contributors] " -"for more information." +"doing this is by installing your own ports tinderbox. See " +"crossref:contributing[resources, Resources for ports maintainers and " +"contributors] for more information." msgstr "" #. type: delimited block = 4 @@ -1033,9 +1037,9 @@ msgstr "" #. type: delimited block = 4 #: documentation/content/en/articles/contributing/_index.adoc:422 msgid "" -"Verify your port using man:portlint[1] as a guide. See crossref:" -"contributing[resources, Resources for ports maintainers and contributors] " -"for important information about using portlint." +"Verify your port using man:portlint[1] as a guide. See " +"crossref:contributing[resources, Resources for ports maintainers and " +"contributors] for important information about using portlint." msgstr "" #. type: delimited block = 4 @@ -1070,8 +1074,8 @@ msgid "" "Please do not submit a man:shar[1] archive of the entire port; instead, use " "man:git-format-patch[1] or man:diff[1] `-ruN`. In this way, committers can " "much more easily see exactly what changes are being made. The Porter's " -"Handbook section on extref:{porters-handbook}[Upgrading, port-upgrading] has " -"more information." +"Handbook section on extref:{porters-handbook}upgrading[Upgrading, port-" +"upgrading] has more information." msgstr "" #. type: Plain text @@ -1201,8 +1205,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/contributing/_index.adoc:485 msgid "" -"The commands and options used to build the port (including options set in [." -"filename]#/etc/make.conf#)" +"The commands and options used to build the port (including options set in " +"[.filename]#/etc/make.conf#)" msgstr "" #. type: Plain text diff --git a/documentation/content/en/articles/filtering-bridges/_index.adoc b/documentation/content/en/articles/filtering-bridges/_index.adoc index 1ef6adc085..64c7bd781b 100644 --- a/documentation/content/en/articles/filtering-bridges/_index.adoc +++ b/documentation/content/en/articles/filtering-bridges/_index.adoc @@ -96,7 +96,7 @@ options IPFIREWALL_VERBOSE The first line is to compile the bridge support, the second one is the firewall and the third one is the logging functions of the firewall. Now it is necessary to build and install the new kernel. -You may find detailed instructions in the extref:{handbook}[Building and Installing a Custom Kernel, kernelconfig-building] section of the FreeBSD Handbook. +You may find detailed instructions in the extref:{handbook}kernelconfig[Building and Installing a Custom Kernel, kernelconfig-building] section of the FreeBSD Handbook. [[filtering-bridges-modules]] === Modules Loading diff --git a/documentation/content/en/articles/filtering-bridges/_index.po b/documentation/content/en/articles/filtering-bridges/_index.po index 987db4a5fc..da2849c6a5 100644 --- a/documentation/content/en/articles/filtering-bridges/_index.po +++ b/documentation/content/en/articles/filtering-bridges/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2024-01-17 20:35-0300\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -157,8 +157,9 @@ msgstr "" #: documentation/content/en/articles/filtering-bridges/_index.adoc:100 msgid "" "Now it is necessary to build and install the new kernel. You may find " -"detailed instructions in the extref:{handbook}[Building and Installing a " -"Custom Kernel, kernelconfig-building] section of the FreeBSD Handbook." +"detailed instructions in the extref:{handbook}kernelconfig[Building and " +"Installing a Custom Kernel, kernelconfig-building] section of the FreeBSD " +"Handbook." msgstr "" #. type: Title === @@ -221,8 +222,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/filtering-bridges/_index.adoc:131 msgid "" -"The first row will enable the firewall (and will load the module [." -"filename]#ipfw.ko# if it is not compiled in the kernel), the second one to " +"The first row will enable the firewall (and will load the module " +"[.filename]#ipfw.ko# if it is not compiled in the kernel), the second one to " "set up it in `open` mode (as explained in [.filename]#/etc/rc.firewall#), " "the third one to not show rules loading and the fourth one to enable logging " "support." @@ -242,8 +243,8 @@ msgid "" "interface (the one connected to Internet, where DNS server resides), since " "the bridge will be activated at the end of the startup procedure. It means " "that the [.filename]#fxp0# interface (in our case) must be mentioned in the " -"ifconfig section of the [.filename]#/etc/rc.conf# file, while the [." -"filename]#xl0# is not. Assigning an IP to both the network cards does not " +"ifconfig section of the [.filename]#/etc/rc.conf# file, while the " +"[.filename]#xl0# is not. Assigning an IP to both the network cards does not " "make much sense, unless, during the start procedure, applications should " "access to services on both Ethernet segments." msgstr "" @@ -365,9 +366,9 @@ msgid "" "Let's look at an example setup. Note first that at the top of [.filename]#/" "etc/rc.firewall# there are already standard rules for the loopback interface " "[.filename]#lo0#, so we should not have to care for them anymore. Custom " -"rules should be put in a separate file (say [.filename]#/etc/rc.firewall." -"local#) and loaded at system startup, by modifying the row of [.filename]#/" -"etc/rc.conf# where we defined the `open` firewall:" +"rules should be put in a separate file (say [.filename]#/etc/" +"rc.firewall.local#) and loaded at system startup, by modifying the row of " +"[.filename]#/etc/rc.conf# where we defined the `open` firewall:" msgstr "" #. type: delimited block . 4 diff --git a/documentation/content/en/articles/freebsd-questions/_index.adoc b/documentation/content/en/articles/freebsd-questions/_index.adoc index 2869c685ab..052c202ffd 100644 --- a/documentation/content/en/articles/freebsd-questions/_index.adoc +++ b/documentation/content/en/articles/freebsd-questions/_index.adoc @@ -101,7 +101,7 @@ The following criteria should help for 99% of all questions, however: . If the question relates to a bug, and you are _sure_ that it is a bug (for example, you can pinpoint the place in the code where it happens, and you maybe have a fix), then send the message to `FreeBSD-hackers`. . If the question relates to enhancements to FreeBSD, and you can make suggestions about how to implement them, then send the message to `FreeBSD-hackers`. -There are also a number of other extref:{handbook}[specialized mailing lists, eresources-mail], which caters to more specific interests. +There are also a number of other extref:{handbook}eresources[specialized mailing lists, eresources-mail], which caters to more specific interests. The criteria above still apply, and it is in your interest to stick to them, since you are more likely to get good results that way. == Before Submitting a Question @@ -110,7 +110,7 @@ You can (and should) do some things yourself before asking a question on one of * Try solving the problem on your own. If you post a question which shows that you have tried to solve the problem, your question will generally attract more positive attention from people reading it. Trying to solve the problem yourself will also enhance your understanding of FreeBSD, and will eventually let you use your knowledge to help others by answering questions posted to the mailing lists. * Read the manual pages, and the FreeBSD documentation (either installed in [.filename]#/usr/doc# or accessible via WWW at http://www.FreeBSD.org[http://www.FreeBSD.org]), especially the extref:{handbook}[handbook] and the extref:{faq}[FAQ]. -* Browse and/or search the archives for the mailing list, to see if your question or a similar one has been asked (and possibly answered) on the list. You can browse and/or search the mailing list archives at https://www.FreeBSD.org/mail[https://www.FreeBSD.org/mail] and https://www.FreeBSD.org/search/#mailinglists[https://www.FreeBSD.org/search/#mailinglists] respectively. +* Browse and/or search the archives for the mailing list, to see if your question or a similar one has been asked (and possibly answered) on the list. You can browse and/or search the mailing list archives at https://www.FreeBSD.org/mail[https://www.FreeBSD.org/mail] and https://www.FreeBSD.org/search/#mailinglists[https://www.FreeBSD.org/search/#mailinglists] respectively. * Use a search engine such as http://www.google.com[Google] or http://www.yahoo.com[Yahoo] to find answers to your question. == How to Submit a Question diff --git a/documentation/content/en/articles/freebsd-questions/_index.po b/documentation/content/en/articles/freebsd-questions/_index.po index 9856b90616..d382b70b90 100644 --- a/documentation/content/en/articles/freebsd-questions/_index.po +++ b/documentation/content/en/articles/freebsd-questions/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2023-09-09 18:13-0300\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -195,9 +195,9 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/freebsd-questions/_index.adoc:106 msgid "" -"There are also a number of other extref:{handbook}[specialized mailing " -"lists, eresources-mail], which caters to more specific interests. The " -"criteria above still apply, and it is in your interest to stick to them, " +"There are also a number of other extref:{handbook}eresources[specialized " +"mailing lists, eresources-mail], which caters to more specific interests. " +"The criteria above still apply, and it is in your interest to stick to them, " "since you are more likely to get good results that way." msgstr "" @@ -228,8 +228,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/freebsd-questions/_index.adoc:113 msgid "" -"Read the manual pages, and the FreeBSD documentation (either installed in [." -"filename]#/usr/doc# or accessible via WWW at http://www.FreeBSD.org[http://" +"Read the manual pages, and the FreeBSD documentation (either installed in " +"[.filename]#/usr/doc# or accessible via WWW at http://www.FreeBSD.org[http://" "www.FreeBSD.org]), especially the extref:{handbook}[handbook] and the extref:" "{faq}[FAQ]." msgstr "" @@ -239,17 +239,17 @@ msgstr "" msgid "" "Browse and/or search the archives for the mailing list, to see if your " "question or a similar one has been asked (and possibly answered) on the " -"list. You can browse and/or search the mailing list archives at https://www." -"FreeBSD.org/mail[https://www.FreeBSD.org/mail] and https://www.FreeBSD.org/" -"search/#mailinglists[https://www.FreeBSD.org/search/#mailinglists] " -"respectively." +"list. You can browse and/or search the mailing list archives at https://" +"www.FreeBSD.org/mail[https://www.FreeBSD.org/mail] and https://" +"www.FreeBSD.org/search/#mailinglists[https://www.FreeBSD.org/search/" +"#mailinglists] respectively." msgstr "" #. type: Plain text #: documentation/content/en/articles/freebsd-questions/_index.adoc:115 msgid "" -"Use a search engine such as http://www.google.com[Google] or http://www." -"yahoo.com[Yahoo] to find answers to your question." +"Use a search engine such as http://www.google.com[Google] or http://" +"www.yahoo.com[Yahoo] to find answers to your question." msgstr "" #. type: Title == @@ -311,9 +311,9 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/freebsd-questions/_index.adoc:129 msgid "" -"A lot of badly formatted messages come from http://www.lemis.com/email." -"html[bad mailers or badly configured mailers]. The following mailers are " -"known to send out badly formatted messages without you finding out about " +"A lot of badly formatted messages come from http://www.lemis.com/" +"email.html[bad mailers or badly configured mailers]. The following mailers " +"are known to send out badly formatted messages without you finding out about " "them:" msgstr "" @@ -386,9 +386,9 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/freebsd-questions/_index.adoc:143 msgid "" -"There is a judgement call here, of course, but the output of the man:" -"dmesg[8] command can frequently be very useful, since it tells not just what " -"hardware you are running, but what version of FreeBSD as well." +"There is a judgement call here, of course, but the output of the " +"man:dmesg[8] command can frequently be very useful, since it tells not just " +"what hardware you are running, but what version of FreeBSD as well." msgstr "" #. type: Plain text diff --git a/documentation/content/en/articles/freebsd-update-server/_index.adoc b/documentation/content/en/articles/freebsd-update-server/_index.adoc index 78f44784c8..fd7c066605 100644 --- a/documentation/content/en/articles/freebsd-update-server/_index.adoc +++ b/documentation/content/en/articles/freebsd-update-server/_index.adoc @@ -88,7 +88,7 @@ At a minimum, updates require building on a FreeBSD release greater than or equa ==== * A user account with at least 4 GB of available space. This will allow the creation of updates for 7.1 and 7.2, but the exact space requirements may change from version to version. * An man:ssh[1] account on a remote machine to upload distributed updates. -* A web server, like extref:{handbook}[Apache, network-apache], with over half of the space required for the build. For instance, test builds for 7.1 and 7.2 consume a total amount of 4 GB, and the webserver space needed to distribute these updates is 2.6 GB. +* A web server, like extref:{handbook}network-servers[Apache, network-apache], with over half of the space required for the build. For instance, test builds for 7.1 and 7.2 consume a total amount of 4 GB, and the webserver space needed to distribute these updates is 2.6 GB. * Basic knowledge of shell scripting with Bourne shell, man:sh[1]. [[Configuration]] @@ -402,9 +402,9 @@ In the event update code needs to be re-uploaded, this may be done by changing t The uploaded files will need to be in the document root of the webserver in order for updates to be distributed. The exact configuration will vary depending on the web server used. -For the Apache web server, please refer to the extref:{handbook}[Configuration of Apache servers, network-apache] section in the Handbook. +For the Apache web server, please refer to the extref:{handbook}network-servers[Configuration of Apache servers, network-apache] section in the Handbook. -Update client's `KeyPrint` and `ServerName` in [.filename]#/etc/freebsd-update.conf#, and perform updates as instructed in the extref:{handbook}[FreeBSD Update, updating-upgrading-freebsdupdate] section of the Handbook. +Update client's `KeyPrint` and `ServerName` in [.filename]#/etc/freebsd-update.conf#, and perform updates as instructed in the extref:{handbook}cutting-edge[FreeBSD Update, updating-upgrading-freebsdupdate] section of the Handbook. [IMPORTANT] ==== @@ -437,7 +437,7 @@ Create the patch directory of the respective release under [.filename]#/usr/loca As an example, take the patch for man:named[8]. Read the advisory, and grab the necessary file from link:https://www.FreeBSD.org/security/advisories/[FreeBSD Security Advisories]. -More information on interpreting the advisory, can be found in the extref:{handbook}[FreeBSD Handbook, security-advisories]. +More information on interpreting the advisory, can be found in the extref:{handbook}security[FreeBSD Handbook, security-advisories]. In the https://security.freebsd.org/advisories/FreeBSD-SA-09:12.bind.asc[security brief], this advisory is called `SA-09:12.bind`. After downloading the file, it is required to rename the file to an appropriate patch level. @@ -631,7 +631,7 @@ addextradocs () { make ${COMPATFLAGS} release.1 release.2 2>&1 .... -* Create an appropriate extref:{handbook}[DNS, network-dns] SRV record for the update server, and put others behind it with variable weights. Using this facility will provide update mirrors, however this tip is not necessary unless you wish to provide a redundant service. +* Create an appropriate extref:{handbook}network-servers[DNS, network-dns] SRV record for the update server, and put others behind it with variable weights. Using this facility will provide update mirrors, however this tip is not necessary unless you wish to provide a redundant service. + [.programlisting] .... diff --git a/documentation/content/en/articles/freebsd-update-server/_index.po b/documentation/content/en/articles/freebsd-update-server/_index.po index 5424e29877..32a1e20f76 100644 --- a/documentation/content/en/articles/freebsd-update-server/_index.po +++ b/documentation/content/en/articles/freebsd-update-server/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2024-01-17 20:35-0300\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -135,10 +135,10 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/freebsd-update-server/_index.adoc:92 msgid "" -"A web server, like extref:{handbook}[Apache, network-apache], with over half " -"of the space required for the build. For instance, test builds for 7.1 and " -"7.2 consume a total amount of 4 GB, and the webserver space needed to " -"distribute these updates is 2.6 GB." +"A web server, like extref:{handbook}network-servers[Apache, network-apache], " +"with over half of the space required for the build. For instance, test " +"builds for 7.1 and 7.2 consume a total amount of 4 GB, and the webserver " +"space needed to distribute these updates is 2.6 GB." msgstr "" #. type: Plain text @@ -413,8 +413,8 @@ msgstr "" #. type: delimited block = 4 #: documentation/content/en/articles/freebsd-update-server/_index.adoc:224 msgid "" -"Keep a note of the generated key fingerprint. This value is required in [." -"filename]#/etc/freebsd-update.conf# for binary updates." +"Keep a note of the generated key fingerprint. This value is required in " +"[.filename]#/etc/freebsd-update.conf# for binary updates." msgstr "" #. type: Plain text @@ -494,8 +494,8 @@ msgstr "" #. type: delimited block = 4 #: documentation/content/en/articles/freebsd-update-server/_index.adoc:286 msgid "" -"During this second build cycle, the network time protocol daemon, man:" -"ntpd[8], is turned off. Per `{cperciva}`, Security Officer Emeritus of " +"During this second build cycle, the network time protocol daemon, " +"man:ntpd[8], is turned off. Per `{cperciva}`, Security Officer Emeritus of " "FreeBSD, \"the https://github.com/freebsd/freebsd-update-build/[freebsd-" "update-server] build code needs to identify timestamps which are stored in " "files so that they can be ignored when comparing builds to determine which " @@ -660,8 +660,8 @@ msgid "" "The uploaded files will need to be in the document root of the webserver in " "order for updates to be distributed. The exact configuration will vary " "depending on the web server used. For the Apache web server, please refer " -"to the extref:{handbook}[Configuration of Apache servers, network-apache] " -"section in the Handbook." +"to the extref:{handbook}network-servers[Configuration of Apache servers, " +"network-apache] section in the Handbook." msgstr "" #. type: delimited block = 4 @@ -669,7 +669,8 @@ msgstr "" msgid "" "Update client's `KeyPrint` and `ServerName` in [.filename]#/etc/freebsd-" "update.conf#, and perform updates as instructed in the extref:{handbook}" -"[FreeBSD Update, updating-upgrading-freebsdupdate] section of the Handbook." +"cutting-edge[FreeBSD Update, updating-upgrading-freebsdupdate] section of " +"the Handbook." msgstr "" #. type: Plain text @@ -745,20 +746,20 @@ msgid "" "As an example, take the patch for man:named[8]. Read the advisory, and grab " "the necessary file from link:https://www.FreeBSD.org/security/advisories/" "[FreeBSD Security Advisories]. More information on interpreting the " -"advisory, can be found in the extref:{handbook}[FreeBSD Handbook, security-" -"advisories]." +"advisory, can be found in the extref:{handbook}security[FreeBSD Handbook, " +"security-advisories]." msgstr "" #. type: Plain text #: documentation/content/en/articles/freebsd-update-server/_index.adoc:446 msgid "" -"In the https://security.freebsd.org/advisories/FreeBSD-SA-09:12.bind." -"asc[security brief], this advisory is called `SA-09:12.bind`. After " -"downloading the file, it is required to rename the file to an appropriate " -"patch level. It is suggested to keep this consistent with official FreeBSD " -"patch levels, but its name may be freely chosen. For this build, let us " -"follow the currently established practice of FreeBSD and call this `p7`. " -"Rename the file:" +"In the https://security.freebsd.org/advisories/FreeBSD-" +"SA-09:12.bind.asc[security brief], this advisory is called `SA-09:12.bind`. " +"After downloading the file, it is required to rename the file to an " +"appropriate patch level. It is suggested to keep this consistent with " +"official FreeBSD patch levels, but its name may be freely chosen. For this " +"build, let us follow the currently established practice of FreeBSD and call " +"this `p7`. Rename the file:" msgstr "" #. type: delimited block . 4 @@ -999,8 +1000,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/freebsd-update-server/_index.adoc:620 msgid "" -"Adding `-j _NUMBER_` flags to `buildworld` and `obj` targets in the [." -"filename]#scripts/build.subr# script may speed up processing depending on " +"Adding `-j _NUMBER_` flags to `buildworld` and `obj` targets in the " +"[.filename]#scripts/build.subr# script may speed up processing depending on " "the hardware used, however it is not necessary. Using these flags in other " "targets is not recommended, as it may cause the build to become unreliable." msgstr "" @@ -1023,10 +1024,10 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/freebsd-update-server/_index.adoc:635 msgid "" -"Create an appropriate extref:{handbook}[DNS, network-dns] SRV record for the " -"update server, and put others behind it with variable weights. Using this " -"facility will provide update mirrors, however this tip is not necessary " -"unless you wish to provide a redundant service." +"Create an appropriate extref:{handbook}network-servers[DNS, network-dns] SRV " +"record for the update server, and put others behind it with variable " +"weights. Using this facility will provide update mirrors, however this tip " +"is not necessary unless you wish to provide a redundant service." msgstr "" #. type: delimited block . 4 diff --git a/documentation/content/en/articles/geom-class/_index.adoc b/documentation/content/en/articles/geom-class/_index.adoc index cf10202e74..7613cb780a 100644 --- a/documentation/content/en/articles/geom-class/_index.adoc +++ b/documentation/content/en/articles/geom-class/_index.adoc @@ -152,7 +152,7 @@ This is controlled with two [.filename]#/etc/rc.conf# variables: [.programlisting] .... dumpdev="/dev/ad0s4b" -dumpdir="/usr/core +dumpdir="/usr/core" .... The `dumpdev` variable specifies the swap partition and `dumpdir` tells the system where in the filesystem to relocate the core dump on reboot. @@ -241,7 +241,7 @@ Structure `bio` is used for any and all Input/Output operations concerning GEOM. It basically contains information about what device ('provider') should satisfy the request, request type, offset, length, pointer to a buffer, and a bunch of "user-specific" flags and fields that can help implement various hacks. The important thing here is that ``bio``s are handled asynchronously. -That means that, in most parts of the code, there is no analogue to userland's man:read[2] and man:write[2] calls that do not return until a request is done. +That means that, in most parts of the code, there is no analogue to userland's man:read[2] and man:write[2] calls that do not return until a request is done. Rather, a developer-supplied function is called as a notification when the request gets completed (or results in error). The asynchronous programming model (also called "event-driven") is somewhat harder than the much more used imperative one used in userland (at least it takes a while to get used to it). diff --git a/documentation/content/en/articles/geom-class/_index.po b/documentation/content/en/articles/geom-class/_index.po index ef0c661432..04a9dcf135 100644 --- a/documentation/content/en/articles/geom-class/_index.po +++ b/documentation/content/en/articles/geom-class/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2022-02-01 09:21-0300\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -109,8 +109,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/geom-class/_index.adoc:67 msgid "" -"Man pages man:g_bio[9], man:g_event[9], man:g_data[9], man:g_geom[9], man:" -"g_provider[9], man:g_consumer[9], man:g_access[9] & others linked from " +"Man pages man:g_bio[9], man:g_event[9], man:g_data[9], man:g_geom[9], " +"man:g_provider[9], man:g_consumer[9], man:g_access[9] & others linked from " "those, for documentation on specific functionalities." msgstr "" @@ -202,9 +202,10 @@ msgstr "" #: documentation/content/en/articles/geom-class/_index.adoc:110 msgid "" "With the usual way of installing the kernel (`make installkernel`) the debug " -"kernel will not be automatically installed. It is called [.filename]#kernel." -"debug# and located in [.filename]#/usr/obj/usr/src/sys/KERNELNAME/#. For " -"convenience it should be copied to [.filename]#/boot/kernel/#." +"kernel will not be automatically installed. It is called " +"[.filename]#kernel.debug# and located in [.filename]#/usr/obj/usr/src/sys/" +"KERNELNAME/#. For convenience it should be copied to [.filename]#/boot/" +"kernel/#." msgstr "" #. type: Plain text @@ -280,7 +281,7 @@ msgstr "" #, no-wrap msgid "" "dumpdev=\"/dev/ad0s4b\"\n" -"dumpdir=\"/usr/core\n" +"dumpdir=\"/usr/core\"\n" msgstr "" #. type: Plain text @@ -360,8 +361,8 @@ msgstr "" #: documentation/content/en/articles/geom-class/_index.adoc:192 msgid "" "Creating the [.filename]#Makefile# is simple thanks to an extensive set of " -"helper routines provided by the system. In short, here is how a minimal [." -"filename]#Makefile# looks for a kernel module:" +"helper routines provided by the system. In short, here is how a minimal " +"[.filename]#Makefile# looks for a kernel module:" msgstr "" #. type: delimited block . 4 @@ -423,8 +424,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/geom-class/_index.adoc:222 msgid "" -"To use this macro, [.filename]#sys/param.h#, [.filename]#sys/kernel.h# and [." -"filename]#sys/malloc.h# headers must be included." +"To use this macro, [.filename]#sys/param.h#, [.filename]#sys/kernel.h# and " +"[.filename]#sys/malloc.h# headers must be included." msgstr "" #. type: Plain text @@ -457,8 +458,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/geom-class/_index.adoc:236 msgid "" -"If data retrieval speed is very important, see man:tree[3] and man:" -"hashinit[9]." +"If data retrieval speed is very important, see man:tree[3] and " +"man:hashinit[9]." msgstr "" #. type: Title === @@ -495,8 +496,8 @@ msgid "" "least it takes a while to get used to it). In some cases the helper " "routines `g_write_data`() and `g_read_data`() can be used, but __not " "always__. In particular, they cannot be used when a mutex is held; for " -"example, the GEOM topology mutex or the internal mutex held during the `." -"start`() and `.stop`() functions." +"example, the GEOM topology mutex or the internal mutex held during the " +"`.start`() and `.stop`() functions." msgstr "" #. type: Title == @@ -858,9 +859,9 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/geom-class/_index.adoc:369 msgid "" -"Of these, the most important function for doing actual useful work is the `." -"start`() function, which is called when a BIO request arrives for a provider " -"managed by a instance of geom class." +"Of these, the most important function for doing actual useful work is the " +"`.start`() function, which is called when a BIO request arrives for a " +"provider managed by a instance of geom class." msgstr "" #. type: Title === diff --git a/documentation/content/en/articles/gjournal-desktop/_index.adoc b/documentation/content/en/articles/gjournal-desktop/_index.adoc index 1f8c15f843..164c92985b 100644 --- a/documentation/content/en/articles/gjournal-desktop/_index.adoc +++ b/documentation/content/en/articles/gjournal-desktop/_index.adoc @@ -61,7 +61,7 @@ On rare occasions, file system corruption reaches a point where user interventio The new journaling capability provided by GEOM can greatly assist in such scenarios, by virtually eliminating the time required for file system checking, and ensuring that the file system is quickly restored to a consistent state. -This article describes a procedure for implementing UFS journaling on a typical desktop PC scenario (one hard disk used for both operating system and data). +This article describes a procedure for implementing UFS journaling on a typical desktop PC scenario (one hard disk used for both operating system and data). It should be followed during a fresh installation of FreeBSD. The steps are simple enough and do not require overly complex interaction with the command line. @@ -106,14 +106,14 @@ For example: * You reserved some free disk space in a partition in [.filename]#/dev/ad0s1g#. * Using `gjournal`, a new [.filename]#/dev/ad0s1f.journal# device is created where [.filename]#/dev/ad0s1f# is the data provider, and [.filename]#/dev/ad0s1g# is the journal provider. This new device is then used for all subsequent file operations. -The amount of disk space you need to reserve for the journal provider depends on the usage load of the file system and not on the size of the data provider. +The amount of disk space you need to reserve for the journal provider depends on the usage load of the file system and not on the size of the data provider. For example on a typical office desktop, a 1 GB journal provider for the [.filename]#/usr# file system will suffice, while a machine that deals with heavy disk I/O (i.e. video editing) may need more. A kernel panic will occur if the journal space is exhausted before it has a chance to be committed. [NOTE] ==== The journal sizes suggested here, are highly unlikely to cause problems in typical desktop use (such as web browsing, word processing and playback of media files). -If your workload includes intense disk activity, use the following rule for maximum reliability: Your RAM size should fit in 30% of the journal provider's space. +If your workload includes intense disk activity, use the following rule for maximum reliability: Your RAM size should fit in 30% of the journal provider's space. For example, if your system has 1 GB RAM, create an approximately 3.3 GB journal provider. (Multiply your RAM size with 3.3 to obtain the size of the journal). ==== @@ -197,7 +197,7 @@ We would however suggest you postpone installation of third party software (pack [[first-boot]] === Booting for the first time -Your system will come up normally, but you will need to edit [.filename]#/etc/fstab# and remove the extra swap partitions you created for the journals. +Your system will come up normally, but you will need to edit [.filename]#/etc/fstab# and remove the extra swap partitions you created for the journals. Normally, the swap partition you will actually use is the one with the "b" suffix (i.e. ad0s1b in our example). Remove all other swap space entries and reboot so that FreeBSD will stop using them. @@ -371,7 +371,7 @@ options UFS_GJOURNAL # Note: This is already in GENERIC options GEOM_JOURNAL # You will have to add this one .... -Rebuild and reinstall your kernel following the relevant extref:{handbook}[instructions in the FreeBSD Handbook., kernelconfig] +Rebuild and reinstall your kernel following the relevant extref:{handbook}kernelconfig[instructions in the FreeBSD Handbook., kernelconfig] Do not forget to remove the relevant "load" entry from [.filename]#/boot/loader.conf# if you have previously used it. @@ -504,7 +504,7 @@ Finally, edit [.filename]#/boot/loader.conf#, remove the entry that loads the `g Journaling is a fairly new feature of FreeBSD, and as such, it is not very well documented yet. You may however find the following additional references useful: -* A extref:{handbook}[new section on journaling, geom-gjournal] is now part of the FreeBSD Handbook. +* A extref:{handbook}geom[new section on journaling, geom-gjournal] is now part of the FreeBSD Handbook. * https://lists.freebsd.org/pipermail/freebsd-current/2006-June/064043.html[This post] in {freebsd-current} by man:gjournal[8]'s developer, `{pjd}`. * https://lists.freebsd.org/pipermail/freebsd-questions/2008-April/173501.html[This post] in {freebsd-questions} by `{ivoras}`. * The manual pages of man:gjournal[8] and man:geom[8]. diff --git a/documentation/content/en/articles/gjournal-desktop/_index.po b/documentation/content/en/articles/gjournal-desktop/_index.po index 260c965b75..44f42646d0 100644 --- a/documentation/content/en/articles/gjournal-desktop/_index.po +++ b/documentation/content/en/articles/gjournal-desktop/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2024-12-29 08:30-0500\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -190,8 +190,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/gjournal-desktop/_index.adoc:106 msgid "" -"You wish to journal your [.filename]#/usr# file system, stored in [." -"filename]#/dev/ad0s1f# (which already contains data)." +"You wish to journal your [.filename]#/usr# file system, stored in " +"[.filename]#/dev/ad0s1f# (which already contains data)." msgstr "" #. type: Plain text @@ -236,8 +236,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/gjournal-desktop/_index.adoc:122 msgid "" -"For more information about journaling, please read the manual page of man:" -"gjournal[8]." +"For more information about journaling, please read the manual page of " +"man:gjournal[8]." msgstr "" #. type: Title == @@ -291,8 +291,8 @@ msgstr "" #: documentation/content/en/articles/gjournal-desktop/_index.adoc:142 msgid "" "If this is more or less what you need, it is very easy to adjust for " -"journaling. Simply use the arrow keys to move the highlight to the [." -"filename]#/usr# partition and press kbd:[D] to delete it." +"journaling. Simply use the arrow keys to move the highlight to the " +"[.filename]#/usr# partition and press kbd:[D] to delete it." msgstr "" #. type: Plain text @@ -310,10 +310,10 @@ msgstr "" #: documentation/content/en/articles/gjournal-desktop/_index.adoc:152 msgid "" "Should you journal the [.filename]#/var# partition? Normally, journaling " -"makes sense on quite large partitions. You may decide not to journal [." -"filename]#/var#, although doing so on a typical desktop will cause no harm. " -"If the file system is lightly used (quite probable for a desktop) you may " -"wish to allocate less disk space for its journal." +"makes sense on quite large partitions. You may decide not to journal " +"[.filename]#/var#, although doing so on a typical desktop will cause no " +"harm. If the file system is lightly used (quite probable for a desktop) you " +"may wish to allocate less disk space for its journal." msgstr "" #. type: delimited block = 4 @@ -494,8 +494,8 @@ msgstr "" #: documentation/content/en/articles/gjournal-desktop/_index.adoc:222 msgid "" "Press kbd:[Enter] to get the default shell. We will need to unmount the " -"partitions that will be journaled, in our example [.filename]#/usr# and [." -"filename]#/var#:" +"partitions that will be journaled, in our example [.filename]#/usr# and " +"[.filename]#/var#:" msgstr "" #. type: delimited block . 4 @@ -522,8 +522,8 @@ msgstr "" msgid "" "Now, use your notes to determine which partition will be used for each " "journal. In our example, [.filename]#/usr# is [.filename]#ad0s1f# and its " -"journal will be [.filename]#ad0s1g#, while [.filename]#/var# is [." -"filename]#ad0s1d# and will be journaled to [.filename]#ad0s1h#. The " +"journal will be [.filename]#ad0s1g#, while [.filename]#/var# is " +"[.filename]#ad0s1d# and will be journaled to [.filename]#ad0s1h#. The " "following commands are required:" msgstr "" @@ -569,10 +569,11 @@ msgstr "" #. type: delimited block = 4 #: documentation/content/en/articles/gjournal-desktop/_index.adoc:266 msgid "" -"At this point, two new devices are created, namely [.filename]#ad0s1d." -"journal# and [.filename]#ad0s1f.journal#. These represent the [.filename]#/" -"var# and [.filename]#/usr# partitions we have to mount. Before mounting, we " -"must however set the journal flag on them and clear the Soft Updates flag:" +"At this point, two new devices are created, namely " +"[.filename]#ad0s1d.journal# and [.filename]#ad0s1f.journal#. These " +"represent the [.filename]#/var# and [.filename]#/usr# partitions we have to " +"mount. Before mounting, we must however set the journal flag on them and " +"clear the Soft Updates flag:" msgstr "" #. type: delimited block . 4 @@ -769,7 +770,7 @@ msgstr "" #: documentation/content/en/articles/gjournal-desktop/_index.adoc:375 msgid "" "Rebuild and reinstall your kernel following the relevant extref:{handbook}" -"[instructions in the FreeBSD Handbook., kernelconfig]" +"kernelconfig[instructions in the FreeBSD Handbook., kernelconfig]" msgstr "" #. type: Plain text @@ -818,10 +819,10 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/gjournal-desktop/_index.adoc:396 msgid "" -"You either forgot (or misspelled) the entry in [.filename]#/boot/loader." -"conf#, or there are errors in your [.filename]#/etc/fstab# file. These are " -"usually easy to fix. Press kbd:[Enter] to get to the default single user " -"shell. Then locate the root of the problem:" +"You either forgot (or misspelled) the entry in [.filename]#/boot/" +"loader.conf#, or there are errors in your [.filename]#/etc/fstab# file. " +"These are usually easy to fix. Press kbd:[Enter] to get to the default " +"single user shell. Then locate the root of the problem:" msgstr "" #. type: delimited block . 4 @@ -1005,22 +1006,23 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/gjournal-desktop/_index.adoc:508 msgid "" -"A extref:{handbook}[new section on journaling, geom-gjournal] is now part of " -"the FreeBSD Handbook." +"A extref:{handbook}geom[new section on journaling, geom-gjournal] is now " +"part of the FreeBSD Handbook." msgstr "" #. type: Plain text #: documentation/content/en/articles/gjournal-desktop/_index.adoc:509 msgid "" -"https://lists.freebsd.org/pipermail/freebsd-current/2006-June/064043." -"html[This post] in {freebsd-current} by man:gjournal[8]'s developer, `{pjd}`." +"https://lists.freebsd.org/pipermail/freebsd-current/2006-June/" +"064043.html[This post] in {freebsd-current} by man:gjournal[8]'s developer, " +"`{pjd}`." msgstr "" #. type: Plain text #: documentation/content/en/articles/gjournal-desktop/_index.adoc:510 msgid "" -"https://lists.freebsd.org/pipermail/freebsd-questions/2008-April/173501." -"html[This post] in {freebsd-questions} by `{ivoras}`." +"https://lists.freebsd.org/pipermail/freebsd-questions/2008-April/" +"173501.html[This post] in {freebsd-questions} by `{ivoras}`." msgstr "" #. type: Plain text diff --git a/documentation/content/en/articles/hubs/_index.adoc b/documentation/content/en/articles/hubs/_index.adoc index 1ddbe3065a..8445423a5d 100644 --- a/documentation/content/en/articles/hubs/_index.adoc +++ b/documentation/content/en/articles/hubs/_index.adoc @@ -392,7 +392,7 @@ Tier-1 mirrors are required to: * provide FTP and rsync access Furthermore, admins should be subscribed to the {freebsd-hubs}. -See extref:{handbook}[this link, eresources-mail] for details, how to subscribe. +See extref:{handbook}eresources[this link, eresources-mail] for details, how to subscribe. [IMPORTANT] ==== diff --git a/documentation/content/en/articles/hubs/_index.po b/documentation/content/en/articles/hubs/_index.po index 0d084bc187..ced3182894 100644 --- a/documentation/content/en/articles/hubs/_index.po +++ b/documentation/content/en/articles/hubs/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2024-12-29 08:30-0500\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -107,9 +107,9 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/hubs/_index.adoc:88 msgid "" -"The current disk usage of FTP Distribution can be found at link:ftp://ftp." -"FreeBSD.org/pub/FreeBSD/dir.sizes[ftp://ftp.FreeBSD.org/pub/FreeBSD/dir." -"sizes]." +"The current disk usage of FTP Distribution can be found at link:ftp://" +"ftp.FreeBSD.org/pub/FreeBSD/dir.sizes[ftp://ftp.FreeBSD.org/pub/FreeBSD/" +"dir.sizes]." msgstr "" #. type: Title === @@ -218,8 +218,8 @@ msgid "" "offering public FTP distributions. FTP access must be anonymous, and no " "upload/download ratios are allowed (a ridiculous thing anyway). Upload " "capability is not required (and _must_ never be allowed for the FreeBSD file " -"space). Also the FreeBSD archive should be available under the path [." -"filename]#/pub/FreeBSD#." +"space). Also the FreeBSD archive should be available under the path " +"[.filename]#/pub/FreeBSD#." msgstr "" #. type: Plain text @@ -232,8 +232,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/hubs/_index.adoc:139 msgid "" -"`/usr/libexec/ftpd`: FreeBSD's own ftpd can be used. Be sure to read man:" -"ftpd[8]." +"`/usr/libexec/ftpd`: FreeBSD's own ftpd can be used. Be sure to read " +"man:ftpd[8]." msgstr "" #. type: Plain text @@ -437,11 +437,11 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/hubs/_index.adoc:213 msgid "" -"Consult the documentation for rsync, which is also available at http://rsync." -"samba.org/[http://rsync.samba.org/], about the various options to be used " -"with rsync. If you sync the whole module (unlike subdirectories), be aware " -"that the module-directory (here \"FreeBSD\") will not be created, so you " -"cannot omit the target directory. Also you might want to set up a script " +"Consult the documentation for rsync, which is also available at http://" +"rsync.samba.org/[http://rsync.samba.org/], about the various options to be " +"used with rsync. If you sync the whole module (unlike subdirectories), be " +"aware that the module-directory (here \"FreeBSD\") will not be created, so " +"you cannot omit the target directory. Also you might want to set up a script " "framework that calls such a command via man:cron[8]." msgstr "" @@ -580,12 +580,12 @@ msgstr "" #. type: delimited block = 4 #: documentation/content/en/articles/hubs/_index.adoc:281 msgid "" -"Use man:crontab[1] to add the script to the appropriate user's man:" -"crontab[5]. This should be a different user than what your FTP daemon runs " -"as so that if file permissions inside your FTP area are not world-readable " -"those files cannot be accessed by anonymous FTP. This is used to \"stage\" " -"releases - making sure all of the official mirror sites have all of the " -"necessary release files on release day." +"Use man:crontab[1] to add the script to the appropriate user's " +"man:crontab[5]. This should be a different user than what your FTP daemon " +"runs as so that if file permissions inside your FTP area are not world-" +"readable those files cannot be accessed by anonymous FTP. This is used to " +"\"stage\" releases - making sure all of the official mirror sites have all " +"of the necessary release files on release day." msgstr "" #. type: Plain text @@ -648,13 +648,13 @@ msgid "" "described as __Tier-0__. Mirrors that mirror from these sites can be " "considered __Tier-1__, mirrors of __Tier-1__-mirrors, are __Tier-2__, etc. " "Official sites are encouraged to be of a low __tier__, but the lower the " -"tier the higher the requirements in terms as described in crossref:" -"hubs[mirror-requirements, Requirements for FreeBSD Mirrors]. Also access to " -"low-tier-mirrors may be restricted, and access to master sites is definitely " -"restricted. The __tier__-hierarchy is not reflected by DNS and generally " -"not documented anywhere except for the master sites. However, official " -"mirrors with low numbers like 1-4, are usually _Tier-1_ (this is just a " -"rough hint, and there is no rule)." +"tier the higher the requirements in terms as described in " +"crossref:hubs[mirror-requirements, Requirements for FreeBSD Mirrors]. Also " +"access to low-tier-mirrors may be restricted, and access to master sites is " +"definitely restricted. The __tier__-hierarchy is not reflected by DNS and " +"generally not documented anywhere except for the master sites. However, " +"official mirrors with low numbers like 1-4, are usually _Tier-1_ (this is " +"just a rough hint, and there is no rule)." msgstr "" #. type: Title === @@ -680,8 +680,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/hubs/_index.adoc:330 msgid "" -"If you have no special intentions or requirements, the statement in crossref:" -"hubs[mirror-where-where, Ok, but Where Should I get the Stuff Now?] " +"If you have no special intentions or requirements, the statement in " +"crossref:hubs[mirror-where-where, Ok, but Where Should I get the Stuff Now?] " "applies. This means:" msgstr "" @@ -734,8 +734,9 @@ msgid "" "and there are special policies for access. If you are already an _official_ " "mirror, this certainly helps you getting access. In any other case make " "sure your country really needs another mirror. If it already has three or " -"more, ask the \"zone administrator\" (mailto:hostmaster@CC.FreeBSD." -"org[hostmaster@CC.FreeBSD.org]) or {freebsd-hubs} first." +"more, ask the \"zone administrator\" " +"(mailto:hostmaster@CC.FreeBSD.org[hostmaster@CC.FreeBSD.org]) or {freebsd-" +"hubs} first." msgstr "" #. type: Plain text @@ -847,7 +848,8 @@ msgstr "" #: documentation/content/en/articles/hubs/_index.adoc:396 msgid "" "Furthermore, admins should be subscribed to the {freebsd-hubs}. See extref:" -"{handbook}[this link, eresources-mail] for details, how to subscribe." +"{handbook}eresources[this link, eresources-mail] for details, how to " +"subscribe." msgstr "" #. type: delimited block = 4 @@ -879,8 +881,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/hubs/_index.adoc:410 msgid "" -"Please contact the Cluster Administrators as documented at https://www." -"FreeBSD.org/administration/#t-clusteradm." +"Please contact the Cluster Administrators as documented at https://" +"www.FreeBSD.org/administration/#t-clusteradm." msgstr "" #. type: Title == @@ -905,10 +907,11 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/hubs/_index.adoc:420 msgid "" -"ftp.is.FreeBSD.org - mailto:hostmaster@is.FreeBSD.org[hostmaster@is.FreeBSD." -"org] - http://www.rhnet.is/status/draupnir/draupnir.html[ (Bandwidth)] " -"http://www.rhnet.is/status/ftp/ftp-notendur.html[(FTP processes)] http://www." -"rhnet.is/status/ftp/http-notendur.html[(HTTP processes)]" +"ftp.is.FreeBSD.org - " +"mailto:hostmaster@is.FreeBSD.org[hostmaster@is.FreeBSD.org] - http://" +"www.rhnet.is/status/draupnir/draupnir.html[ (Bandwidth)] http://www.rhnet.is/" +"status/ftp/ftp-notendur.html[(FTP processes)] http://www.rhnet.is/status/ftp/" +"http-notendur.html[(HTTP processes)]" msgstr "" #. type: Plain text diff --git a/documentation/content/en/articles/ipsec-must/_index.adoc b/documentation/content/en/articles/ipsec-must/_index.adoc index dbca759c6e..262ffef368 100644 --- a/documentation/content/en/articles/ipsec-must/_index.adoc +++ b/documentation/content/en/articles/ipsec-must/_index.adoc @@ -144,7 +144,7 @@ IPsec encrypts everything between two hosts. Most of the modern versions of FreeBSD have IPsec support in their base source. So you will need to include the `IPSEC` option in your kernel config and, after kernel rebuild and reinstall, configure IPsec connections using man:setkey[8] command. -A comprehensive guide on running IPsec on FreeBSD is provided in extref:{handbook}[FreeBSD Handbook, ipsec]. +A comprehensive guide on running IPsec on FreeBSD is provided in extref:{vpn-ipsec}[VPN over IPsec]. [[kernel]] == src/sys/i386/conf/KERNELNAME diff --git a/documentation/content/en/articles/ipsec-must/_index.po b/documentation/content/en/articles/ipsec-must/_index.po index 559dddbb99..8554361069 100644 --- a/documentation/content/en/articles/ipsec-must/_index.po +++ b/documentation/content/en/articles/ipsec-must/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2024-12-29 08:30-0500\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -100,11 +100,12 @@ msgstr "" #: documentation/content/en/articles/ipsec-must/_index.adoc:77 msgid "" "Ueli Maurer's \"Universal Statistical Test for Random Bit " -"Generators\"(https://web.archive.org/web/20011115002319/http://www.geocities." -"com/SiliconValley/Code/4704/universal.pdf[MUST]) quickly measures the " -"entropy of a sample. It uses a compression-like algorithm. crossref::ipsec-" -"must[code, Maurer's Universal Statistical Test (for block size8 bits)] for a " -"variant which measures successive (~quarter megabyte) chunks of a file." +"Generators\"(https://web.archive.org/web/20011115002319/http://" +"www.geocities.com/SiliconValley/Code/4704/universal.pdf[MUST]) quickly " +"measures the entropy of a sample. It uses a compression-like algorithm. " +"crossref::ipsec-must[code, Maurer's Universal Statistical Test (for block " +"size8 bits)] for a variant which measures successive (~quarter megabyte) " +"chunks of a file." msgstr "" #. type: Title === @@ -116,8 +117,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/ipsec-must/_index.adoc:84 msgid "" -"We also need a way to capture the raw network data. A program called man:" -"tcpdump[1] lets you do this, if you have enabled the _Berkeley Packet " +"We also need a way to capture the raw network data. A program called " +"man:tcpdump[1] lets you do this, if you have enabled the _Berkeley Packet " "Filter_ interface in your crossref::ipsec-must[kernel,src/sys/i386/conf/" "KERNELNAME]." msgstr "" @@ -249,8 +250,8 @@ msgstr "" #. type: delimited block = 4 #: documentation/content/en/articles/ipsec-must/_index.adoc:148 msgid "" -"A comprehensive guide on running IPsec on FreeBSD is provided in extref:" -"{handbook}[FreeBSD Handbook, ipsec]." +"A comprehensive guide on running IPsec on FreeBSD is provided in extref:{vpn-" +"ipsec}[VPN over IPsec]." msgstr "" #. type: Title == diff --git a/documentation/content/en/articles/leap-seconds/_index.adoc b/documentation/content/en/articles/leap-seconds/_index.adoc index d28629b005..55a1dfb5fc 100644 --- a/documentation/content/en/articles/leap-seconds/_index.adoc +++ b/documentation/content/en/articles/leap-seconds/_index.adoc @@ -56,7 +56,7 @@ Also see man:time2posix[3]. [[leapseconds-posix]] == Default Leap Second Handling on FreeBSD -The easiest way to handle leap seconds is with the POSIX time rules FreeBSD uses by default, combined with extref:{handbook}[NTP, network-ntp]. +The easiest way to handle leap seconds is with the POSIX time rules FreeBSD uses by default, combined with extref:{handbook}network-servers[NTP, network-ntp]. When man:ntpd[8] is running and the time is synchronized with upstream NTP servers that handle leap seconds correctly, the leap second will cause the system time to automatically repeat the last second of the day. No other adjustments are necessary. diff --git a/documentation/content/en/articles/leap-seconds/_index.po b/documentation/content/en/articles/leap-seconds/_index.po index ff08ec6a17..2e08f18b6f 100644 --- a/documentation/content/en/articles/leap-seconds/_index.po +++ b/documentation/content/en/articles/leap-seconds/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2022-02-01 09:21-0300\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -59,9 +59,9 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/leap-seconds/_index.adoc:52 msgid "" -"Leap seconds are announced by https://www.iers.org/IERS/EN/Home/home_node." -"html[IERS] on https://datacenter.iers.org/data/latestVersion/16_BULLETIN_C16." -"txt[Bulletin C]." +"Leap seconds are announced by https://www.iers.org/IERS/EN/Home/" +"home_node.html[IERS] on https://datacenter.iers.org/data/latestVersion/" +"16_BULLETIN_C16.txt[Bulletin C]." msgstr "" #. type: Plain text @@ -81,19 +81,19 @@ msgstr "" #: documentation/content/en/articles/leap-seconds/_index.adoc:62 msgid "" "The easiest way to handle leap seconds is with the POSIX time rules FreeBSD " -"uses by default, combined with extref:{handbook}[NTP, network-ntp]. When " -"man:ntpd[8] is running and the time is synchronized with upstream NTP " -"servers that handle leap seconds correctly, the leap second will cause the " -"system time to automatically repeat the last second of the day. No other " -"adjustments are necessary." +"uses by default, combined with extref:{handbook}network-servers[NTP, network-" +"ntp]. When man:ntpd[8] is running and the time is synchronized with " +"upstream NTP servers that handle leap seconds correctly, the leap second " +"will cause the system time to automatically repeat the last second of the " +"day. No other adjustments are necessary." msgstr "" #. type: Plain text #: documentation/content/en/articles/leap-seconds/_index.adoc:64 msgid "" -"If the upstream NTP servers do not handle leap seconds correctly, man:" -"ntpd[8] will step the time by one second after the errant upstream server " -"has noticed and stepped itself." +"If the upstream NTP servers do not handle leap seconds correctly, " +"man:ntpd[8] will step the time by one second after the errant upstream " +"server has noticed and stepped itself." msgstr "" #. type: Plain text diff --git a/documentation/content/en/articles/linux-emulation/_index.adoc b/documentation/content/en/articles/linux-emulation/_index.adoc index a252df5f54..f225c23fe4 100644 --- a/documentation/content/en/articles/linux-emulation/_index.adoc +++ b/documentation/content/en/articles/linux-emulation/_index.adoc @@ -1008,7 +1008,7 @@ Newer glibc in a case of 2.6 kernel uses `clone` to implement man:fork[2] and ma The locking is implemented to be per-subsystem because we do not expect a lot of contention on these. There are two locks: `emul_lock` used to protect manipulating of `linux_emuldata` and `emul_shared_lock` used to manipulate `linux_emuldata_shared`. The `emul_lock` is a nonsleepable blocking mutex while `emul_shared_lock` is a sleepable blocking `sx_lock`. -Due to of the per-subsystem locking we can coalesce some locks and that is why the em find offers the non-locking access. +Due to of the per-subsystem locking we can coalesce some locks and that is why the em_find offers the non-locking access. [[tls]] === TLS @@ -1431,6 +1431,6 @@ I would like to thank all those people for their advice, code reviews and genera [[literatures]] == Literatures -. Marshall Kirk McKusick - George V. Nevile-Neil. Design and Implementation of the FreeBSD operating system. Addison-Wesley, 2005. +. Marshall Kirk McKusick - George V. Neville-Neil. Design and Implementation of the FreeBSD operating system. Addison-Wesley, 2005. . https://tldp.org[https://tldp.org] . https://www.kernel.org[https://www.kernel.org] diff --git a/documentation/content/en/articles/linux-emulation/_index.po b/documentation/content/en/articles/linux-emulation/_index.po index 4483660ee5..eaea7248db 100644 --- a/documentation/content/en/articles/linux-emulation/_index.po +++ b/documentation/content/en/articles/linux-emulation/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2024-01-17 20:35-0300\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -663,8 +663,8 @@ msgstr "" msgid "" "In the 2.6 version, the Linux(R) operating system redefined some of the " "traditional UNIX(R) primitives, notably PID, TID and thread. PID is defined " -"not to be unique for every process, so for some processes (threads) man:" -"getppid[2] returns the same value. Unique identification of process is " +"not to be unique for every process, so for some processes (threads) " +"man:getppid[2] returns the same value. Unique identification of process is " "provided by TID. This is because _NPTL_ (New POSIX(R) Thread Library) " "defines threads to be normal processes (so called 1:1 threading). Spawning " "a new process in Linux(R) 2.6 happens using the `clone` syscall (fork " @@ -920,8 +920,8 @@ msgstr "" msgid "" "The same goes with the UNIX(R) API. Most programs can live with a very " "limited set of syscalls working. Those syscalls tend to be the oldest ones " -"(man:read[2]/man:write[2], man:fork[2] family, man:signal[3] handling, man:" -"exit[3], man:socket[2] API) hence it is easy to emulate because their " +"(man:read[2]/man:write[2], man:fork[2] family, man:signal[3] handling, " +"man:exit[3], man:socket[2] API) hence it is easy to emulate because their " "semantics is shared among all UNIX(R)es, which exist todays." msgstr "" @@ -1099,8 +1099,8 @@ msgid "" "even something like a spin-mutex is deprecated. Using the refcount " "interface for structures, where a mutex is already used is often wrong since " "we should probably close the reference counter in some already protected " -"paths. A manpage discussing refcount does not exist currently, just check [." -"filename]#sys/refcount.h# for an overview of the existing API." +"paths. A manpage discussing refcount does not exist currently, just check " +"[.filename]#sys/refcount.h# for an overview of the existing API." msgstr "" #. type: Title ===== @@ -1438,11 +1438,11 @@ msgstr "" msgid "" "The man:namei[9] routine is a central entry point to pathname lookup and " "translation. It traverses the path point by point from the starting point " -"to the end point using lookup function, which is internal to VFS. The man:" -"namei[9] syscall can cope with symlinks, absolute and relative paths. When " -"a path is looked up using man:namei[9] it is inputed to the name cache. This " -"behavior can be suppressed. This routine is used all over the kernel and " -"its performance is very critical." +"to the end point using lookup function, which is internal to VFS. The " +"man:namei[9] syscall can cope with symlinks, absolute and relative paths. " +"When a path is looked up using man:namei[9] it is inputed to the name cache. " +"This behavior can be suppressed. This routine is used all over the kernel " +"and its performance is very critical." msgstr "" #. type: Title ===== @@ -1643,9 +1643,9 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/linux-emulation/_index.adoc:708 msgid "" -"From [.filename]#syscalls.master# a script generates three files: [." -"filename]#linux_syscall.h#, [.filename]#linux_proto.h# and [." -"filename]#linux_sysent.c#. The [.filename]#linux_syscall.h# contains " +"From [.filename]#syscalls.master# a script generates three files: " +"[.filename]#linux_syscall.h#, [.filename]#linux_proto.h# and " +"[.filename]#linux_sysent.c#. The [.filename]#linux_syscall.h# contains " "definitions of syscall names and their numerical value, e.g.:" msgstr "" @@ -1808,8 +1808,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/linux-emulation/_index.adoc:788 msgid "" -"Linux(R) emulation in FreeBSD implements the man:ptrace[2] facility in [." -"filename]#linux_ptrace.c#. The routines for converting registers between " +"Linux(R) emulation in FreeBSD implements the man:ptrace[2] facility in " +"[.filename]#linux_ptrace.c#. The routines for converting registers between " "Linux(R) and FreeBSD and the actual man:ptrace[2] syscall emulation " "syscall. The syscall is a long switch block that implements its counterpart " "in FreeBSD for every man:ptrace[2] command. The man:ptrace[2] commands are " @@ -1915,8 +1915,8 @@ msgid "" "especially the 2.6 emulation does not work with it but this does not cause " "any problem, as the linux-base in ports probably do not support A.OUT " "binaries at all. This support will probably be removed in future. Most of " -"the stuff necessary for loading Linux(R) A.OUT binaries is in [." -"filename]#imgact_linux.c# file." +"the stuff necessary for loading Linux(R) A.OUT binaries is in " +"[.filename]#imgact_linux.c# file." msgstr "" #. type: Title == @@ -1999,13 +1999,13 @@ msgstr "" #: documentation/content/en/articles/linux-emulation/_index.adoc:883 msgid "" "The Linux(R) emulation layer in FreeBSD supports runtime setting of the " -"emulated version. This is done via man:sysctl[8], namely `compat.linux." -"osrelease`. Setting this man:sysctl[8] affects runtime behavior of the " -"emulation layer. When set to 2.6.x it sets the value of `linux_use_linux26` " -"while setting to something else keeps it unset. This variable (plus per-" -"prison variables of the very same kind) determines whether 2.6 " -"infrastructure (mainly PID mangling) is used in the code or not. The " -"version setting is done system-wide and this affects all Linux(R) " +"emulated version. This is done via man:sysctl[8], namely " +"`compat.linux.osrelease`. Setting this man:sysctl[8] affects runtime " +"behavior of the emulation layer. When set to 2.6.x it sets the value of " +"`linux_use_linux26` while setting to something else keeps it unset. This " +"variable (plus per-prison variables of the very same kind) determines " +"whether 2.6 infrastructure (mainly PID mangling) is used in the code or " +"not. The version setting is done system-wide and this affects all Linux(R) " "processes. The man:sysctl[8] should not be changed when running any " "Linux(R) binary as it might harm things." msgstr "" @@ -2245,18 +2245,18 @@ msgid "" "the functionality later in the code. At this point we copy out the PID to " "the address specified by `parent_tidptr`. The setting of process stack is " "done by simply rewriting thread frame `%esp` register (`%rsp` on amd64). " -"Next part is setting up TLS for the newly created process. After this man:" -"vfork[2] semantics might be emulated and finally the newly created process " -"is put on a run queue and copying out its PID to the parent process via " -"`clone` return value is done." +"Next part is setting up TLS for the newly created process. After this " +"man:vfork[2] semantics might be emulated and finally the newly created " +"process is put on a run queue and copying out its PID to the parent process " +"via `clone` return value is done." msgstr "" #. type: Plain text #: documentation/content/en/articles/linux-emulation/_index.adoc:1004 msgid "" -"The `clone` syscall is able and in fact is used for emulating classic man:" -"fork[2] and man:vfork[2] syscalls. Newer glibc in a case of 2.6 kernel uses " -"`clone` to implement man:fork[2] and man:vfork[2] syscalls." +"The `clone` syscall is able and in fact is used for emulating classic " +"man:fork[2] and man:vfork[2] syscalls. Newer glibc in a case of 2.6 kernel " +"uses `clone` to implement man:fork[2] and man:vfork[2] syscalls." msgstr "" #. type: Title ==== @@ -2274,7 +2274,7 @@ msgid "" "manipulate `linux_emuldata_shared`. The `emul_lock` is a nonsleepable " "blocking mutex while `emul_shared_lock` is a sleepable blocking `sx_lock`. " "Due to of the per-subsystem locking we can coalesce some locks and that is " -"why the em find offers the non-locking access." +"why the em_find offers the non-locking access." msgstr "" #. type: Title === @@ -2303,30 +2303,30 @@ msgid "" "their own data. Sometimes there is a need for process-wide data specific to " "a given thread. Imagine a name of the thread in execution or something like " "that. The traditional UNIX(R) threading API, pthreads provides a way to do " -"it via man:pthread_key_create[3], man:pthread_setspecific[3] and man:" -"pthread_getspecific[3] where a thread can create a key to the thread local " -"data and using man:pthread_getspecific[3] or man:pthread_getspecific[3] to " -"manipulate those data. You can easily see that this is not the most " -"comfortable way this could be accomplished. So various producers of C/C++ " -"compilers introduced a better way. They defined a new modifier keyword " -"thread that specifies that a variable is thread specific. A new method of " -"accessing such variables was developed as well (at least on i386). The " -"pthreads method tends to be implemented in userspace as a trivial lookup " -"table. The performance of such a solution is not very good. So the new " -"method uses (on i386) segment registers to address a segment, where TLS area " -"is stored so the actual accessing of a thread variable is just appending the " -"segment register to the address thus addressing via it. The segment " -"registers are usually `%gs` and `%fs` acting like segment selectors. Every " -"thread has its own area where the thread local data are stored and the " -"segment must be loaded on every context switch. This method is very fast " -"and used almost exclusively in the whole i386 UNIX(R) world. Both FreeBSD " -"and Linux(R) implement this approach and it yields very good results. The " -"only drawback is the need to reload the segment on every context switch " -"which can slowdown context switches. FreeBSD tries to avoid this overhead " -"by using only 1 segment descriptor for this while Linux(R) uses 3. " -"Interesting thing is that almost nothing uses more than 1 descriptor (only " -"Wine seems to use 2) so Linux(R) pays this unnecessary price for context " -"switches." +"it via man:pthread_key_create[3], man:pthread_setspecific[3] and " +"man:pthread_getspecific[3] where a thread can create a key to the thread " +"local data and using man:pthread_getspecific[3] or " +"man:pthread_getspecific[3] to manipulate those data. You can easily see " +"that this is not the most comfortable way this could be accomplished. So " +"various producers of C/C++ compilers introduced a better way. They defined " +"a new modifier keyword thread that specifies that a variable is thread " +"specific. A new method of accessing such variables was developed as well " +"(at least on i386). The pthreads method tends to be implemented in " +"userspace as a trivial lookup table. The performance of such a solution is " +"not very good. So the new method uses (on i386) segment registers to " +"address a segment, where TLS area is stored so the actual accessing of a " +"thread variable is just appending the segment register to the address thus " +"addressing via it. The segment registers are usually `%gs` and `%fs` acting " +"like segment selectors. Every thread has its own area where the thread " +"local data are stored and the segment must be loaded on every context " +"switch. This method is very fast and used almost exclusively in the whole " +"i386 UNIX(R) world. Both FreeBSD and Linux(R) implement this approach and " +"it yields very good results. The only drawback is the need to reload the " +"segment on every context switch which can slowdown context switches. " +"FreeBSD tries to avoid this overhead by using only 1 segment descriptor for " +"this while Linux(R) uses 3. Interesting thing is that almost nothing uses " +"more than 1 descriptor (only Wine seems to use 2) so Linux(R) pays this " +"unnecessary price for context switches." msgstr "" #. type: Title ==== @@ -2843,8 +2843,8 @@ msgid "" "The `FUTEX_WAKE_OP` operation is quite complicated. First we obtain two " "futexes at addresses `uaddr` and `uaddr2` then we perform the atomic " "operation using `val3` and `uaddr2`. Then `val` waiters on the first futex " -"is woken up and if the atomic operation condition holds we wake up `val2` (i." -"e. `timeout`) waiter on the second futex." +"is woken up and if the atomic operation condition holds we wake up `val2` " +"(i.e. `timeout`) waiter on the second futex." msgstr "" #. type: Title ===== @@ -3215,8 +3215,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/linux-emulation/_index.adoc:1435 msgid "" -"Marshall Kirk McKusick - George V. Nevile-Neil. Design and Implementation of " -"the FreeBSD operating system. Addison-Wesley, 2005." +"Marshall Kirk McKusick - George V. Neville-Neil. Design and Implementation " +"of the FreeBSD operating system. Addison-Wesley, 2005." msgstr "" #. type: Plain text diff --git a/documentation/content/en/articles/linux-users/_index.adoc b/documentation/content/en/articles/linux-users/_index.adoc index 50a0c2d54f..343b523c6b 100644 --- a/documentation/content/en/articles/linux-users/_index.adoc +++ b/documentation/content/en/articles/linux-users/_index.adoc @@ -54,7 +54,7 @@ toc::[] This document highlights some of the technical differences between FreeBSD and Linux(R) so that intermediate to advanced Linux(R) users can quickly familiarize themselves with the basics of FreeBSD. This document assumes that FreeBSD is already installed. -Refer to the extref:{handbook}[Installing FreeBSD, bsdinstall] chapter of the FreeBSD Handbook for help with the installation process. +Refer to the extref:{handbook}bsdinstall[Installing FreeBSD, bsdinstall] chapter of the FreeBSD Handbook for help with the installation process. [[shells]] == Default Shell @@ -66,7 +66,7 @@ The root shell is man:tcsh[1] by default on FreeBSD 13 and earlier and man:sh[1] man:sh[1] is very similar to Bash but with a much smaller feature-set. Generally shell scripts written for man:sh[1] will run in Bash, but the reverse is not always true. -However, Bash and other shells are available for installation using the FreeBSD extref:{handbook}[Packages and Ports Collection, ports]. +However, Bash and other shells are available for installation using the FreeBSD extref:{handbook}ports[Packages and Ports Collection, ports]. After installing another shell, use man:chsh[1] to change a user's default shell. It is recommended that the `root` user's default shell remain unchanged since shells which are not included in the base distribution are installed to [.filename]#/usr/local/bin#. @@ -106,7 +106,7 @@ For example, the following command installs Apache 2.4: # pkg install apache24 .... -For more information on packages refer to section 5.4 of the FreeBSD Handbook: extref:{handbook}[Using pkgng for Binary Package Management, pkgng-intro]. +For more information on packages refer to section 4.4 of the FreeBSD Handbook: extref:{handbook}ports[Using pkgng for Binary Package Management, pkgng-intro]. [[ports]] === Ports @@ -115,7 +115,7 @@ The FreeBSD Ports Collection is a framework of [.filename]#Makefiles# and patche When installing a port, the system will fetch the source code, apply any required patches, compile the code, and install the application and any required dependencies. The Ports Collection, sometimes referred to as the ports tree, can be installed to [.filename]#/usr/ports# using link:{handbook}mirrors/#git[Git]. -Detailed instructions for installing the Ports Collection can be found in extref:{handbook}[section 4.5.1, ports-using-installation-methods] of the FreeBSD Handbook. +Detailed instructions for installing the Ports Collection can be found in extref:{handbook}ports[section 4.5.1, ports-using-installation-methods] of the FreeBSD Handbook. To compile a port, change to the port's directory and start the build process. The following example installs Apache 2.4 from the Ports Collection: @@ -134,7 +134,7 @@ This example specifies that the mod_ldap module should also be installed: # make WITH_LDAP="YES" install clean .... -Refer to extref:{handbook}[Using the Ports Collection, ports-using] for more information. +Refer to extref:{handbook}ports[Using the Ports Collection, ports-using] for more information. [[startup]] == System Startup @@ -149,7 +149,7 @@ The scripts found in [.filename]#/etc/rc.d/# are for applications that are part The scripts in [.filename]#/usr/local/etc/rc.d/# are for user-installed applications such as Apache and Squid. Since FreeBSD is developed as a complete operating system, user-installed applications are not considered to be part of the "base" system. -User-installed applications are generally installed using extref:{handbook}[Packages or Ports, ports-using]. +User-installed applications are generally installed using extref:{handbook}ports[Packages or Ports, ports-using]. In order to keep them separate from the base system, user-installed applications are installed under [.filename]#/usr/local/#. Therefore, user-installed binaries reside in [.filename]#/usr/local/bin/#, configuration files are in [.filename]#/usr/local/etc/#, and so on. @@ -232,9 +232,9 @@ ifconfig_em0="DHCP" FreeBSD does not use Linux(R) IPTABLES for its firewall. Instead, FreeBSD offers a choice of three kernel level firewalls: -* extref:{handbook}[PF, firewalls-pf] -* extref:{handbook}[IPFILTER, firewalls-ipf] -* extref:{handbook}[IPFW, firewalls-ipfw] +* extref:{handbook}firewalls[PF, firewalls-pf] +* extref:{handbook}firewalls[IPFILTER, firewalls-ipf] +* extref:{handbook}firewalls[IPFW, firewalls-ipfw] PF is developed by the OpenBSD project and ported to FreeBSD. PF was created as a replacement for IPFILTER and its syntax is similar to that of IPFILTER. @@ -291,7 +291,7 @@ When using man:cron[8] to schedule updates, use `freebsd-update cron` in the man ==== -For more information on source and binary updates, refer to extref:{handbook}[the chapter on updating, updating-upgrading-freebsdupdate] in the FreeBSD Handbook. +For more information on source and binary updates, refer to extref:{handbook}cutting-edge[the chapter on updating, updating-upgrading-freebsdupdate] in the FreeBSD Handbook. [[procfs]] == procfs: Gone But Not Forgotten diff --git a/documentation/content/en/articles/linux-users/_index.po b/documentation/content/en/articles/linux-users/_index.po index 5a22174032..30d87a50b2 100644 --- a/documentation/content/en/articles/linux-users/_index.po +++ b/documentation/content/en/articles/linux-users/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2024-09-14 14:59-0300\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -69,8 +69,8 @@ msgstr "" #: documentation/content/en/articles/linux-users/_index.adoc:58 msgid "" "This document assumes that FreeBSD is already installed. Refer to the " -"extref:{handbook}[Installing FreeBSD, bsdinstall] chapter of the FreeBSD " -"Handbook for help with the installation process." +"extref:{handbook}bsdinstall[Installing FreeBSD, bsdinstall] chapter of the " +"FreeBSD Handbook for help with the installation process." msgstr "" #. type: Title == @@ -95,7 +95,7 @@ msgstr "" #: documentation/content/en/articles/linux-users/_index.adoc:70 msgid "" "However, Bash and other shells are available for installation using the " -"FreeBSD extref:{handbook}[Packages and Ports Collection, ports]." +"FreeBSD extref:{handbook}ports[Packages and Ports Collection, ports]." msgstr "" #. type: Plain text @@ -186,8 +186,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/linux-users/_index.adoc:103 msgid "" -"Packages are pre-compiled applications, the FreeBSD equivalents of [." -"filename]#.deb# files on Debian/Ubuntu based systems and [.filename]#.rpm# " +"Packages are pre-compiled applications, the FreeBSD equivalents of " +"[.filename]#.deb# files on Debian/Ubuntu based systems and [.filename]#.rpm# " "files on Red Hat/Fedora based systems. Packages are installed using `pkg`. " "For example, the following command installs Apache 2.4:" msgstr "" @@ -201,9 +201,9 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/linux-users/_index.adoc:110 msgid "" -"For more information on packages refer to section 5.4 of the FreeBSD " -"Handbook: extref:{handbook}[Using pkgng for Binary Package Management, pkgng-" -"intro]." +"For more information on packages refer to section 4.4 of the FreeBSD " +"Handbook: extref:{handbook}ports[Using pkgng for Binary Package Management, " +"pkgng-intro]." msgstr "" #. type: Plain text @@ -222,8 +222,8 @@ msgid "" "The Ports Collection, sometimes referred to as the ports tree, can be " "installed to [.filename]#/usr/ports# using link:{handbook}mirrors/" "#git[Git]. Detailed instructions for installing the Ports Collection can be " -"found in extref:{handbook}[section 4.5.1, ports-using-installation-methods] " -"of the FreeBSD Handbook." +"found in extref:{handbook}ports[section 4.5.1, ports-using-installation-" +"methods] of the FreeBSD Handbook." msgstr "" #. type: Plain text @@ -260,8 +260,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/linux-users/_index.adoc:138 msgid "" -"Refer to extref:{handbook}[Using the Ports Collection, ports-using] for more " -"information." +"Refer to extref:{handbook}ports[Using the Ports Collection, ports-using] for " +"more information." msgstr "" #. type: Title == @@ -276,22 +276,22 @@ msgid "" "Many Linux(R) distributions use the SysV init system, whereas FreeBSD uses " "the traditional BSD-style man:init[8]. Under the BSD-style man:init[8], " "there are no run-levels and [.filename]#/etc/inittab# does not exist. " -"Instead, startup is controlled by man:rc[8] scripts. At system boot, [." -"filename]#/etc/rc# reads [.filename]#/etc/rc.conf# and [.filename]#/etc/" +"Instead, startup is controlled by man:rc[8] scripts. At system boot, " +"[.filename]#/etc/rc# reads [.filename]#/etc/rc.conf# and [.filename]#/etc/" "defaults/rc.conf# to determine which services are to be started. The " "specified services are then started by running the corresponding service " "initialization scripts located in [.filename]#/etc/rc.d/# and [.filename]#/" -"usr/local/etc/rc.d/#. These scripts are similar to the scripts located in [." -"filename]#/etc/init.d/# on Linux(R) systems." +"usr/local/etc/rc.d/#. These scripts are similar to the scripts located in " +"[.filename]#/etc/init.d/# on Linux(R) systems." msgstr "" #. type: Plain text #: documentation/content/en/articles/linux-users/_index.adoc:150 msgid "" "The scripts found in [.filename]#/etc/rc.d/# are for applications that are " -"part of the \"base\" system, such as man:cron[8], man:sshd[8], and man:" -"syslog[3]. The scripts in [.filename]#/usr/local/etc/rc.d/# are for user-" -"installed applications such as Apache and Squid." +"part of the \"base\" system, such as man:cron[8], man:sshd[8], and " +"man:syslog[3]. The scripts in [.filename]#/usr/local/etc/rc.d/# are for " +"user-installed applications such as Apache and Squid." msgstr "" #. type: Plain text @@ -300,23 +300,23 @@ msgid "" "Since FreeBSD is developed as a complete operating system, user-installed " "applications are not considered to be part of the \"base\" system. User-" "installed applications are generally installed using extref:{handbook}" -"[Packages or Ports, ports-using]. In order to keep them separate from the " -"base system, user-installed applications are installed under [.filename]#/" -"usr/local/#. Therefore, user-installed binaries reside in [.filename]#/usr/" -"local/bin/#, configuration files are in [.filename]#/usr/local/etc/#, and so " -"on." +"ports[Packages or Ports, ports-using]. In order to keep them separate from " +"the base system, user-installed applications are installed under " +"[.filename]#/usr/local/#. Therefore, user-installed binaries reside in " +"[.filename]#/usr/local/bin/#, configuration files are in [.filename]#/usr/" +"local/etc/#, and so on." msgstr "" #. type: Plain text #: documentation/content/en/articles/linux-users/_index.adoc:160 msgid "" "Services are enabled by adding an entry for the service in [.filename]#/etc/" -"rc.conf#. The system defaults are found in [.filename]#/etc/defaults/rc." -"conf# and these default settings are overridden by settings in [.filename]#/" -"etc/rc.conf#. Refer to man:rc.conf[5] for more information about the " -"available entries. When installing additional applications, review the " -"application's install message to determine how to enable any associated " -"services." +"rc.conf#. The system defaults are found in [.filename]#/etc/defaults/" +"rc.conf# and these default settings are overridden by settings in " +"[.filename]#/etc/rc.conf#. Refer to man:rc.conf[5] for more information " +"about the available entries. When installing additional applications, " +"review the application's install message to determine how to enable any " +"associated services." msgstr "" #. type: Plain text @@ -403,8 +403,8 @@ msgstr "" #: documentation/content/en/articles/linux-users/_index.adoc:213 msgid "" "An IP address can be assigned to an interface using man:ifconfig[8]. To " -"remain persistent across reboots, the IP configuration must be included in [." -"filename]#/etc/rc.conf#. The following [.filename]#/etc/rc.conf# entries " +"remain persistent across reboots, the IP configuration must be included in " +"[.filename]#/etc/rc.conf#. The following [.filename]#/etc/rc.conf# entries " "specify the hostname, IP address, and default gateway:" msgstr "" @@ -445,17 +445,17 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/linux-users/_index.adoc:236 -msgid "extref:{handbook}[PF, firewalls-pf]" +msgid "extref:{handbook}firewalls[PF, firewalls-pf]" msgstr "" #. type: Plain text #: documentation/content/en/articles/linux-users/_index.adoc:237 -msgid "extref:{handbook}[IPFILTER, firewalls-ipf]" +msgid "extref:{handbook}firewalls[IPFILTER, firewalls-ipf]" msgstr "" #. type: Plain text #: documentation/content/en/articles/linux-users/_index.adoc:238 -msgid "extref:{handbook}[IPFW, firewalls-ipfw]" +msgid "extref:{handbook}firewalls[IPFW, firewalls-ipfw]" msgstr "" #. type: Plain text @@ -564,8 +564,8 @@ msgstr "" #: documentation/content/en/articles/linux-users/_index.adoc:295 msgid "" "For more information on source and binary updates, refer to extref:{handbook}" -"[the chapter on updating, updating-upgrading-freebsdupdate] in the FreeBSD " -"Handbook." +"cutting-edge[the chapter on updating, updating-upgrading-freebsdupdate] in " +"the FreeBSD Handbook." msgstr "" #. type: Title == @@ -578,8 +578,8 @@ msgstr "" #: documentation/content/en/articles/linux-users/_index.adoc:301 msgid "" "In some Linux(R) distributions, one could look at [.filename]#/proc/sys/net/" -"ipv4/ip_forward# to determine if IP forwarding is enabled. In FreeBSD, man:" -"sysctl[8] is instead used to view this and other system settings." +"ipv4/ip_forward# to determine if IP forwarding is enabled. In FreeBSD, " +"man:sysctl[8] is instead used to view this and other system settings." msgstr "" #. type: delimited block = 4 diff --git a/documentation/content/en/articles/mailing-list-faq/_index.adoc b/documentation/content/en/articles/mailing-list-faq/_index.adoc index ab708fc0e4..64595b6bb0 100644 --- a/documentation/content/en/articles/mailing-list-faq/_index.adoc +++ b/documentation/content/en/articles/mailing-list-faq/_index.adoc @@ -43,8 +43,8 @@ Abstract This is the FAQ for the FreeBSD mailing lists. If you are interested in helping with this project, send email to the {freebsd-doc}. -The latest version of this document is always available from the link:.[FreeBSD World Wide Web server]. -It may also be downloaded as one large link:.[HTML] file with HTTP or as plain text, PostScript, PDF, etc. from the https://download.freebsd.org/doc/[FreeBSD FTP server]. +The latest version of this document is always available from the extref:{mailing-list-faq}[FreeBSD World Wide Web server]. +It may also be downloaded as one large extref:{mailing-list-faq}[HTML] file with HTTP or as plain text, PostScript, PDF, etc. from the https://download.freebsd.org/doc/[FreeBSD FTP server]. You may also want to link:https://www.FreeBSD.org/search/[Search the FAQ]. ''' diff --git a/documentation/content/en/articles/mailing-list-faq/_index.po b/documentation/content/en/articles/mailing-list-faq/_index.po index 1970b15513..5bd08219ad 100644 --- a/documentation/content/en/articles/mailing-list-faq/_index.po +++ b/documentation/content/en/articles/mailing-list-faq/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2025-05-01 19:57-0300\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -39,11 +39,11 @@ msgstr "" msgid "" "This is the FAQ for the FreeBSD mailing lists. If you are interested in " "helping with this project, send email to the {freebsd-doc}. The latest " -"version of this document is always available from the link:.[FreeBSD World " -"Wide Web server]. It may also be downloaded as one large link:.[HTML] file " -"with HTTP or as plain text, PostScript, PDF, etc. from the https://" -"download.freebsd.org/doc/[FreeBSD FTP server]. You may also want to " -"link:https://www.FreeBSD.org/search/[Search the FAQ]." +"version of this document is always available from the extref:{mailing-list-" +"faq}[FreeBSD World Wide Web server]. It may also be downloaded as one large " +"extref:{mailing-list-faq}[HTML] file with HTTP or as plain text, PostScript, " +"PDF, etc. from the https://download.freebsd.org/doc/[FreeBSD FTP server]. " +"You may also want to link:https://www.FreeBSD.org/search/[Search the FAQ]." msgstr "" #. type: Plain text diff --git a/documentation/content/en/articles/pgpkeys/_index.adoc b/documentation/content/en/articles/pgpkeys/_index.adoc index 51baa8be03..8fd6cd8eff 100644 --- a/documentation/content/en/articles/pgpkeys/_index.adoc +++ b/documentation/content/en/articles/pgpkeys/_index.adoc @@ -474,6 +474,9 @@ include::{include-path}kgalazka.key[] === `{avg}` include::{include-path}avg.key[] +=== `{tiga}` +include::{include-path}tiga.key[] + === `{beat}` include::{include-path}beat.key[] @@ -879,6 +882,9 @@ include::{include-path}christos.key[] === `{marino}` include::{include-path}marino.key[] +=== `{emaste}` +include::{include-path}emaste.key[] + === `{cherry}` include::{include-path}cherry.key[] @@ -1077,6 +1083,9 @@ include::{include-path}jdp.key[] === `{krion}` include::{include-path}krion.key[] +=== `{vladlen}` +include::{include-path}vladlen.key[] + === `{sepotvin}` include::{include-path}sepotvin.key[] @@ -1461,6 +1470,9 @@ include::{include-path}emax.key[] === `{oshogbo}` include::{include-path}oshogbo.key[] +=== `{andy}` +include::{include-path}andy.key[] + === `{riggs}` include::{include-path}riggs.key[] diff --git a/documentation/content/en/articles/pgpkeys/_index.po b/documentation/content/en/articles/pgpkeys/_index.po index 52d62342bf..2ff91facbc 100644 --- a/documentation/content/en/articles/pgpkeys/_index.po +++ b/documentation/content/en/articles/pgpkeys/_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-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -87,7 +87,7 @@ msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:78 -#: documentation/content/en/articles/pgpkeys/_index.adoc:645 +#: documentation/content/en/articles/pgpkeys/_index.adoc:648 #, no-wrap msgid "`{allanjude}`" msgstr "" @@ -101,7 +101,7 @@ msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:84 -#: documentation/content/en/articles/pgpkeys/_index.adoc:1248 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1257 #, no-wrap msgid "`{glebius}`" msgstr "" @@ -114,7 +114,7 @@ msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:90 -#: documentation/content/en/articles/pgpkeys/_index.adoc:597 +#: documentation/content/en/articles/pgpkeys/_index.adoc:600 #, no-wrap msgid "`{lwhsu}`" msgstr "" @@ -869,2117 +869,2153 @@ msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:477 #, no-wrap -msgid "`{beat}`" +msgid "`{tiga}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:480 #, no-wrap -msgid "`{sjg}`" +msgid "`{beat}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:483 #, no-wrap -msgid "`{gibbs}`" +msgid "`{sjg}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:486 #, no-wrap -msgid "`{pfg}`" +msgid "`{gibbs}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:489 #, no-wrap -msgid "`{girgen}`" +msgid "`{pfg}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:492 #, no-wrap -msgid "`{eugen}`" +msgid "`{girgen}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:495 #, no-wrap -msgid "`{pgollucci}`" +msgid "`{eugen}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:498 #, no-wrap -msgid "`{trociny}`" +msgid "`{pgollucci}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:501 #, no-wrap -msgid "`{dmgk}`" +msgid "`{trociny}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:504 #, no-wrap -msgid "`{daichi}`" +msgid "`{dmgk}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:507 #, no-wrap -msgid "`{grehan}`" +msgid "`{daichi}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:510 #, no-wrap -msgid "`{jamie}`" +msgid "`{grehan}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:513 #, no-wrap -msgid "`{adridg}`" +msgid "`{jamie}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:516 #, no-wrap -msgid "`{wg}`" +msgid "`{adridg}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:519 #, no-wrap -msgid "`{bar}`" +msgid "`{wg}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:522 #, no-wrap -msgid "`{jmg}`" +msgid "`{bar}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:525 #, no-wrap -msgid "`{mjg}`" +msgid "`{jmg}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:528 #, no-wrap -msgid "`{jhale}`" +msgid "`{mjg}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:531 #, no-wrap -msgid "`{jah}`" +msgid "`{jhale}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:534 #, no-wrap -msgid "`{dannyboy}`" +msgid "`{jah}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:537 #, no-wrap -msgid "`{dhartmei}`" +msgid "`{dannyboy}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:540 #, no-wrap -msgid "`{ohauer}`" +msgid "`{dhartmei}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:543 #, no-wrap -msgid "`{ehaupt}`" +msgid "`{ohauer}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:546 #, no-wrap -msgid "`{jhay}`" +msgid "`{ehaupt}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:549 #, no-wrap -msgid "`{bhd}`" +msgid "`{jhay}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:552 #, no-wrap -msgid "`{sheldonh}`" +msgid "`{bhd}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:555 #, no-wrap -msgid "`{mikeh}`" +msgid "`{sheldonh}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:558 #, no-wrap -msgid "`{mheinen}`" +msgid "`{mikeh}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:561 #, no-wrap -msgid "`{niels}`" +msgid "`{mheinen}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:564 #, no-wrap -msgid "`{ghelmer}`" +msgid "`{niels}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:567 #, no-wrap -msgid "`{mux}`" +msgid "`{ghelmer}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:570 #, no-wrap -msgid "`{wen}`" +msgid "`{mux}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:573 #, no-wrap -msgid "`{dhn}`" +msgid "`{wen}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:576 #, no-wrap -msgid "`{jhibbits}`" +msgid "`{dhn}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:579 #, no-wrap -msgid "`{jhixson}`" +msgid "`{jhibbits}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:582 #, no-wrap -msgid "`{pho}`" +msgid "`{jhixson}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:585 #, no-wrap -msgid "`{oh}`" +msgid "`{pho}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:588 #, no-wrap -msgid "`{mhorne}`" +msgid "`{oh}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:591 #, no-wrap -msgid "`{bhughes}`" +msgid "`{mhorne}`" msgstr "" #. type: Title === #: documentation/content/en/articles/pgpkeys/_index.adoc:594 #, no-wrap +msgid "`{bhughes}`" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/pgpkeys/_index.adoc:597 +#, no-wrap msgid "`{sunpoet}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:600 +#: documentation/content/en/articles/pgpkeys/_index.adoc:603 #, no-wrap msgid "`{foxfair}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:603 +#: documentation/content/en/articles/pgpkeys/_index.adoc:606 #, no-wrap msgid "`{whu}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:606 +#: documentation/content/en/articles/pgpkeys/_index.adoc:609 #, no-wrap msgid "`{chinsan}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:609 +#: documentation/content/en/articles/pgpkeys/_index.adoc:612 #, no-wrap msgid "`{zlei}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:612 +#: documentation/content/en/articles/pgpkeys/_index.adoc:615 #, no-wrap msgid "`{davide}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:615 +#: documentation/content/en/articles/pgpkeys/_index.adoc:618 #, no-wrap msgid "`{jkh}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:618 +#: documentation/content/en/articles/pgpkeys/_index.adoc:621 #, no-wrap msgid "`{versus}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:621 +#: documentation/content/en/articles/pgpkeys/_index.adoc:624 #, no-wrap msgid "`{pi}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:624 +#: documentation/content/en/articles/pgpkeys/_index.adoc:627 #, no-wrap msgid "`{weongyo}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:627 +#: documentation/content/en/articles/pgpkeys/_index.adoc:630 #, no-wrap msgid "`{peterj}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:630 +#: documentation/content/en/articles/pgpkeys/_index.adoc:633 #, no-wrap msgid "`{jinmei}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:633 +#: documentation/content/en/articles/pgpkeys/_index.adoc:636 #, no-wrap msgid "`{ahze}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:636 +#: documentation/content/en/articles/pgpkeys/_index.adoc:639 #, no-wrap msgid "`{markj}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:639 +#: documentation/content/en/articles/pgpkeys/_index.adoc:642 #, no-wrap msgid "`{trevor}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:642 +#: documentation/content/en/articles/pgpkeys/_index.adoc:645 #, no-wrap msgid "`{erj}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:648 +#: documentation/content/en/articles/pgpkeys/_index.adoc:651 #, no-wrap msgid "`{bjk}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:651 +#: documentation/content/en/articles/pgpkeys/_index.adoc:654 #, no-wrap msgid "`{phk}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:654 +#: documentation/content/en/articles/pgpkeys/_index.adoc:657 #, no-wrap msgid "`{pluknet}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:657 +#: documentation/content/en/articles/pgpkeys/_index.adoc:660 #, no-wrap msgid "`{cokane}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:660 +#: documentation/content/en/articles/pgpkeys/_index.adoc:663 #, no-wrap msgid "`{karels}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:663 +#: documentation/content/en/articles/pgpkeys/_index.adoc:666 #, no-wrap msgid "`{kato}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:666 +#: documentation/content/en/articles/pgpkeys/_index.adoc:669 #, no-wrap msgid "`{vkashyap}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:669 +#: documentation/content/en/articles/pgpkeys/_index.adoc:672 #, no-wrap msgid "`{pkubaj}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:672 +#: documentation/content/en/articles/pgpkeys/_index.adoc:675 #, no-wrap msgid "`{kris}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:675 +#: documentation/content/en/articles/pgpkeys/_index.adoc:678 #, no-wrap msgid "`{keramida}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:678 +#: documentation/content/en/articles/pgpkeys/_index.adoc:681 #, no-wrap msgid "`{fjoe}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:681 +#: documentation/content/en/articles/pgpkeys/_index.adoc:684 #, no-wrap msgid "`{manolis}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:684 +#: documentation/content/en/articles/pgpkeys/_index.adoc:687 #, no-wrap msgid "`{stevek}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:687 +#: documentation/content/en/articles/pgpkeys/_index.adoc:690 #, no-wrap msgid "`{jkim}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:690 +#: documentation/content/en/articles/pgpkeys/_index.adoc:693 #, no-wrap msgid "`{zack}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:693 +#: documentation/content/en/articles/pgpkeys/_index.adoc:696 #, no-wrap msgid "`{akiyano}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:696 +#: documentation/content/en/articles/pgpkeys/_index.adoc:699 #, no-wrap msgid "`{jceel}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:699 +#: documentation/content/en/articles/pgpkeys/_index.adoc:702 #, no-wrap msgid "`{andreas}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:702 +#: documentation/content/en/articles/pgpkeys/_index.adoc:705 #, no-wrap msgid "`{kai}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:705 +#: documentation/content/en/articles/pgpkeys/_index.adoc:708 #, no-wrap msgid "`{corvink}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:708 +#: documentation/content/en/articles/pgpkeys/_index.adoc:711 #, no-wrap msgid "`{jkois}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:711 +#: documentation/content/en/articles/pgpkeys/_index.adoc:714 #, no-wrap msgid "`{sergei}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:714 +#: documentation/content/en/articles/pgpkeys/_index.adoc:717 #, no-wrap msgid "`{maxim}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:717 +#: documentation/content/en/articles/pgpkeys/_index.adoc:720 #, no-wrap msgid "`{taras}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:720 +#: documentation/content/en/articles/pgpkeys/_index.adoc:723 #, no-wrap msgid "`{tobik}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:723 +#: documentation/content/en/articles/pgpkeys/_index.adoc:726 #, no-wrap msgid "`{jkoshy}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:726 +#: documentation/content/en/articles/pgpkeys/_index.adoc:729 #, no-wrap msgid "`{wkoszek}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:729 +#: documentation/content/en/articles/pgpkeys/_index.adoc:732 #, no-wrap msgid "`{ak}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:732 +#: documentation/content/en/articles/pgpkeys/_index.adoc:735 #, no-wrap msgid "`{gabor}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:735 +#: documentation/content/en/articles/pgpkeys/_index.adoc:738 #, no-wrap msgid "`{anchie}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:738 +#: documentation/content/en/articles/pgpkeys/_index.adoc:741 #, no-wrap msgid "`{rushani}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:741 +#: documentation/content/en/articles/pgpkeys/_index.adoc:744 #, no-wrap msgid "`{kuriyama}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:744 +#: documentation/content/en/articles/pgpkeys/_index.adoc:747 #, no-wrap msgid "`{rene}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:747 +#: documentation/content/en/articles/pgpkeys/_index.adoc:750 #, no-wrap msgid "`{jlaffaye}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:750 +#: documentation/content/en/articles/pgpkeys/_index.adoc:753 #, no-wrap msgid "`{clement}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:753 +#: documentation/content/en/articles/pgpkeys/_index.adoc:756 #, no-wrap msgid "`{mlaier}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:756 +#: documentation/content/en/articles/pgpkeys/_index.adoc:759 #, no-wrap msgid "`{martymac}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:759 +#: documentation/content/en/articles/pgpkeys/_index.adoc:762 #, no-wrap msgid "`{glarkin}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:762 +#: documentation/content/en/articles/pgpkeys/_index.adoc:765 #, no-wrap msgid "`{dru}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:765 +#: documentation/content/en/articles/pgpkeys/_index.adoc:768 #, no-wrap msgid "`{lawrance}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:768 +#: documentation/content/en/articles/pgpkeys/_index.adoc:771 #, no-wrap msgid "`{njl}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:771 +#: documentation/content/en/articles/pgpkeys/_index.adoc:774 #, no-wrap msgid "`{jlh}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:774 +#: documentation/content/en/articles/pgpkeys/_index.adoc:777 #, no-wrap msgid "`{leeym}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:777 +#: documentation/content/en/articles/pgpkeys/_index.adoc:780 #, no-wrap msgid "`{sam}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:780 +#: documentation/content/en/articles/pgpkeys/_index.adoc:783 #, no-wrap msgid "`{jylefort}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:783 +#: documentation/content/en/articles/pgpkeys/_index.adoc:786 #, no-wrap msgid "`{grog}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:786 +#: documentation/content/en/articles/pgpkeys/_index.adoc:789 #, no-wrap msgid "`{oliver}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:789 +#: documentation/content/en/articles/pgpkeys/_index.adoc:792 #, no-wrap msgid "`{netchild}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:792 +#: documentation/content/en/articles/pgpkeys/_index.adoc:795 #, no-wrap msgid "`{leitao}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:795 +#: documentation/content/en/articles/pgpkeys/_index.adoc:798 #, no-wrap msgid "`{ae}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:798 +#: documentation/content/en/articles/pgpkeys/_index.adoc:801 #, no-wrap msgid "`{lesi}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:801 +#: documentation/content/en/articles/pgpkeys/_index.adoc:804 #, no-wrap msgid "`{achim}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:804 +#: documentation/content/en/articles/pgpkeys/_index.adoc:807 #, no-wrap msgid "`{cel}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:807 +#: documentation/content/en/articles/pgpkeys/_index.adoc:810 #, no-wrap msgid "`{glewis}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:810 +#: documentation/content/en/articles/pgpkeys/_index.adoc:813 #, no-wrap msgid "`{vishwin}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:813 +#: documentation/content/en/articles/pgpkeys/_index.adoc:816 #, no-wrap msgid "`{delphij}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:816 +#: documentation/content/en/articles/pgpkeys/_index.adoc:819 #, no-wrap msgid "`{avatar}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:819 +#: documentation/content/en/articles/pgpkeys/_index.adoc:822 #, no-wrap msgid "`{ijliao}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:822 +#: documentation/content/en/articles/pgpkeys/_index.adoc:825 #, no-wrap msgid "`{rlibby}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:825 +#: documentation/content/en/articles/pgpkeys/_index.adoc:828 #, no-wrap msgid "`{pclin}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:828 +#: documentation/content/en/articles/pgpkeys/_index.adoc:831 #, no-wrap msgid "`{yzlin}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:831 +#: documentation/content/en/articles/pgpkeys/_index.adoc:834 #, no-wrap msgid "`{linimon}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:834 +#: documentation/content/en/articles/pgpkeys/_index.adoc:837 #, no-wrap msgid "`{arved}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:837 +#: documentation/content/en/articles/pgpkeys/_index.adoc:840 #, no-wrap msgid "`{dryice}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:840 +#: documentation/content/en/articles/pgpkeys/_index.adoc:843 #, no-wrap msgid "`{nemoliu}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:843 +#: documentation/content/en/articles/pgpkeys/_index.adoc:846 #, no-wrap msgid "`{kevlo}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:846 +#: documentation/content/en/articles/pgpkeys/_index.adoc:849 #, no-wrap msgid "`{zml}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:849 +#: documentation/content/en/articles/pgpkeys/_index.adoc:852 #, no-wrap msgid "`{nox}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:852 +#: documentation/content/en/articles/pgpkeys/_index.adoc:855 #, no-wrap msgid "`{avl}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:855 +#: documentation/content/en/articles/pgpkeys/_index.adoc:858 #, no-wrap msgid "`{scottl}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:858 +#: documentation/content/en/articles/pgpkeys/_index.adoc:861 #, no-wrap msgid "`{rmacklem}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:861 +#: documentation/content/en/articles/pgpkeys/_index.adoc:864 #, no-wrap msgid "`{vmaffione}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:864 +#: documentation/content/en/articles/pgpkeys/_index.adoc:867 #, no-wrap msgid "`{bmah}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:867 +#: documentation/content/en/articles/pgpkeys/_index.adoc:870 #, no-wrap msgid "`{rm}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:870 +#: documentation/content/en/articles/pgpkeys/_index.adoc:873 #, no-wrap msgid "`{mtm}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:873 +#: documentation/content/en/articles/pgpkeys/_index.adoc:876 #, no-wrap msgid "`{dwmalone}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:876 +#: documentation/content/en/articles/pgpkeys/_index.adoc:879 #, no-wrap msgid "`{christos}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:879 +#: documentation/content/en/articles/pgpkeys/_index.adoc:882 #, no-wrap msgid "`{marino}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:882 +#: documentation/content/en/articles/pgpkeys/_index.adoc:885 +#, no-wrap +msgid "`{emaste}`" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/pgpkeys/_index.adoc:888 #, no-wrap msgid "`{cherry}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:885 +#: documentation/content/en/articles/pgpkeys/_index.adoc:891 #, no-wrap msgid "`{matusita}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:888 +#: documentation/content/en/articles/pgpkeys/_index.adoc:894 #, no-wrap msgid "`{mm}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:891 +#: documentation/content/en/articles/pgpkeys/_index.adoc:897 #, no-wrap msgid "`{sem}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:894 +#: documentation/content/en/articles/pgpkeys/_index.adoc:900 #, no-wrap msgid "`{rcm}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:897 +#: documentation/content/en/articles/pgpkeys/_index.adoc:903 #, no-wrap msgid "`{mckusick}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:900 +#: documentation/content/en/articles/pgpkeys/_index.adoc:906 #, no-wrap msgid "`{tmclaugh}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:903 +#: documentation/content/en/articles/pgpkeys/_index.adoc:909 #, no-wrap msgid "`{jmelo}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:906 +#: documentation/content/en/articles/pgpkeys/_index.adoc:912 #, no-wrap msgid "`{mmel}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:909 +#: documentation/content/en/articles/pgpkeys/_index.adoc:915 #, no-wrap msgid "`{jmmv}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:912 +#: documentation/content/en/articles/pgpkeys/_index.adoc:918 #, no-wrap msgid "`{kadesai}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:915 +#: documentation/content/en/articles/pgpkeys/_index.adoc:921 #, no-wrap msgid "`{ken}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:918 +#: documentation/content/en/articles/pgpkeys/_index.adoc:924 #, no-wrap msgid "`{markm}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:921 +#: documentation/content/en/articles/pgpkeys/_index.adoc:927 #, no-wrap msgid "`{dinoex}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:924 +#: documentation/content/en/articles/pgpkeys/_index.adoc:930 #, no-wrap msgid "`{sanpei}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:927 +#: documentation/content/en/articles/pgpkeys/_index.adoc:933 #, no-wrap msgid "`{rmh}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:930 +#: documentation/content/en/articles/pgpkeys/_index.adoc:936 #, no-wrap msgid "`{driesm}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:933 +#: documentation/content/en/articles/pgpkeys/_index.adoc:939 #, no-wrap msgid "`{jrm}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:936 +#: documentation/content/en/articles/pgpkeys/_index.adoc:942 #, no-wrap msgid "`{freqlabs}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:939 +#: documentation/content/en/articles/pgpkeys/_index.adoc:945 #, no-wrap msgid "`{mmoll}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:942 +#: documentation/content/en/articles/pgpkeys/_index.adoc:948 #, no-wrap msgid "`{cmt}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:945 +#: documentation/content/en/articles/pgpkeys/_index.adoc:951 #, no-wrap msgid "`{stephen}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:948 +#: documentation/content/en/articles/pgpkeys/_index.adoc:954 #, no-wrap msgid "`{marcel}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:951 +#: documentation/content/en/articles/pgpkeys/_index.adoc:957 #, no-wrap msgid "`{dougm}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:954 +#: documentation/content/en/articles/pgpkeys/_index.adoc:960 #, no-wrap msgid "`{kmoore}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:957 +#: documentation/content/en/articles/pgpkeys/_index.adoc:963 #, no-wrap msgid "`{marck}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:960 +#: documentation/content/en/articles/pgpkeys/_index.adoc:966 #, no-wrap msgid "`{mav}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:963 +#: documentation/content/en/articles/pgpkeys/_index.adoc:969 #, no-wrap msgid "`{rich}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:966 +#: documentation/content/en/articles/pgpkeys/_index.adoc:972 #, no-wrap msgid "`{knu}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:969 +#: documentation/content/en/articles/pgpkeys/_index.adoc:975 #, no-wrap msgid "`{tmm}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:972 +#: documentation/content/en/articles/pgpkeys/_index.adoc:978 #, no-wrap msgid "`{max}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:975 +#: documentation/content/en/articles/pgpkeys/_index.adoc:981 #, no-wrap msgid "`{maho}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:978 +#: documentation/content/en/articles/pgpkeys/_index.adoc:984 #, no-wrap msgid "`{yoichi}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:981 +#: documentation/content/en/articles/pgpkeys/_index.adoc:987 #, no-wrap msgid "`{bland}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:984 +#: documentation/content/en/articles/pgpkeys/_index.adoc:990 #, no-wrap msgid "`{gnn}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:987 +#: documentation/content/en/articles/pgpkeys/_index.adoc:993 #, no-wrap msgid "`{khng}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:990 +#: documentation/content/en/articles/pgpkeys/_index.adoc:996 #, no-wrap msgid "`{simon}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:993 +#: documentation/content/en/articles/pgpkeys/_index.adoc:999 #, no-wrap msgid "`{rnoland}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:996 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1002 #, no-wrap msgid "`{anders}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:999 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1005 #, no-wrap msgid "`{lofi}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1002 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1008 #, no-wrap msgid "`{obrien}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1005 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1011 #, no-wrap msgid "`{olgeni}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1008 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1014 #, no-wrap msgid "`{philip}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1011 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1017 #, no-wrap msgid "`{jpaetzel}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1014 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1020 #, no-wrap msgid "`{zirias}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1017 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1023 #, no-wrap msgid "`{hiren}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1020 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1026 #, no-wrap msgid "`{hmp}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1023 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1029 #, no-wrap msgid "`{fluffy}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1026 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1032 #, no-wrap msgid "`{sat}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1029 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1035 #, no-wrap msgid "`{np}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1032 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1038 #, no-wrap msgid "`{royger}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1035 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1041 #, no-wrap msgid "`{rpaulo}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1038 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1044 #, no-wrap msgid "`{misha}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1041 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1047 #, no-wrap msgid "`{dumbbell}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1044 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1050 #, no-wrap msgid "`{rpokala}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1047 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1053 #, no-wrap msgid "`{mp}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1050 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1056 #, no-wrap msgid "`{roam}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1053 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1059 #, no-wrap msgid "`{den}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1056 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1062 #, no-wrap msgid "`{csjp}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1059 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1065 #, no-wrap msgid "`{grahamperrin}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1062 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1068 #, no-wrap msgid "`{gerald}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1065 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1071 #, no-wrap msgid "`{scottph}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1068 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1074 #, no-wrap msgid "`{jacula}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1071 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1077 #, no-wrap msgid "`{0mp}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1074 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1080 #, no-wrap msgid "`{jdp}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1077 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1083 #, no-wrap msgid "`{krion}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1080 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1086 +#, no-wrap +msgid "`{vladlen}`" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/pgpkeys/_index.adoc:1089 #, no-wrap msgid "`{sepotvin}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1083 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1092 #, no-wrap msgid "`{cpm}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1086 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1095 #, no-wrap msgid "`{markp}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1089 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1098 #, no-wrap msgid "`{alepulver}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1092 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1101 #, no-wrap msgid "`{kp}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1095 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1104 #, no-wrap msgid "`{thomas}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1098 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1107 #, no-wrap msgid "`{hq}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1101 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1110 #, no-wrap msgid "`{bofh}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1104 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1113 #, no-wrap msgid "`{fox}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1107 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1116 #, no-wrap msgid "`{lbr}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1110 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1119 #, no-wrap msgid "`{crees}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1113 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1122 #, no-wrap msgid "`{rees}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1116 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1125 #, no-wrap msgid "`{mr}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1119 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1128 #, no-wrap msgid "`{bcr}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1122 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1131 #, no-wrap msgid "`{trhodes}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1125 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1134 #, no-wrap msgid "`{benno}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1128 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1137 #, no-wrap msgid "`{beech}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1131 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1140 #, no-wrap msgid "`{roberto}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1134 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1143 #, no-wrap msgid "`{rodrigc}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1137 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1146 #, no-wrap msgid "`{michaelo}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1140 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1149 #, no-wrap msgid "`{igoro}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1143 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1152 #, no-wrap msgid "`{dtxdf}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1146 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1155 #, no-wrap msgid "`{ler}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1149 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1158 #, no-wrap msgid "`{leres}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1152 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1161 #, no-wrap msgid "`{robak}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1155 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1164 #, no-wrap msgid "`{guido}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1158 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1167 #, no-wrap msgid "`{rea}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1161 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1170 #, no-wrap msgid "`{ray}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1164 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1173 #, no-wrap msgid "`{niklas}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1167 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1176 #, no-wrap msgid "`{salvadore}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1170 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1179 #, no-wrap msgid "`{bsam}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1173 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1182 #, no-wrap msgid "`{marks}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1176 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1185 #, no-wrap msgid "`{bschmidt}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1179 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1188 #, no-wrap msgid "`{wosch}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1182 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1191 #, no-wrap msgid "`{cy}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1185 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1194 #, no-wrap msgid "`{das}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1188 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1197 #, no-wrap msgid "`{scheidell}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1191 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1200 #, no-wrap msgid "`{matthew}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1194 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1203 #, no-wrap msgid "`{tmseck}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1197 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1206 #, no-wrap msgid "`{johans}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1200 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1209 #, no-wrap msgid "`{bakul}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1203 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1212 #, no-wrap msgid "`{gshapiro}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1206 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1215 #, no-wrap msgid "`{wxs}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1209 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1218 #, no-wrap msgid "`{nork}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1212 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1221 #, no-wrap msgid "`{syrinx}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1215 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1224 #, no-wrap msgid "`{vanilla}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1218 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1227 #, no-wrap msgid "`{ashafer}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1221 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1230 #, no-wrap msgid "`{ashish}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1224 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1233 #, no-wrap msgid "`{asiciliano}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1227 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1236 #, no-wrap msgid "`{chs}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1230 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1239 #, no-wrap msgid "`{bms}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1233 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1242 #, no-wrap msgid "`{demon}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1236 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1245 #, no-wrap msgid "`{jesper}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1239 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1248 #, no-wrap msgid "`{scop}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1242 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1251 #, no-wrap msgid "`{anray}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1245 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1254 #, no-wrap msgid "`{flo}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1251 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1260 #, no-wrap msgid "`{kensmith}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1254 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1263 #, no-wrap msgid "`{ben}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1257 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1266 #, no-wrap msgid "`{des}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1260 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1269 #, no-wrap msgid "`{sobomax}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1263 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1272 #, no-wrap msgid "`{asomers}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1266 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1275 #, no-wrap msgid "`{brian}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1269 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1278 #, no-wrap msgid "`{sson}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1272 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1281 #, no-wrap msgid "`{nsouch}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1275 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1284 #, no-wrap msgid "`{ssouhlal}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1278 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1287 #, no-wrap msgid "`{loos}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1281 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1290 #, no-wrap msgid "`{brnrd}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1284 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1293 #, no-wrap msgid "`{rink}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1287 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1296 #, no-wrap msgid "`{vsevolod}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1290 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1299 #, no-wrap msgid "`{pstef}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1293 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1302 #, no-wrap msgid "`{zi}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1296 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1305 #, no-wrap msgid "`{lstewart}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1299 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1308 #, no-wrap msgid "`{murray}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1302 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1311 #, no-wrap msgid "`{vs}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1305 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1314 #, no-wrap msgid "`{xride}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1308 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1317 #, no-wrap msgid "`{marius}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1311 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1320 #, no-wrap msgid "`{cs}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1314 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1323 #, no-wrap msgid "`{clsung}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1317 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1326 #, no-wrap msgid "`{gsutter}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1320 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1329 #, no-wrap msgid "`{metal}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1323 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1332 #, no-wrap msgid "`{ryusuke}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1326 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1335 #, no-wrap msgid "`{nyan}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1329 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1338 #, no-wrap msgid "`{sahil}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1332 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1341 #, no-wrap msgid "`{tota}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1335 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1344 #, no-wrap msgid "`{romain}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1338 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1347 #, no-wrap msgid "`{eduardo}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1341 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1350 #, no-wrap msgid "`{sylvio}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1344 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1353 #, no-wrap msgid "`{itetcu}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1347 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1356 #, no-wrap msgid "`{mi}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1350 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1359 #, no-wrap msgid "`{gordon}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1353 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1362 #, no-wrap msgid "`{lth}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1356 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1365 #, no-wrap msgid "`{fabient}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1359 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1368 #, no-wrap msgid "`{thierry}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1362 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1371 #, no-wrap msgid "`{thompsa}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1365 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1374 #, no-wrap msgid "`{flz}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1368 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1377 #, no-wrap msgid "`{jilles}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1371 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1380 #, no-wrap msgid "`{ganbold}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1374 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1383 #, no-wrap msgid "`{tuexen}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1377 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1386 #, no-wrap msgid "`{gonzo}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1380 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1389 #, no-wrap msgid "`{uzsolt}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1383 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1392 #, no-wrap msgid "`{ume}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1386 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1395 #, no-wrap msgid "`{ups}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1389 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1398 #, no-wrap msgid "`{fsu}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1392 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1401 #, no-wrap msgid "`{mikael}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1395 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1404 #, no-wrap msgid "`{manu}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1398 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1407 #, no-wrap msgid "`{ram}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1401 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1410 #, no-wrap msgid "`{bryanv}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1404 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1413 #, no-wrap msgid "`{nectar}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1407 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1416 #, no-wrap msgid "`{avilla}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1410 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1419 #, no-wrap msgid "`{nivit}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1413 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1422 #, no-wrap msgid "`{ivoras}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1416 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1425 #, no-wrap msgid "`{stefan}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1419 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1428 #, no-wrap msgid "`{kaiw}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1422 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1431 #, no-wrap msgid "`{adamw}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1425 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1434 #, no-wrap msgid "`{naddy}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1428 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1437 #, no-wrap msgid "`{peter}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1431 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1440 #, no-wrap msgid "`{nwhitehorn}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1434 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1443 +#, no-wrap +msgid "`{obiwac}`" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/pgpkeys/_index.adoc:1446 #, no-wrap msgid "`{miwi}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1437 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1449 #, no-wrap msgid "`{nate}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1440 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1452 #, no-wrap msgid "`{twinterg}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1443 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1455 #, no-wrap msgid "`{def}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1446 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1458 #, no-wrap msgid "`{wollman}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1449 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1461 #, no-wrap msgid "`{joerg}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1452 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1464 #, no-wrap msgid "`{ygy}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1455 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1467 #, no-wrap msgid "`{emax}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1458 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1470 #, no-wrap msgid "`{oshogbo}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1461 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1473 +#, no-wrap +msgid "`{andy}`" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/pgpkeys/_index.adoc:1476 #, no-wrap msgid "`{riggs}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1464 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1479 #, no-wrap msgid "`{egypcio}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1467 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1482 #, no-wrap msgid "`{bz}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1470 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1485 #, no-wrap msgid "`{dsl}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1473 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1488 #, no-wrap msgid "`{zeising}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1476 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1491 #, no-wrap msgid "`{phantom}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1479 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1494 #, no-wrap msgid "`{tz}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1482 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1497 #, no-wrap msgid "`{rigoletto}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1485 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1500 #, no-wrap msgid "`{kaktus}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1488 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1503 #, no-wrap msgid "`{samm}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1491 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1506 #, no-wrap msgid "`{arrowd}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1494 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1509 #, no-wrap msgid "`{ronald}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1497 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1512 #, no-wrap msgid "`{meta}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1500 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1515 #, no-wrap msgid "`{rnagy}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1503 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1518 #, no-wrap msgid "`{vvd}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1506 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1521 #, no-wrap msgid "`{gbe}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1509 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1524 #, no-wrap msgid "`{bnovkov}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1512 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1527 #, no-wrap msgid "`{ivy}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1515 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1530 #, no-wrap msgid "`{khorben}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1518 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1533 #, no-wrap msgid "`{vexeduxr}`" msgstr "" +#. type: Title === +#: documentation/content/en/articles/pgpkeys/_index.adoc:1536 +#, no-wrap +msgid "`{alven}`" +msgstr "" + #. type: Title == -#: documentation/content/en/articles/pgpkeys/_index.adoc:1522 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1540 #, no-wrap msgid "Other Cluster Account Holders" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1524 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1542 #, no-wrap msgid "`{bk}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1527 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1545 #, no-wrap msgid "`{deb}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1530 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1548 #, no-wrap msgid "`{debdrup}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1533 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1551 #, no-wrap msgid "`{dutchdaemon}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1536 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1554 #, no-wrap msgid "`{keymaster}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1539 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1557 #, no-wrap msgid "`{mwlucas}`" msgstr "" #. type: Title === -#: documentation/content/en/articles/pgpkeys/_index.adoc:1542 +#: documentation/content/en/articles/pgpkeys/_index.adoc:1560 #, no-wrap msgid "`{dhw}`" msgstr "" diff --git a/documentation/content/en/articles/pr-guidelines/_index.adoc b/documentation/content/en/articles/pr-guidelines/_index.adoc index b6729150cd..dcd8579923 100644 --- a/documentation/content/en/articles/pr-guidelines/_index.adoc +++ b/documentation/content/en/articles/pr-guidelines/_index.adoc @@ -1,14 +1,15 @@ --- -title: Problem Report Handling Guidelines +title: Problem Report Handling Guidelines With Bugzilla authors: - author: Dag-Erling Smørgrav - author: Hiten Pandya + - author: Mark Linimon description: These guidelines describe recommended handling practices for FreeBSD Problem Reports (PRs). trademarks: ["freebsd", "general"] tags: ["PR", "guideline", "bugs", "maintenance", "BugZilla", "FreeBSD"] --- -= Problem Report Handling Guidelines += Problem Report Handling Guidelines With Bugzilla :doctype: article :toc: macro :toclevels: 1 @@ -42,8 +43,8 @@ endif::[] [.abstract-title] Abstract -These guidelines describe recommended handling practices for FreeBSD Problem Reports (PRs). -Whilst developed for the FreeBSD PR Database Maintenance Team mailto:freebsd-bugbusters@FreeBSD.org[freebsd-bugbusters@FreeBSD.org], these guidelines should be followed by anyone working with FreeBSD PRs. +These guidelines describe recommended handling practices for FreeBSD Problem Reports (PRs) as submitted via Bugzilla. +Whilst developed for the FreeBSD Bugzilla Database Maintenance Team mailto:freebsd-bugbusters@FreeBSD.org[freebsd-bugbusters@FreeBSD.org], these guidelines should be followed by anyone working with FreeBSD Problem Reports. ''' @@ -58,28 +59,30 @@ As accurate tracking of outstanding software defects is important to FreeBSD's q Access to Bugzilla is available to the entire FreeBSD community. In order to maintain consistency within the database and provide a consistent user experience, guidelines have been established covering common aspects of bug management such as presenting followup, handling close requests, and so forth. +Note: in this Article, the term "PR" means "Bugzilla Problem Report". + [[pr-lifecycle]] == Problem Report Life-cycle * The Reporter submits a bug report on the website. The bug is in the `Needs Triage` state. * Jane Random BugBuster confirms that the bug report has sufficient information to be reproducible. If not, she goes back and forth with the reporter to obtain the needed information. At this point the bug is set to the `Open` state. -* Joe Random Committer takes interest in the PR and assigns it to himself, or Jane Random BugBuster decides that Joe is best suited to handle it and assigns it to him. The bug should be set to the `In Discussion` state. +* Joe Random Committer takes interest in the report and assigns it to himself, or Jane Random BugBuster decides that Joe is best suited to handle it and assigns it to him. The bug should be set to the `In Discussion` state. * Joe has a brief exchange with the originator (making sure it all goes into the audit trail) and determines the cause of the problem. -* Joe pulls an all-nighter and whips up a patch that he thinks fixes the problem, and submits it in a follow-up, asking the originator to test it. He then sets the PRs state to `Patch Ready`. +* Joe pulls an all-nighter and whips up a patch that he thinks fixes the problem, and submits it in a follow-up, asking the originator to test it. He then sets the report's state to `Patch Ready`. * A couple of iterations later, both Joe and the originator are satisfied with the patch, and Joe commits it to `-CURRENT` (or directly to `-STABLE` if the problem does not exist in `-CURRENT`), making sure to reference the Problem Report in his commit log (and credit the originator if they submitted all or part of the patch) and, if appropriate, start an MFC countdown. The bug is set to the `Needs MFC` state. -* If the patch does not need MFCing, Joe then closes the PR as `Issue Resolved`. +* If the patch does not need MFCing, Joe then closes the report as `Issue Resolved`. [NOTE] ==== -Many PRs are submitted with very little information about the problem, and some are either very complex to solve, or just scratch the surface of a larger problem; in these cases, it is very important to obtain all the necessary information needed to solve the problem. -If the problem contained within cannot be solved, or has occurred again, it is necessary to re-open the PR. +Many reports are submitted with very little information about the problem, and some are either very complex to solve, or just scratch the surface of a larger problem; in these cases, it is very important to obtain all the necessary information needed to solve the problem. +If the problem contained within cannot be solved, or has occurred again, it is necessary to re-open the report. ==== [[pr-states]] == Problem Report State -It is important to update the state of a PR when certain actions are taken. -The state should accurately reflect the current state of work on the PR. +It is important to update the state of a Problem Report when certain actions are taken. +The state should accurately reflect the current state of work on the issue. .A small example on when to change PR state [example] @@ -150,9 +153,17 @@ Here is the current list, with the most common ones listed first: |freebsd-bugs |architecture-specific -|alpha, amd64, arm, i386, ia64, powerpc, sparc64 +|arm, amd64, i386, mips |freebsd-_arch_ +|architecture-specific: powerpc +|powerpc64 +|freebsd-ppc + +|architecture-specific: riscv64 +|riscv64 +|freebsd-risc + |ports collection |ports |freebsd-ports-bugs @@ -208,7 +219,7 @@ this will avoid duplicate emails sent to the mailing list. [NOTE] ==== -Since the list of individuals who have volunteered to be the default assignee for certain types of PRs changes so often, it is much more suitable for https://wiki.freebsd.org/AssigningPRs[the FreeBSD wiki]. +Since the list of individuals who have volunteered to be the default assignee for certain types of PRs changes so often, it is much more suitable for https://wiki.freebsd.org/AssigningPRs[the FreeBSD wiki]. ==== Here is a sample list of such entities; it is probably not complete. @@ -242,11 +253,6 @@ Here is a sample list of such entities; it is probably not complete. |freebsd-acpi |mailing list -|problem with Asynchronous Transfer Mode (ATM) drivers -|kern -|freebsd-atm -|mailing list - |problem with embedded or small-footprint FreeBSD systems (e.g., NanoBSD/PicoBSD/FreeBSD-arm) |kern |freebsd-embedded @@ -272,11 +278,6 @@ Here is a sample list of such entities; it is probably not complete. |freebsd-ipfw |mailing list -|problem with Integrated Services Digital Network (ISDN) drivers -|kern -|freebsd-isdn -|mailing list - |man:jail[8] subsystem |kern |freebsd-jail @@ -438,7 +439,7 @@ Here is a sample list of such entities; it is probably not complete. |mailing list |=== -Ports PRs which have a maintainer who is a ports committer may be reassigned by anyone (but note that not every FreeBSD committer is necessarily a ports committer, so you cannot simply go by the email address alone.) +Ports PRs which have a maintainer who is a ports committer may be reassigned by anyone (but note that not every FreeBSD committer is necessarily a ports committer, so you cannot simply go by the email address alone.) For other PRs, please do not reassign them to individuals (other than yourself) unless you are certain that the assignee really wants to track the PR. This will help to avoid the case where no one looks at fixing a particular problem because everyone assumes that the assignee is already working on it. @@ -452,7 +453,7 @@ This will help to avoid the case where no one looks at fixing a particular probl | Suggested Assignee | Assignee Type -|problem with PR database +|problem with Problem Report database |bin |bugmeister |alias @@ -500,7 +501,7 @@ This means that spammers found them. Whenever you close one of these PRs, please do the following: -* Set the component to `junk` (under `Supporting Services`. +* Set the component to `junk` (under `Supporting Services`). * Set Responsible to `nobody@FreeBSD.org`. * Set State to `Issue Resolved`. @@ -512,4 +513,4 @@ Setting the category to `junk` makes it obvious that there is no useful content This is a list of resources relevant to the proper writing and processing of problem reports. It is by no means complete. -* extref:{problem-reports}[How to Write FreeBSD Problem Reports]-guidelines for PR originators. +* extref:{problem-reports}[How to Write FreeBSD Problem Reports]-guidelines for Problem Report originators. diff --git a/documentation/content/en/articles/pr-guidelines/_index.po b/documentation/content/en/articles/pr-guidelines/_index.po index fe807d4148..29b0514aa4 100644 --- a/documentation/content/en/articles/pr-guidelines/_index.po +++ b/documentation/content/en/articles/pr-guidelines/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2024-12-29 08:30-0500\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -1397,7 +1397,7 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/pr-guidelines/_index.adoc:504 -msgid "Set the component to `junk` (under `Supporting Services`." +msgid "Set the component to `junk` (under `Supporting Services`)." msgstr "" #. type: Plain text diff --git a/documentation/content/en/articles/problem-reports/_index.adoc b/documentation/content/en/articles/problem-reports/_index.adoc index f201711526..0a952b12ea 100644 --- a/documentation/content/en/articles/problem-reports/_index.adoc +++ b/documentation/content/en/articles/problem-reports/_index.adoc @@ -48,16 +48,21 @@ This article describes how to best formulate and submit a problem report to the toc::[] +[[pr-scope]] +== Scope of this article + +This article was originally written to cover Problem Report submissions via Bugzilla, but parts will also apply to submitting via Phabricator review system or the FreeBSD Github organization. + [[pr-intro]] == Introduction -One of the most frustrating experiences one can have as a software user is to submit a problem report only to have it summarily closed with a terse and unhelpful explanation like "not a bug" or "bogus PR". +One of the most frustrating experiences one can have as a software user is to submit a problem report only to have it summarily closed with a terse and unhelpful explanation like "not a bug" or "bogus report". Similarly, one of the most frustrating experiences as a software developer is to be flooded with problem reports that are not really problem reports but requests for support, or that contain little or no information about what the problem is and how to reproduce it. This document attempts to describe how to write good problem reports. What, one asks, is a good problem report? Well, to go straight to the bottom line, a good problem report is one that can be analyzed and dealt with swiftly, to the mutual satisfaction of both user and developer. -Although the primary focus of this article is on FreeBSD problem reports, most of it should apply quite well to other software projects. +Although the primary focus of this article is on submitting FreeBSD problem reports via Bugzilla, most of it should apply quite well in other cases. Note that this article is organized thematically, not chronologically. Read the entire document before submitting a problem report, rather than treating it as a step-by-step tutorial. @@ -74,16 +79,16 @@ So how does one determine what is a bug and what is not? As a simple rule of thu It is not always quite so black and white, but the question rule covers a large majority of cases. When looking for an answer, consider posing the question to the {freebsd-questions}. -Consider these factors when submitting PRs about ports or other software that is not part of FreeBSD itself: +Consider these factors when submitting reports about ports or other software that is not part of FreeBSD itself: * Please do not submit problem reports that simply state that a newer version of an application is available. Ports maintainers are automatically notified by portscout when a new version of an application becomes available. Actual patches to update a port to the latest version are welcome. -* For unmaintained ports (`MAINTAINER` is `ports@FreeBSD.org`), a PR without an included patch is unlikely to get picked up by a committer. To become the maintainer of an unmaintained port, submit a PR with the request (patch preferred but not required). +* For unmaintained ports (`MAINTAINER` is `ports@FreeBSD.org`), a report without an included patch is unlikely to get picked up by a committer. To become the maintainer of an unmaintained port, submit a report with the request (patch preferred but not required). * In either case, following the process described in extref:{porters-handbook}upgrading/[Porter's Handbook] will yield the best results. (You might also wish to read extref:{contributing}[Contributing to the FreeBSD Ports Collection, ports-contributing].) A bug that cannot be reproduced can rarely be fixed. If the bug only occurred once and you cannot reproduce it, and it does not seem to happen to anybody else, chances are none of the developers will be able to reproduce it or figure out what is wrong. That does not mean it did not happen, but it does mean that the chances of your problem report ever leading to a bug fix are very slim. -To make matters worse, often these kinds of bugs are actually caused by failing hard drives or overheating processors—you should always try to rule out these causes, whenever possible, before submitting a PR. +To make matters worse, often these kinds of bugs are actually caused by failing hard drives or overheating processors—you should always try to rule out these causes, whenever possible, before submitting a report. Next, to decide to whom you should file your problem report, you need to understand that the software that makes up FreeBSD is composed of several different elements: @@ -112,7 +117,7 @@ For FreeBSD, this means: * The FreeBSD extref:{faq}[Frequently Asked Questions] (FAQ) list. The FAQ attempts to provide answers for a wide range of questions, such as those concerning extref:{faq}[hardware compatibility, hardware], extref:{faq}[user applications, applications], and extref:{faq}[kernel configuration, kernelconfig]. * The extref:{handbook}eresources/[mailing lists, eresources-mail]. If you are not subscribed, use https://www.FreeBSD.org/search/#mailinglists[the searchable archives] on the FreeBSD web site. If the problem has not been discussed on the lists, you might try posting a message about it and waiting a few days to see if someone can spot something that has been overlooked. * Optionally, the entire web-use your favorite search engine to locate any references to the problem. You may even get hits from archived mailing lists or newsgroups you did not know of or had not thought to search through. -* Next, the searchable https://bugs.freebsd.org/bugzilla/query.cgi[FreeBSD PR database] (Bugzilla). Unless the problem is recent or obscure, there is a fair chance it has already been reported. +* Next, the searchable https://bugs.freebsd.org/bugzilla/query.cgi[FreeBSD Bugzilla database]. Unless the problem is recent or obscure, there is a fair chance it has already been reported. * Most importantly, attempt to see if existing documentation in the source base addresses your problem. + For the base FreeBSD code, you should carefully study the contents of [.filename]#/usr/src/UPDATING# on your system or the latest version at https://cgit.freebsd.org/src/tree/UPDATING[https://cgit.freebsd.org/src/tree/UPDATING]. @@ -125,12 +130,12 @@ https://cgit.freebsd.org/ports/tree/UPDATING[https://cgit.freebsd.org/ports/tree == Writing the Problem Report Now that you have decided that your issue merits a problem report, and that it is a FreeBSD problem, it is time to write the actual problem report. -Before we get into the mechanics of the program used to generate and submit PRs, here are some tips and tricks to help make sure that your PR will be most effective. +Before we get into the mechanics of the program used to generate and submit Bugzilla PRs, here are some tips and tricks to help make sure that your report will be most effective. [[pr-writing-tips]] -== Tips and Tricks for Writing a Good Problem Report +== Tips and Tricks for Writing a Good Problem Report With Bugzilla -* _Do not leave the "Summary" line empty._ The PRs go both onto a mailing list that goes all over the world (where the "Summary" is used for the `Subject:` line), but also into a database. Anyone who comes along later and browses the database by synopsis, and finds a PR with a blank subject line, tends just to skip over it. Remember that PRs stay in this database until they are closed by someone; an anonymous one will usually just disappear in the noise. +* _Do not leave the "Summary" line empty._ The reports go both onto a mailing list that goes all over the world (where the "Summary" is used for the `Subject:` line), but also into a database. Anyone who comes along later and browses the database by synopsis, and finds a PR with a blank subject line, tends just to skip over it. Remember that PRs stay in this database until they are closed by someone; an anonymous one will usually just disappear in the noise. * _Avoid using a weak "Summary" line._ You should not assume that anyone reading your PR has any context for your submission, so the more you provide, the better. For instance, what part of the system does the problem apply to? Do you only see the problem while installing, or while running? To illustrate, instead of `Summary: portupgrade is broken`, see how much more informative this seems: `Summary: port ports-mgmt/portupgrade coredumps on -current`. (In the case of ports, it is especially helpful to have both the category and portname in the "Summary" line.) * _If you have a patch, say so._ The presence of a patch makes it much easier to progress a report. @@ -156,7 +161,7 @@ The presence of a patch makes it much easier to progress a report. *** any environment variables that override the defaults in [.filename]#bsd.port.mk#, such as `PORTSDIR` *** the fact that you have read [.filename]#ports/UPDATING# and that your problem is not listed there (someone is guaranteed to ask) -* _Avoid vague requests for features._ PRs of the form "someone should really implement something that does so-and-so" are less likely to get results than very specific requests. Remember, the source is available to everyone, so if you want a feature, the best way to ensure it being included is to get to work! Also consider the fact that many things like this would make a better topic for discussion on `freebsd-questions` than an entry in the PR database, as discussed above. +* _Avoid vague requests for features._ Problem Reports of the form "someone should really implement something that does so-and-so" are less likely to get results than very specific requests. Remember, the source is available to everyone, so if you want a feature, the best way to ensure it being included is to get to work! Also consider the fact that many things like this would make a better topic for discussion on `freebsd-questions` than an entry in the PR database, as discussed above. * _Make sure no one else has already submitted a similar PR._ Although this has already been mentioned above, it bears repeating here. It only take a minute or two to use the web-based search engine at https://bugs.freebsd.org/bugzilla/query.cgi[https://bugs.freebsd.org/bugzilla/query.cgi]. (Of course, everyone is guilty of forgetting to do this now and then.) * _Report only one issue per Problem Report._ Avoid including two or more problems within the same report unless they are related. When submitting patches, avoid adding multiple features or fixing multiple bugs in the same PR unless they are closely related-such PRs often take longer to resolve. * _Avoid controversial requests._ If your PR addresses an area that has been controversial in the past, you should probably be prepared to not only offer patches, but also justification for why the patches are "The Right Thing To Do". As noted above, a careful search of the mailing lists using the archives at https://www.FreeBSD.org/search/#mailinglists[https://www.FreeBSD.org/search/#mailinglists] is always good preparation. @@ -165,7 +170,7 @@ The presence of a patch makes it much easier to progress a report. [[pr-writing-before-beginning]] == Before Beginning -Similar considerations apply to use of the https://bugs.freebsd.org/bugzilla/enter_bug.cgi[web-based PR submission form]. +The following considerations apply to use of the https://bugs.freebsd.org/bugzilla/enter_bug.cgi[Bugzilla web-based PR submission form]. Be careful of cut-and-paste operations that might change whitespace or other text formatting. Finally, if the submission is lengthy, prepare the work offline so that nothing will be lost if there is a problem submitting it. @@ -173,6 +178,8 @@ Finally, if the submission is lengthy, prepare the work offline so that nothing [[pr-writing-attaching-patches]] == Attaching Patches or Files +The following instructions apply not only to submissions via Bugzilla, but also via Phabricator or the FreeBSD Github instance. + In general, we recommend using `git format-patch` to generate one or a series of unified diff against the base branch (e.g. `origin/main`). Patches generated this way would include the Git hashes and will include your name and email address, making it @@ -188,21 +195,21 @@ If you attach a patch inline, instead of as an attachment, note that the most co Do not send patches as attachments using `Content-Transfer-Encoding: quoted-printable`. These will perform character escaping and the entire patch will be useless. -Also note that while including small patches in a PR is generally all right—particularly when they fix the problem described in the PR-large patches and especially new code which may require substantial review before committing should be placed on a web or ftp server, and the URL should be included in the PR instead of the patch. +Also note that while including small patches in a Pull Request is generally all right—particularly when they fix the problem described in the Pull Request-large patches and especially new code which may require substantial review before committing should be placed on a web or ftp server, and the URL should be included in the Pull Request instead of the patch. Patches in email tend to get mangled, and the larger the patch, the harder it will be for interested parties to unmangle it. -Also, posting a patch on the web allows you to modify it without having to resubmit the entire patch in a followup to the original PR. -Finally, large patches simply increase the size of the database, since closed PRs are not actually deleted but instead kept and simply marked as complete. +Also, posting a patch on the web allows you to modify it without having to resubmit the entire patch in a followup. +Finally, large patches simply increase the size of the database, since closed reports are not actually deleted but instead kept and simply marked as complete. -You should also take note that unless you explicitly specify otherwise in your PR or in the patch itself, any patches you submit will be assumed to be licensed under the same terms as the original file you modified. +You should also take note that unless you explicitly specify otherwise in your request or in the patch itself, any patches you submit will be assumed to be licensed under the same terms as the original file you modified. [[pr-writing-filling-template]] -== Filling out the Form +== Filling out the Bugzilla Form [NOTE] ==== The email address you use will become public information and may become available to spammers. You should either have spam handling procedures in place, or use a temporary email account. -However, please note that if you do not use a valid email account at all, we will not be able to ask you questions about your PR. +However, please note that if you do not use a valid email account at all, we will not be able to ask you questions about your submission. ==== When you file a bug, you will find the following fields: @@ -264,7 +271,7 @@ You will be automatically notified of any change of status, and you will receive If someone requests additional information from you, or you remember or discover something you did not mention in the initial report, please submit a follow up. The number one reason for a bug not getting fixed is lack of communication with the originator. -The easiest way is to use the comment option on the individual PR's web page, which you can reach from the https://bugs.freebsd.org/bugzilla/query.cgi[PR search page]. +The easiest way is to use the comment option on the individual Bugzilla PR's web page, which you can reach from the https://bugs.freebsd.org/bugzilla/query.cgi[Bugzilla PR search page]. If the problem report remains open after the problem has gone away, just add a comment saying that the problem report can be closed, and, if possible, explaining how or when the problem was fixed. diff --git a/documentation/content/en/articles/rc-scripting/_index.adoc b/documentation/content/en/articles/rc-scripting/_index.adoc index 14e0ad4bb4..dbb718ebb9 100644 --- a/documentation/content/en/articles/rc-scripting/_index.adoc +++ b/documentation/content/en/articles/rc-scripting/_index.adoc @@ -590,7 +590,7 @@ After a script has been written, it needs to be integrated into [.filename]#rc.d The crucial step is to install the script in [.filename]#/etc/rc.d# (for the base system) or [.filename]#/usr/local/etc/rc.d# (for ports). Both [.filename]#bsd.prog.mk# and [.filename]#bsd.port.mk# provide convenient hooks for that, and usually you do not have to worry about the proper ownership and mode. System scripts should be installed from [.filename]#src/libexec/rc/rc.d# through the [.filename]#Makefile# found there. -Port scripts can be installed using `USE_RC_SUBR` as described extref:{porters-handbook}[in the Porter's Handbook, rc-scripts]. +Port scripts can be installed using `USE_RC_SUBR` as described extref:{porters-handbook}special[in the Porter's Handbook, rc-scripts]. However, we should consider beforehand the place of our script in the system startup sequence. The service handled by our script is likely to depend on other services. @@ -852,7 +852,7 @@ A script with a long running service which needs to do something listed above be By default, only the start and stop parts of a script are run within a service jail, the rest is run outside the jail. As such any setting used in the start/stop parts of the script can not be set from e.g. a precommand. -To make a script ready for use with extref:../../books/handbook/jails/#service-jails[Service Jails], only one more config line needs to be inserted: +To make a script ready for use with extref:{handbook}jails[Service Jails, service-jails], only one more config line needs to be inserted: [.programlisting] .... diff --git a/documentation/content/en/articles/rc-scripting/_index.po b/documentation/content/en/articles/rc-scripting/_index.po index 8600e08d60..4e96555d59 100644 --- a/documentation/content/en/articles/rc-scripting/_index.po +++ b/documentation/content/en/articles/rc-scripting/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2024-09-14 15:00-0300\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -93,8 +93,8 @@ msgid "" "did allow for accessing the network from single-user mode, but it did not " "integrate well into the automatic startup process because parts of its code " "needed to interleave with actions essentially unrelated to networking. That " -"was why [.filename]#/etc/netstart# mutated into [.filename]#/etc/rc." -"network#. The latter was no longer an ordinary script; it comprised of " +"was why [.filename]#/etc/netstart# mutated into [.filename]#/etc/" +"rc.network#. The latter was no longer an ordinary script; it comprised of " "large, tangled man:sh[1] functions called from [.filename]#/etc/rc# at " "different stages of system startup. However, as the startup tasks grew " "diverse and sophisticated, the \"quasi-modular\" approach became even more " @@ -122,8 +122,8 @@ msgid "" "__code reuse__. _Fine modularity_ means that each basic \"service\" such as " "a system daemon or primitive startup task gets its own man:sh[1] script able " "to start the service, stop it, reload it, check its status. A particular " -"action is chosen by the command-line argument to the script. The [." -"filename]#/etc/rc# script still drives system startup, but now it merely " +"action is chosen by the command-line argument to the script. The " +"[.filename]#/etc/rc# script still drives system startup, but now it merely " "invokes the smaller scripts one by one with the `start` argument. It is " "easy to perform shutdown tasks as well by running the same set of scripts " "with the `stop` argument, which is done by [.filename]#/etc/rc.shutdown#. " @@ -142,26 +142,26 @@ msgstr "" #: documentation/content/en/articles/rc-scripting/_index.adoc:101 msgid "" "The BSD [.filename]#rc.d# design is described in crossref:rc-" -"scripting[lukem, the original article by Luke Mewburn], and the [." -"filename]#rc.d# components are documented in great detail in crossref:rc-" +"scripting[lukem, the original article by Luke Mewburn], and the " +"[.filename]#rc.d# components are documented in great detail in crossref:rc-" "scripting[manpages, the respective manual pages]. However, it might not " "appear obvious to an [.filename]#rc.d# newbie how to tie the numerous bits " "and pieces together to create a well-styled script for a particular task. " -"Therefore this article will try a different approach to describe [." -"filename]#rc.d#. It will show which features should be used in a number of " -"typical cases, and why. Note that this is not a how-to document because our " -"aim is not at giving ready-made recipes, but at showing a few easy entrances " -"into the [.filename]#rc.d# realm. Neither is this article a replacement for " -"the relevant manual pages. Do not hesitate to refer to them for more formal " -"and complete documentation while reading this article." +"Therefore this article will try a different approach to describe " +"[.filename]#rc.d#. It will show which features should be used in a number " +"of typical cases, and why. Note that this is not a how-to document because " +"our aim is not at giving ready-made recipes, but at showing a few easy " +"entrances into the [.filename]#rc.d# realm. Neither is this article a " +"replacement for the relevant manual pages. Do not hesitate to refer to them " +"for more formal and complete documentation while reading this article." msgstr "" #. type: Plain text #: documentation/content/en/articles/rc-scripting/_index.adoc:105 msgid "" "There are prerequisites to understanding this article. First of all, you " -"should be familiar with the man:sh[1] scripting language to master [." -"filename]#rc.d#. In addition, you should know how the system performs " +"should be familiar with the man:sh[1] scripting language to master " +"[.filename]#rc.d#. In addition, you should know how the system performs " "userland startup and shutdown tasks, which is described in man:rc[8]." msgstr "" @@ -372,15 +372,15 @@ msgid "" "particular, `start`, `stop`, and other arguments to an [.filename]#rc.d# " "script are handled this way. A method is a man:sh[1] expression stored in a " "variable named `argument_cmd`, where _argument_ corresponds to what can be " -"specified on the script's command line. We will see later how man:rc." -"subr[8] provides default methods for the standard arguments." +"specified on the script's command line. We will see later how " +"man:rc.subr[8] provides default methods for the standard arguments." msgstr "" #. type: delimited block = 4 #: documentation/content/en/articles/rc-scripting/_index.adoc:209 msgid "" -"To make the code in [.filename]#rc.d# more uniform, it is common to use " -"`${name}` wherever appropriate. Thus a number of lines can be just copied " +"To make the code in [.filename]#rc.d# more uniform, it is common to use `$" +"{name}` wherever appropriate. Thus a number of lines can be just copied " "from one script to another." msgstr "" @@ -411,9 +411,9 @@ msgstr "" #: documentation/content/en/articles/rc-scripting/_index.adoc:224 msgid "" "➐ This call to man:rc.subr[8] loads man:rc.conf[5] variables. Our " -"script makes no use of them yet, but it still is recommended to load man:rc." -"conf[5] because there can be man:rc.conf[5] variables controlling man:rc." -"subr[8] itself." +"script makes no use of them yet, but it still is recommended to load " +"man:rc.conf[5] because there can be man:rc.conf[5] variables controlling " +"man:rc.subr[8] itself." msgstr "" #. type: Plain text @@ -433,8 +433,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/rc-scripting/_index.adoc:239 msgid "" -"Now let us add some controls to our dummy script. As you may know, [." -"filename]#rc.d# scripts are controlled with man:rc.conf[5]. Fortunately, " +"Now let us add some controls to our dummy script. As you may know, " +"[.filename]#rc.d# scripts are controlled with man:rc.conf[5]. Fortunately, " "man:rc.subr[8] hides all the complications from us. The following script " "uses man:rc.conf[5] via man:rc.subr[8] to see whether it is enabled in the " "first place, and to fetch a message to show at boot time. These two tasks " @@ -602,8 +602,8 @@ msgstr "" msgid "" "As a rule, [.filename]#rc.d# scripts of the base system need not provide " "defaults for their man:rc.conf[5] variables because the defaults should be " -"set in [.filename]#/etc/defaults/rc.conf# instead. On the other hand, [." -"filename]#rc.d# scripts for ports should provide the defaults as shown in " +"set in [.filename]#/etc/defaults/rc.conf# instead. On the other hand, " +"[.filename]#rc.d# scripts for ports should provide the defaults as shown in " "the example." msgstr "" @@ -721,12 +721,12 @@ msgstr "" #. type: delimited block = 4 #: documentation/content/en/articles/rc-scripting/_index.adoc:378 msgid "" -"Of course, man:sh[1] will permit you to set `${name}_program` from man:rc." -"conf[5] or the script itself even if `command` is unset. In that case, the " -"special properties of `${name}_program` are lost, and it becomes an ordinary " -"variable your script can use for its own purposes. However, the sole use of " -"`${name}_program` is discouraged because using it together with `command` " -"became an idiom of [.filename]#rc.d# scripting." +"Of course, man:sh[1] will permit you to set `${name}_program` from " +"man:rc.conf[5] or the script itself even if `command` is unset. In that " +"case, the special properties of `${name}_program` are lost, and it becomes " +"an ordinary variable your script can use for its own purposes. However, the " +"sole use of `${name}_program` is discouraged because using it together with " +"`command` became an idiom of [.filename]#rc.d# scripting." msgstr "" #. type: Plain text @@ -1007,8 +1007,8 @@ msgid "" "commands and shell functions are not always the same thing. For instance, " "`xyzzy` is not implemented as a function here. In addition, there can be a " "pre-command and post-command, which should be invoked orderly. So the " -"proper way for a script to run its own command is by means of man:rc." -"subr[8], as shown in the example." +"proper way for a script to run its own command is by means of " +"man:rc.subr[8], as shown in the example." msgstr "" #. type: Plain text @@ -1109,15 +1109,16 @@ msgstr "" #. type: delimited block = 4 #: documentation/content/en/articles/rc-scripting/_index.adoc:594 msgid "" -"After a script has been written, it needs to be integrated into [." -"filename]#rc.d#. The crucial step is to install the script in [.filename]#/" -"etc/rc.d# (for the base system) or [.filename]#/usr/local/etc/rc.d# (for " -"ports). Both [.filename]#bsd.prog.mk# and [.filename]#bsd.port.mk# provide " -"convenient hooks for that, and usually you do not have to worry about the " -"proper ownership and mode. System scripts should be installed from [." -"filename]#src/libexec/rc/rc.d# through the [.filename]#Makefile# found " -"there. Port scripts can be installed using `USE_RC_SUBR` as described " -"extref:{porters-handbook}[in the Porter's Handbook, rc-scripts]." +"After a script has been written, it needs to be integrated into " +"[.filename]#rc.d#. The crucial step is to install the script in " +"[.filename]#/etc/rc.d# (for the base system) or [.filename]#/usr/local/etc/" +"rc.d# (for ports). Both [.filename]#bsd.prog.mk# and " +"[.filename]#bsd.port.mk# provide convenient hooks for that, and usually you " +"do not have to worry about the proper ownership and mode. System scripts " +"should be installed from [.filename]#src/libexec/rc/rc.d# through the " +"[.filename]#Makefile# found there. Port scripts can be installed using " +"`USE_RC_SUBR` as described extref:{porters-handbook}special[in the Porter's " +"Handbook, rc-scripts]." msgstr "" #. type: delimited block = 4 @@ -1170,9 +1171,9 @@ msgstr "" #: documentation/content/en/articles/rc-scripting/_index.adoc:615 msgid "" "It is no surprise that man:rcorder[8] can handle only text files with a " -"syntax close to that of man:sh[1]. That is, special lines understood by man:" -"rcorder[8] look like man:sh[1] comments. The syntax of such special lines " -"is rather rigid to simplify their processing. See man:rcorder[8] for " +"syntax close to that of man:sh[1]. That is, special lines understood by " +"man:rcorder[8] look like man:sh[1] comments. The syntax of such special " +"lines is rather rigid to simplify their processing. See man:rcorder[8] for " "details." msgstr "" @@ -1256,21 +1257,21 @@ msgstr "" #: documentation/content/en/articles/rc-scripting/_index.adoc:666 msgid "" "➋➌ So our script indicates which \"conditions\" provided by " -"other scripts it depends on. According to the lines, our script asks man:" -"rcorder[8] to put it after the script(s) providing [.filename]#DAEMON# and [." -"filename]#cleanvar#, but before that providing [.filename]#LOGIN#." +"other scripts it depends on. According to the lines, our script asks " +"man:rcorder[8] to put it after the script(s) providing [.filename]#DAEMON# " +"and [.filename]#cleanvar#, but before that providing [.filename]#LOGIN#." msgstr "" #. type: delimited block = 4 #: documentation/content/en/articles/rc-scripting/_index.adoc:672 msgid "" "The `BEFORE:` line should not be abused to work around an incomplete " -"dependency list in the other script. The appropriate case for using `BEFORE:" -"` is when the other script does not care about ours, but our script can do " -"its task better if run before the other one. A typical real-life example is " -"the network interfaces vs. the firewall: While the interfaces do not depend " -"on the firewall in doing their job, the system security will benefit from " -"the firewall being ready before there is any network traffic." +"dependency list in the other script. The appropriate case for using " +"`BEFORE:` is when the other script does not care about ours, but our script " +"can do its task better if run before the other one. A typical real-life " +"example is the network interfaces vs. the firewall: While the interfaces do " +"not depend on the firewall in doing their job, the system security will " +"benefit from the firewall being ready before there is any network traffic." msgstr "" #. type: delimited block = 4 @@ -1278,9 +1279,9 @@ msgstr "" msgid "" "Besides conditions corresponding to a single service each, there are meta-" "conditions and their \"placeholder\" scripts used to ensure that certain " -"groups of operations are performed before others. These are denoted by [." -"filename]#UPPERCASE# names. Their list and purposes can be found in man:" -"rc[8]." +"groups of operations are performed before others. These are denoted by " +"[.filename]#UPPERCASE# names. Their list and purposes can be found in " +"man:rc[8]." msgstr "" #. type: delimited block = 4 @@ -1288,11 +1289,11 @@ msgstr "" msgid "" "Keep in mind that putting a service name in the `REQUIRE:` line does not " "guarantee that the service will actually be running by the time our script " -"starts. The required service may fail to start or just be disabled in man:" -"rc.conf[5]. Obviously, man:rcorder[8] cannot track such details, and man:" -"rc[8] will not do that either. Consequently, the application started by our " -"script should be able to cope with any required services being unavailable. " -"In certain cases, we can help it as discussed crossref:rc-" +"starts. The required service may fail to start or just be disabled in " +"man:rc.conf[5]. Obviously, man:rcorder[8] cannot track such details, and " +"man:rc[8] will not do that either. Consequently, the application started by " +"our script should be able to cope with any required services being " +"unavailable. In certain cases, we can help it as discussed crossref:rc-" "scripting[forcedep, below]" msgstr "" @@ -1300,20 +1301,20 @@ msgstr "" #: documentation/content/en/articles/rc-scripting/_index.adoc:687 msgid "" "[[keywords]]➍ As we remember from the above text, man:rcorder[8] " -"keywords can be used to select or leave out some scripts. Namely any man:" -"rcorder[8] consumer can specify through `-k` and `-s` options which keywords " -"are on the \"keep list\" and \"skip list\", respectively. From all the " -"files to be dependency sorted, man:rcorder[8] will pick only those having a " -"keyword from the keep list (unless empty) and not having a keyword from the " -"skip list." +"keywords can be used to select or leave out some scripts. Namely any " +"man:rcorder[8] consumer can specify through `-k` and `-s` options which " +"keywords are on the \"keep list\" and \"skip list\", respectively. From all " +"the files to be dependency sorted, man:rcorder[8] will pick only those " +"having a keyword from the keep list (unless empty) and not having a keyword " +"from the skip list." msgstr "" #. type: Plain text #: documentation/content/en/articles/rc-scripting/_index.adoc:690 msgid "" "In FreeBSD, man:rcorder[8] is used by [.filename]#/etc/rc# and [.filename]#/" -"etc/rc.shutdown#. These two scripts define the standard list of FreeBSD [." -"filename]#rc.d# keywords and their meanings as follows:" +"etc/rc.shutdown#. These two scripts define the standard list of FreeBSD " +"[.filename]#rc.d# keywords and their meanings as follows:" msgstr "" #. type: Labeled list @@ -1339,8 +1340,8 @@ msgstr "" #: documentation/content/en/articles/rc-scripting/_index.adoc:697 msgid "" "The service is to be started manually or not started at all. The automatic " -"startup procedure will ignore the script. In conjunction with the [." -"filename]#shutdown# keyword, this can be used to write scripts that do " +"startup procedure will ignore the script. In conjunction with the " +"[.filename]#shutdown# keyword, this can be used to write scripts that do " "something only at system shutdown." msgstr "" @@ -1362,13 +1363,13 @@ msgstr "" msgid "" "When the system is going to shut down, [.filename]#/etc/rc.shutdown# runs. " "It assumes that most [.filename]#rc.d# scripts have nothing to do at that " -"time. Therefore [.filename]#/etc/rc.shutdown# selectively invokes [." -"filename]#rc.d# scripts with the [.filename]#shutdown# keyword, effectively " -"ignoring the rest of the scripts. For even faster shutdown, [.filename]#/" -"etc/rc.shutdown# passes the [.filename]#faststop# command to the scripts it " -"runs so that they skip preliminary checks, e.g., the pidfile check. As " -"dependent services should be stopped before their prerequisites, [." -"filename]#/etc/rc.shutdown# runs the scripts in reverse dependency order. " +"time. Therefore [.filename]#/etc/rc.shutdown# selectively invokes " +"[.filename]#rc.d# scripts with the [.filename]#shutdown# keyword, " +"effectively ignoring the rest of the scripts. For even faster shutdown, " +"[.filename]#/etc/rc.shutdown# passes the [.filename]#faststop# command to " +"the scripts it runs so that they skip preliminary checks, e.g., the pidfile " +"check. As dependent services should be stopped before their prerequisites, " +"[.filename]#/etc/rc.shutdown# runs the scripts in reverse dependency order. " "If writing a real [.filename]#rc.d# script, you should consider whether it " "is relevant at system shutdown time. E.g., if your script does its work in " "response to the [.filename]#start# command only, then you need not to " @@ -1413,8 +1414,8 @@ msgstr "" #: documentation/content/en/articles/rc-scripting/_index.adoc:736 msgid "" "When invoked during startup or shutdown, an [.filename]#rc.d# script is " -"supposed to act on the entire subsystem it is responsible for. E.g., [." -"filename]#/etc/rc.d/netif# should start or stop all network interfaces " +"supposed to act on the entire subsystem it is responsible for. E.g., " +"[.filename]#/etc/rc.d/netif# should start or stop all network interfaces " "described by man:rc.conf[5]. Either task can be uniquely indicated by a " "single command argument such as `start` or `stop`. Between startup and " "shutdown, [.filename]#rc.d# scripts help the admin to control the running " @@ -1440,9 +1441,9 @@ msgstr "" msgid "" "How can man:rc.subr[8] gain access to the extra command-line arguments. " "Should it just grab them directly? Not by any means. Firstly, an man:sh[1] " -"function has no access to the positional parameters of its caller, but man:" -"rc.subr[8] is just a sack of such functions. Secondly, the good manner of [." -"filename]#rc.d# dictates that it is for the main script to decide which " +"function has no access to the positional parameters of its caller, but " +"man:rc.subr[8] is just a sack of such functions. Secondly, the good manner " +"of [.filename]#rc.d# dictates that it is for the main script to decide which " "arguments are to be passed to its methods." msgstr "" @@ -1662,9 +1663,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/rc-scripting/_index.adoc:856 msgid "" -"To make a script ready for use with extref:../../books/handbook/jails/" -"#service-jails[Service Jails], only one more config line needs to be " -"inserted:" +"To make a script ready for use with extref:{handbook}jails[Service Jails, " +"service-jails], only one more config line needs to be inserted:" msgstr "" #. type: delimited block . 4 @@ -1839,10 +1839,10 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/rc-scripting/_index.adoc:978 msgid "" -"➊ and ➋ make sure to set the name variable to the man:" -"basename[1] of the script name. If the filename is [.filename]#/usr/local/" -"etc/rc.d/dummy#, name is set to [.filename]#dummy#. This way changing the " -"filename of the rc script changes automatically the content of the name " +"➊ and ➋ make sure to set the name variable to the " +"man:basename[1] of the script name. If the filename is [.filename]#/usr/" +"local/etc/rc.d/dummy#, name is set to [.filename]#dummy#. This way changing " +"the filename of the rc script changes automatically the content of the name " "variable." msgstr "" @@ -1906,8 +1906,8 @@ msgid "" "The above creates an instance of the dummy service with the name dummy_foo. " "It does not use the config file [.filename]#/usr/local/etc/dummy.cfg# but " "the config file [.filename]#/usr/local/etc/dummy_foo.cfg# (➐), and it " -"uses the PID file [.filename]#/var/run/dummy/dummy_foo.pid# instead of [." -"filename]#/var/run/dummy/dummy.pid#." +"uses the PID file [.filename]#/var/run/dummy/dummy_foo.pid# instead of " +"[.filename]#/var/run/dummy/dummy.pid#." msgstr "" #. type: Plain text @@ -1933,8 +1933,8 @@ msgstr "" msgid "" "[[lukem]]http://www.mewburn.net/luke/papers/rc.d.pdf[The original article by " "Luke Mewburn] offers a general overview of [.filename]#rc.d# and detailed " -"rationale for its design decisions. It provides insight on the whole [." -"filename]#rc.d# framework and its place in a modern BSD operating system." +"rationale for its design decisions. It provides insight on the whole " +"[.filename]#rc.d# framework and its place in a modern BSD operating system." msgstr "" #. type: Plain text diff --git a/documentation/content/en/articles/releng/_index.adoc b/documentation/content/en/articles/releng/_index.adoc index f19ccb2bdd..56cacf4f0f 100644 --- a/documentation/content/en/articles/releng/_index.adoc +++ b/documentation/content/en/articles/releng/_index.adoc @@ -86,7 +86,7 @@ The ABI stability has improved greatly from the compared to previous releases. In most cases, binaries from the older _STABLE_ systems run unmodified on newer systems, including __HEAD__, assuming that the system management interfaces are not used. In the interim period between releases, weekly snapshots are built automatically by the FreeBSD Project build machines and made available for download from `https:/download.FreeBSD.org/snapshots/`. -The widespread availability of binary release snapshots, and the tendency of our user community to keep up with -STABLE development with Subversion and "`make buildworld`" footnote:[extref:{handbook}[Rebuilding world, makeworld]] helps to keep FreeBSD-STABLE in a very reliable condition even before the quality assurance activities ramp up pending a major release. +The widespread availability of binary release snapshots, and the tendency of our user community to keep up with -STABLE development with Subversion and "`make buildworld`" footnote:[extref:{handbook}cutting-edge[Rebuilding world, makeworld]] helps to keep FreeBSD-STABLE in a very reliable condition even before the quality assurance activities ramp up pending a major release. In addition to installation ISO snapshots, weekly virtual machine images are also provided for use with VirtualBox, qemu, or other popular emulation software. The virtual machine images can be downloaded from `https://download.FreeBSD.org/snapshots/VM-IMAGES/`. @@ -412,7 +412,7 @@ We certainly encourage innovation in the form of advanced installation and admin === Scripting `bsdinstall` The FreeBSD system installation and configuration tool, man:bsdinstall[8], can be scripted to provide automated installs for large sites. -This functionality can be used in conjunction with Intel(R) PXE footnote:[extref:{handbook}[Diskless Operation with PXE, network-diskless]] to bootstrap systems from the network. +This functionality can be used in conjunction with Intel(R) PXE footnote:[extref:{handbook}advanced-networking[Diskless Operation with PXE, network-diskless]] to bootstrap systems from the network. [[lessons-learned]] == Lessons Learned from FreeBSD 4.4 diff --git a/documentation/content/en/articles/releng/_index.po b/documentation/content/en/articles/releng/_index.po index ba3b61c37a..8b786c7a30 100644 --- a/documentation/content/en/articles/releng/_index.po +++ b/documentation/content/en/articles/releng/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2024-12-29 08:30-0500\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -75,15 +75,15 @@ msgstr "" msgid "" "The development of FreeBSD is a very open process. FreeBSD is comprised of " "contributions from thousands of people around the world. The FreeBSD " -"Project provides Subversion footnote:[Subversion, http://subversion.apache." -"org] access to the general public so that others can have access to log " -"messages, diffs (patches) between development branches, and other " -"productivity enhancements that formal source code management provides. This " -"has been a huge help in attracting more talented developers to FreeBSD. " -"However, I think everyone would agree that chaos would soon manifest if " -"write access to the main repository was opened up to everyone on the " -"Internet. Therefore only a \"select\" group of nearly 300 people are given " -"write access to the Subversion repository. These extref:{contributors}" +"Project provides Subversion footnote:[Subversion, http://" +"subversion.apache.org] access to the general public so that others can have " +"access to log messages, diffs (patches) between development branches, and " +"other productivity enhancements that formal source code management " +"provides. This has been a huge help in attracting more talented developers " +"to FreeBSD. However, I think everyone would agree that chaos would soon " +"manifest if write access to the main repository was opened up to everyone on " +"the Internet. Therefore only a \"select\" group of nearly 300 people are " +"given write access to the Subversion repository. These extref:{contributors}" "[FreeBSD committers, staff-committers]footnote:[extref:{contributors}" "[FreeBSD committers, staff-committers]] are usually the people who do the " "bulk of FreeBSD development. An elected link:https://www.FreeBSD.org/" @@ -138,9 +138,9 @@ msgid "" "download from `https:/download.FreeBSD.org/snapshots/`. The widespread " "availability of binary release snapshots, and the tendency of our user " "community to keep up with -STABLE development with Subversion and \"`make " -"buildworld`\" footnote:[extref:{handbook}[Rebuilding world, makeworld]] " -"helps to keep FreeBSD-STABLE in a very reliable condition even before the " -"quality assurance activities ramp up pending a major release." +"buildworld`\" footnote:[extref:{handbook}cutting-edge[Rebuilding world, " +"makeworld]] helps to keep FreeBSD-STABLE in a very reliable condition even " +"before the quality assurance activities ramp up pending a major release." msgstr "" #. type: Plain text @@ -164,8 +164,9 @@ msgstr "" msgid "" "Bug reports and feature requests are continuously submitted by users " "throughout the release cycle. Problems reports are entered into our " -"Bugzilla database through the web interface provided at https://www.freebsd." -"org/support/bugreports/[https://www.freebsd.org/support/bugreports/]." +"Bugzilla database through the web interface provided at https://" +"www.freebsd.org/support/bugreports/[https://www.freebsd.org/support/" +"bugreports/]." msgstr "" #. type: Plain text @@ -733,8 +734,8 @@ msgid "" "must be available. If the device is not loaded into your kernel, then the " "kernel module should be automatically loaded when man:mdconfig[8] is " "executed during the boot media creation phase. All of the tools necessary " -"to build a release are available from the Subversion repository in [." -"filename]#src/release#. These tools aim to provide a consistent way to " +"to build a release are available from the Subversion repository in " +"[.filename]#src/release#. These tools aim to provide a consistent way to " "build FreeBSD releases. A complete release can actually be built with only " "a single command, including the creation of ISO images suitable for burning " "to CDROM or DVD, and an FTP install directory. man:release[7] fully " @@ -767,8 +768,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/releng/_index.adoc:293 msgid "" -"After running these commands, all prepared release files are available in [." -"filename]#/local3/release/R# directory." +"After running these commands, all prepared release files are available in " +"[.filename]#/local3/release/R# directory." msgstr "" #. type: Plain text @@ -861,8 +862,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/releng/_index.adoc:311 msgid "" -"For more information about the release build infrastructure, please see man:" -"release[7]." +"For more information about the release build infrastructure, please see " +"man:release[7]." msgstr "" #. type: delimited block = 4 @@ -901,11 +902,11 @@ msgid "" "Starting with FreeBSD 4.4, the FreeBSD Project decided to release all four " "ISO images that were previously sold on the _BSDi/Wind River Systems/FreeBSD " "Mall_ \"official\" CDROM distributions. Each of the four discs must contain " -"a [.filename]#README.TXT# file that explains the contents of the disc, a [." -"filename]#CDROM.INF# file that provides meta-data for the disc so that man:" -"bsdinstall[8] can validate and use the contents, and a [.filename]#filename." -"txt# file that provides a manifest for the disc. This _manifest_ can be " -"created with a simple command:" +"a [.filename]#README.TXT# file that explains the contents of the disc, a " +"[.filename]#CDROM.INF# file that provides meta-data for the disc so that " +"man:bsdinstall[8] can validate and use the contents, and a " +"[.filename]#filename.txt# file that provides a manifest for the disc. This " +"_manifest_ can be created with a simple command:" msgstr "" #. type: delimited block . 4 @@ -944,10 +945,10 @@ msgid "" "man:release[7] must be updated to include installation instructions. The " "relevant code is contained in [.filename]#src/release# and [.filename]#src/" "usr.sbin/bsdinstall#. Specifically, the file [.filename]#src/release/" -"Makefile#, and [.filename]#dist.c#, [.filename]#dist.h#, [.filename]#menus." -"c#, [.filename]#install.c#, and [.filename]#Makefile# will need to be " -"updated under [.filename]#src/usr.sbin/bsdinstall#. Optionally, you may " -"choose to update [.filename]#bsdinstall.8#." +"Makefile#, and [.filename]#dist.c#, [.filename]#dist.h#, " +"[.filename]#menus.c#, [.filename]#install.c#, and [.filename]#Makefile# will " +"need to be updated under [.filename]#src/usr.sbin/bsdinstall#. Optionally, " +"you may choose to update [.filename]#bsdinstall.8#." msgstr "" #. type: Title ==== @@ -962,9 +963,9 @@ msgid "" "The second disc is also largely created by `make release`. This disc " "contains a \"live filesystem\" that can be used from man:bsdinstall[8] to " "troubleshoot a FreeBSD installation. This disc should be bootable and " -"should also contain a compressed copy of the CVS repository in the [." -"filename]#CVSROOT# directory and commercial software demos in the [." -"filename]#commerce# directory." +"should also contain a compressed copy of the CVS repository in the " +"[.filename]#CVSROOT# directory and commercial software demos in the " +"[.filename]#commerce# directory." msgstr "" #. type: Title ==== @@ -1139,8 +1140,8 @@ msgid "" "The FreeBSD system installation and configuration tool, man:bsdinstall[8], " "can be scripted to provide automated installs for large sites. This " "functionality can be used in conjunction with Intel(R) PXE footnote:[extref:" -"{handbook}[Diskless Operation with PXE, network-diskless]] to bootstrap " -"systems from the network." +"{handbook}advanced-networking[Diskless Operation with PXE, network-" +"diskless]] to bootstrap systems from the network." msgstr "" #. type: Title == @@ -1243,11 +1244,11 @@ msgid "" "community. I would also like to thank `{rgrimes}`, `{phk}`, and others who " "worked on the release engineering tools in the very early days of FreeBSD. " "This article was influenced by release engineering documents from the CSRG " -"footnote:[Marshall Kirk McKusick, Michael J. Karels, and Keith Bostic: link:" -"http://docs.FreeBSD.org/44doc/papers/releng.html[The Release Engineering of " -"4.3BSD]] , the NetBSD Project, footnote:[NetBSD Developer Documentation: " -"Release Engineering http://www.NetBSD.org/developers/releng/index.html] , " -"and John Baldwin's proposed release engineering process notes. footnote:" -"[John Baldwin's FreeBSD Release Engineering Proposal https://people.FreeBSD." -"org/~jhb/docs/releng.txt]" +"footnote:[Marshall Kirk McKusick, Michael J. Karels, and Keith Bostic: " +"link:http://docs.FreeBSD.org/44doc/papers/releng.html[The Release " +"Engineering of 4.3BSD]] , the NetBSD Project, footnote:[NetBSD Developer " +"Documentation: Release Engineering http://www.NetBSD.org/developers/releng/" +"index.html] , and John Baldwin's proposed release engineering process notes. " +"footnote:[John Baldwin's FreeBSD Release Engineering Proposal https://" +"people.FreeBSD.org/~jhb/docs/releng.txt]" msgstr "" diff --git a/documentation/content/en/articles/remote-install/_index.adoc b/documentation/content/en/articles/remote-install/_index.adoc index ba9bf48256..2575637b94 100644 --- a/documentation/content/en/articles/remote-install/_index.adoc +++ b/documentation/content/en/articles/remote-install/_index.adoc @@ -233,7 +233,7 @@ Repeat the following command for each hard drive: Next, create slices and label them with your preferred tool. While it is considered easier to use `sysinstall`, a powerful and also probably less buggy method will be to use standard text-based UNIX(R) tools, such as man:fdisk[8] and man:bsdlabel[8], which will also be covered in this section. -The former option is well documented in the extref:{handbook}[Installing FreeBSD, install-steps] chapter of the FreeBSD Handbook. +The former option is well documented in the extref:{handbook}install[Installing FreeBSD, install-steps] chapter of the FreeBSD Handbook. As it was mentioned in the introduction, this article will present how to set up a system with RAID-1 and ZFS capabilities. Our set up will consist of a small man:gmirror[8] mirrored [.filename]#/# (root), [.filename]#/usr# and [.filename]#/var# dataset, and the rest of the disk space will be allocated for a man:zpool[8] mirrored ZFS file system. Please note, that the ZFS file system will be configured after the FreeBSD operating system is successfully installed and booted. diff --git a/documentation/content/en/articles/remote-install/_index.po b/documentation/content/en/articles/remote-install/_index.po index 76131829e7..2f4bb39a84 100644 --- a/documentation/content/en/articles/remote-install/_index.po +++ b/documentation/content/en/articles/remote-install/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2024-12-29 08:30-0500\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -257,8 +257,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/remote-install/_index.adoc:137 msgid "" -"Do not forget to add the `defaultrouter` information to [.filename]#conf/rc." -"conf#:" +"Do not forget to add the `defaultrouter` information to [.filename]#conf/" +"rc.conf#:" msgstr "" #. type: delimited block . 4 @@ -276,9 +276,9 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/remote-install/_index.adoc:147 msgid "" -"When the network interface driver is known, it is more convenient to use [." -"filename]#conf/rc.conf# for networking options. The syntax of this file is " -"the same as the one used in the standard man:rc.conf[5] file of FreeBSD." +"When the network interface driver is known, it is more convenient to use " +"[.filename]#conf/rc.conf# for networking options. The syntax of this file " +"is the same as the one used in the standard man:rc.conf[5] file of FreeBSD." msgstr "" #. type: Plain text @@ -452,17 +452,17 @@ msgstr "" msgid "" "Next, create slices and label them with your preferred tool. While it is " "considered easier to use `sysinstall`, a powerful and also probably less " -"buggy method will be to use standard text-based UNIX(R) tools, such as man:" -"fdisk[8] and man:bsdlabel[8], which will also be covered in this section. " -"The former option is well documented in the extref:{handbook}[Installing " -"FreeBSD, install-steps] chapter of the FreeBSD Handbook. As it was " -"mentioned in the introduction, this article will present how to set up a " -"system with RAID-1 and ZFS capabilities. Our set up will consist of a small " -"man:gmirror[8] mirrored [.filename]#/# (root), [.filename]#/usr# and [." -"filename]#/var# dataset, and the rest of the disk space will be allocated " -"for a man:zpool[8] mirrored ZFS file system. Please note, that the ZFS file " -"system will be configured after the FreeBSD operating system is successfully " -"installed and booted." +"buggy method will be to use standard text-based UNIX(R) tools, such as " +"man:fdisk[8] and man:bsdlabel[8], which will also be covered in this " +"section. The former option is well documented in the extref:{handbook}" +"install[Installing FreeBSD, install-steps] chapter of the FreeBSD Handbook. " +"As it was mentioned in the introduction, this article will present how to " +"set up a system with RAID-1 and ZFS capabilities. Our set up will consist " +"of a small man:gmirror[8] mirrored [.filename]#/# (root), [.filename]#/usr# " +"and [.filename]#/var# dataset, and the rest of the disk space will be " +"allocated for a man:zpool[8] mirrored ZFS file system. Please note, that " +"the ZFS file system will be configured after the FreeBSD operating system is " +"successfully installed and booted." msgstr "" #. type: Plain text @@ -568,9 +568,9 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/remote-install/_index.adoc:293 msgid "" -"When you are done, start man:sysinstall[8]. Select the [." -"guimenuitem]#Custom# installation from the main menu. Select [." -"guimenuitem]#Options# and press kbd:[Enter]. With the help of arrow keys, " +"When you are done, start man:sysinstall[8]. Select the " +"[.guimenuitem]#Custom# installation from the main menu. Select " +"[.guimenuitem]#Options# and press kbd:[Enter]. With the help of arrow keys, " "move the cursor on the `Install Root` item, press kbd:[Space] and change it " "to [.filename]#/mnt#. Press kbd:[Enter] to submit your changes and exit the " "[.guimenuitem]#Options# menu by pressing kbd:[q]." @@ -610,8 +610,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/remote-install/_index.adoc:314 msgid "" -"Finally, perform the system installation by selecting the last option, [." -"guimenuitem]#Commit#. Exit `sysinstall` when it finishes the installation." +"Finally, perform the system installation by selecting the last option, " +"[.guimenuitem]#Commit#. Exit `sysinstall` when it finishes the installation." msgstr "" #. type: Title === @@ -661,8 +661,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/remote-install/_index.adoc:338 msgid "" -"Create the [.filename]#/etc/rc.conf#, [.filename]#/etc/resolv.conf# and [." -"filename]#/etc/fstab# files. Do not forget to properly set the network " +"Create the [.filename]#/etc/rc.conf#, [.filename]#/etc/resolv.conf# and " +"[.filename]#/etc/fstab# files. Do not forget to properly set the network " "information and to enable sshd in [.filename]#/etc/rc.conf#. The contents of " "[.filename]#/etc/fstab# will be similar to the following:" msgstr "" @@ -742,8 +742,8 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/remote-install/_index.adoc:376 msgid "" -"The only remaining step is to configure man:zpool[8] and create some man:" -"zfs[8] file systems. Creating and administering ZFS is very " +"The only remaining step is to configure man:zpool[8] and create some " +"man:zfs[8] file systems. Creating and administering ZFS is very " "straightforward. First, create a mirrored pool:" msgstr "" diff --git a/documentation/content/en/articles/serial-uart/_index.adoc b/documentation/content/en/articles/serial-uart/_index.adoc index 3852251b85..e953644b93 100644 --- a/documentation/content/en/articles/serial-uart/_index.adoc +++ b/documentation/content/en/articles/serial-uart/_index.adoc @@ -445,7 +445,7 @@ Modems operating at 28,800 and higher speeds have variable Symbol rates, but the === The IBM Personal Computer UART -Starting with the original IBM Personal Computer, IBM selected the National Semiconductor INS8250 UART for use in the IBM PC Parallel/Serial Adapter. +Starting with the original IBM Personal Computer, IBM selected the National Semiconductor INS8250 UART for use in the IBM PC Parallel/Serial Adapter. Subsequent generations of compatible computers from IBM and other vendors continued to use the INS8250 or improved versions of the National Semiconductor UART family. ==== National Semiconductor UART Family Tree @@ -815,7 +815,7 @@ Bit 0 -> Delta Clear To Send (DCTS). Set to "1" if the -CTS line has changed sta === Beyond the 16550A UART -Although National Semiconductor has not offered any components compatible with the 16550 that provide additional features, various other vendors have. +Although National Semiconductor has not offered any components compatible with the 16550 that provide additional features, various other vendors have. Some of these components are described below. It should be understood that to effectively utilize these improvements, drivers may have to be provided by the chip vendor since most of the popular operating systems do not support features beyond those provided by the 16550. @@ -839,7 +839,7 @@ This leaves the designer free to components that may have better performance cha [[sio]] == Configuring the [.filename]#sio# driver -The [.filename]#sio# driver provides support for NS8250-, NS16450-, NS16550 and NS16550A-based EIA RS-232C (CCITT V.24) communications interfaces. +The [.filename]#sio# driver provides support for NS8250-, NS16450-, NS16550 and NS16550A-based EIA RS-232C (CCITT V.24) communications interfaces. Several multiport cards are supported as well. See the man:sio[4] manual page for detailed technical documentation. @@ -878,12 +878,12 @@ One important note - the actual UART chips for the Boca 16 are in the connector So if you have it unplugged, probes of those ports will fail. I have never tested booting with the box unplugged and plugging it back in, and I suggest you do not either. -If you do not already have a custom kernel configuration file set up, refer to extref:{handbook}[Kernel Configuration, kernelconfig] chapter of the FreeBSD Handbook for general procedures. +If you do not already have a custom kernel configuration file set up, refer to extref:{handbook}kernelconfig[Kernel Configuration, kernelconfig] chapter of the FreeBSD Handbook for general procedures. The following are the specifics for the Boca 16 board and assume you are using the kernel name MYKERNEL and editing with vi. [.procedure] ==== -. Add the line +. Add the line + [.programlisting] .... @@ -905,7 +905,7 @@ device sio16 at isa? port 0x178 flags 0x1005 irq 3 + The flags entry _must_ be changed from this example unless you are using the exact same sio assignments. Flags are set according to 0x``__MYY__`` where _M_ indicates the minor number of the master port (the last port on a Boca 16) and _YY_ indicates if FIFO is enabled or disabled(enabled), IRQ sharing is used(yes) and if there is an AST/4 compatible IRQ control register(no). -In this example, +In this example, + [.programlisting] .... @@ -953,7 +953,7 @@ sio16 at 0x178-0x17f irq 3 flags 0x1005 on isa sio16: type 16550A (multiport master) .... + -If the messages go by too fast to see, +If the messages go by too fast to see, + [source,shell] .... @@ -976,7 +976,7 @@ If you do need to create the [.filename]#/dev# entries, run the following as `ro .... + If you do not want or need call-out devices for some reason, you can dispense with making the [.filename]#cua*# devices. -. If you want a quick and sloppy way to make sure the devices are working, you can simply plug a modem into each port and (as root) +. If you want a quick and sloppy way to make sure the devices are working, you can simply plug a modem into each port and (as root) + [source,shell] .... diff --git a/documentation/content/en/articles/serial-uart/_index.po b/documentation/content/en/articles/serial-uart/_index.po index 62713aaccd..a806ddaa05 100644 --- a/documentation/content/en/articles/serial-uart/_index.po +++ b/documentation/content/en/articles/serial-uart/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2022-02-01 10:28-0300\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -280,8 +280,8 @@ msgstr "" #: documentation/content/en/articles/serial-uart/_index.adoc:134 msgid "" "In RS232-C, a value of `1` is called a `Mark` and a value of `0` is called a " -"`Space`. When a communication line is idle, the line is said to be \"Marking" -"\", or transmitting continuous `1` values." +"`Space`. When a communication line is idle, the line is said to be " +"\"Marking\", or transmitting continuous `1` values." msgstr "" #. type: Plain text @@ -1697,12 +1697,12 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/serial-uart/_index.adoc:563 msgid "" -"In internal modems, the modem designer will frequently emulate the " -"8250A/16450 with the modem microprocessor, and the emulated UART will " -"frequently have a hidden buffer consisting of several hundred bytes. Due to " -"the size of the buffer, these emulations can be as reliable as a 16550A in " -"their ability to handle high speed data. However, most operating systems " -"will still report that the UART is only a 8250A or 16450, and may not make " +"In internal modems, the modem designer will frequently emulate the 8250A/" +"16450 with the modem microprocessor, and the emulated UART will frequently " +"have a hidden buffer consisting of several hundred bytes. Due to the size " +"of the buffer, these emulations can be as reliable as a 16550A in their " +"ability to handle high speed data. However, most operating systems will " +"still report that the UART is only a 8250A or 16450, and may not make " "effective use of the extra buffering present in the emulated UART unless " "special drivers are used." msgstr "" @@ -1993,10 +1993,11 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/serial-uart/_index.adoc:665 msgid "" -"[.filename]#COM1# is located from 0x3f8 to 0x3ff and normally uses IRQ 4. [." -"filename]#COM2# is located from 0x2f8 to 0x2ff and normally uses IRQ 3. [." -"filename]#COM3# is located from 0x3e8 to 0x3ef and has no standardized IRQ. " -"[.filename]#COM4# is located from 0x2e8 to 0x2ef and has no standardized IRQ." +"[.filename]#COM1# is located from 0x3f8 to 0x3ff and normally uses IRQ 4. " +"[.filename]#COM2# is located from 0x2f8 to 0x2ff and normally uses IRQ 3. " +"[.filename]#COM3# is located from 0x3e8 to 0x3ef and has no standardized " +"IRQ. [.filename]#COM4# is located from 0x2e8 to 0x2ef and has no " +"standardized IRQ." msgstr "" #. type: Plain text @@ -2459,10 +2460,10 @@ msgstr "" #: documentation/content/en/articles/serial-uart/_index.adoc:883 msgid "" "If you do not already have a custom kernel configuration file set up, refer " -"to extref:{handbook}[Kernel Configuration, kernelconfig] chapter of the " -"FreeBSD Handbook for general procedures. The following are the specifics " -"for the Boca 16 board and assume you are using the kernel name MYKERNEL and " -"editing with vi." +"to extref:{handbook}kernelconfig[Kernel Configuration, kernelconfig] chapter " +"of the FreeBSD Handbook for general procedures. The following are the " +"specifics for the Boca 16 board and assume you are using the kernel name " +"MYKERNEL and editing with vi." msgstr "" #. type: delimited block = 4 @@ -2665,8 +2666,8 @@ msgstr "" #. type: delimited block = 4 #: documentation/content/en/articles/serial-uart/_index.adoc:991 msgid "" -"_Contributed by Helge Oldach_ mailto:hmo@sep.hamburg.com[hmo@sep.hamburg." -"com], September 1999" +"_Contributed by Helge Oldach_ " +"mailto:hmo@sep.hamburg.com[hmo@sep.hamburg.com], September 1999" msgstr "" #. type: delimited block = 4 @@ -2680,9 +2681,9 @@ msgstr "" #: documentation/content/en/articles/serial-uart/_index.adoc:997 msgid "" "Usually the only option to support these kind of boards is to use a distinct " -"IRQ for each port. For example, if your CPU board has an on-board [." -"filename]#COM1# port (aka [.filename]#sio0#-I/O address 0x3F8 and IRQ 4) and " -"you have an extension board with two UARTs, you will commonly need to " +"IRQ for each port. For example, if your CPU board has an on-board " +"[.filename]#COM1# port (aka [.filename]#sio0#-I/O address 0x3F8 and IRQ 4) " +"and you have an extension board with two UARTs, you will commonly need to " "configure them as [.filename]#COM2# (aka [.filename]#sio1#-I/O address 0x2F8 " "and IRQ 3), and the third port (aka [.filename]#sio2#) as I/O 0x3E8 and IRQ " "5. Obviously this is a waste of IRQ resources, as it should be basically " @@ -2734,9 +2735,9 @@ msgstr "" msgid "" "You need to decouple the IRQ drivers for the two UARTs, so that the IRQ line " "of the board only goes up if (and only if) one of the UARTs asserts a IRQ, " -"and stays low otherwise. The solution was proposed by Joerg Wunsch mailto:" -"j@ida.interface-business.de[j@ida.interface-business.de]: To solder up a " -"wired-or consisting of two diodes (Germanium or Schottky-types strongly " +"and stays low otherwise. The solution was proposed by Joerg Wunsch " +"mailto:j@ida.interface-business.de[j@ida.interface-business.de]: To solder " +"up a wired-or consisting of two diodes (Germanium or Schottky-types strongly " "preferred) and a 1 kOhm resistor. Here is the schematic, starting from the " "4 by 3 jumper field above:" msgstr "" @@ -3025,9 +3026,9 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/serial-uart/_index.adoc:1165 msgid "" -"After rebooting with the new kernel, you need to make the device nodes in [." -"filename]#/dev#. The [.filename]#MAKEDEV# script will take care of this for " -"you. Count how many total ports you have and type:" +"After rebooting with the new kernel, you need to make the device nodes in " +"[.filename]#/dev#. The [.filename]#MAKEDEV# script will take care of this " +"for you. Count how many total ports you have and type:" msgstr "" #. type: delimited block . 4 diff --git a/documentation/content/en/articles/vinum/_index.adoc b/documentation/content/en/articles/vinum/_index.adoc index e1c87acf48..6c078fa1c6 100644 --- a/documentation/content/en/articles/vinum/_index.adoc +++ b/documentation/content/en/articles/vinum/_index.adoc @@ -74,7 +74,7 @@ Users are advised to migrate to man:gconcat[8], man:gmirror[8], man:gstripe[8], [NOTE] ==== -Starting with FreeBSD 5, [.filename]#vinum# has been rewritten to fit into the extref:{handbook}[GEOM architecture, geom], while retaining the original ideas, terminology, and on-disk metadata. +Starting with FreeBSD 5, [.filename]#vinum# has been rewritten to fit into the extref:{handbook}geom[GEOM architecture, geom], while retaining the original ideas, terminology, and on-disk metadata. This rewrite is called _gvinum_ (for _GEOM vinum_). While this chapter uses the term [.filename]#vinum#, any command invocations should be performed with `gvinum`. The name of the kernel module has changed from the original [.filename]#vinum.ko# to [.filename]#geom_vinum.ko#, and all device nodes reside under [.filename]#/dev/gvinum# instead of [.filename]#/dev/vinum#. @@ -545,7 +545,7 @@ This enables [.filename]#vinum# to identify drives correctly even if they have b _Gvinum_ always features an automatic startup once the kernel module is loaded, via man:loader.conf[5]. To load the _Gvinum_ module at boot time, add `geom_vinum_load="YES"` to [.filename]#/boot/loader.conf#. -When [.filename]#vinum# is started with `gvinum start`, [.filename]#vinum# reads the configuration database from one of the [.filename]#vinum# drives. +When [.filename]#vinum# is started with `gvinum start`, [.filename]#vinum# reads the configuration database from one of the [.filename]#vinum# drives. Under normal circumstances, each drive contains an identical copy of the configuration database, so it does not matter which drive is read. After a crash, however, [.filename]#vinum# must determine which drive was updated most recently and read the configuration from this drive. It then updates the configuration, if necessary, from progressively older drives. @@ -563,7 +563,7 @@ In the following sections, the term "root volume" is generally used to describe === Starting up [.filename]#vinum# Early Enough for the Root File System -[.filename]#vinum# must be available early in the system boot as man:loader[8] must be able to load the vinum kernel module before starting the kernel. +[.filename]#vinum# must be available early in the system boot as man:loader[8] must be able to load the vinum kernel module before starting the kernel. This can be accomplished by putting this line in [.filename]#/boot/loader.conf#: [.programlisting] @@ -707,7 +707,7 @@ If this file system is to be mounted read-write later on, it is necessary to rem ==== Only Primary Bootstrap Loads If [.filename]#/boot/loader# fails to load, but the primary bootstrap still loads (visible by a single dash in the left column of the screen right after the boot process starts), an attempt can be made to interrupt the primary bootstrap by pressing kbd:[space]. -This will make the bootstrap stop in extref:{handbook}[stage two, boot-boot1]. +This will make the bootstrap stop in extref:{handbook}boot[stage two, boot-boot1]. An attempt can be made here to boot off an alternate partition, like the partition containing the previous root file system that has been moved away from `a`. [[vinum-root-panic]] @@ -718,6 +718,6 @@ Unfortunately, [.filename]#vinum# accidentally leaves only 4 KB at the beginning However, the stage one and two bootstraps plus the bsdlabel require 8 KB. So if a [.filename]#vinum# partition was started at offset 0 within a slice or disk that was meant to be bootable, the [.filename]#vinum# setup will trash the bootstrap. -Similarly, if the above situation has been recovered, by booting from a "Fixit" media, and the bootstrap has been re-installed using `bsdlabel -B` as described in extref:{handbook}[stage two, boot-boot1], the bootstrap will trash the [.filename]#vinum# header, and [.filename]#vinum# will no longer find its disk(s). +Similarly, if the above situation has been recovered, by booting from a "Fixit" media, and the bootstrap has been re-installed using `bsdlabel -B` as described in extref:{handbook}boot[stage two, boot-boot1], the bootstrap will trash the [.filename]#vinum# header, and [.filename]#vinum# will no longer find its disk(s). Though no actual [.filename]#vinum# configuration data or data in [.filename]#vinum# volumes will be trashed, and it would be possible to recover all the data by entering exactly the same [.filename]#vinum# configuration data again, the situation is hard to fix. It is necessary to move the entire [.filename]#vinum# partition by at least 4 KB, to have the [.filename]#vinum# header and the system bootstrap no longer collide. diff --git a/documentation/content/en/articles/vinum/_index.po b/documentation/content/en/articles/vinum/_index.po index fa6bf155d1..3aff218a96 100644 --- a/documentation/content/en/articles/vinum/_index.po +++ b/documentation/content/en/articles/vinum/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2025-01-24 10:22-0300\n" +"POT-Creation-Date: 2025-11-08 16:17+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -88,15 +88,15 @@ msgstr "" #: documentation/content/en/articles/vinum/_index.adoc:82 msgid "" "Starting with FreeBSD 5, [.filename]#vinum# has been rewritten to fit into " -"the extref:{handbook}[GEOM architecture, geom], while retaining the original " -"ideas, terminology, and on-disk metadata. This rewrite is called _gvinum_ " -"(for _GEOM vinum_). While this chapter uses the term [.filename]#vinum#, " -"any command invocations should be performed with `gvinum`. The name of the " -"kernel module has changed from the original [.filename]#vinum.ko# to " -"[.filename]#geom_vinum.ko#, and all device nodes reside under [.filename]#/" -"dev/gvinum# instead of [.filename]#/dev/vinum#. As of FreeBSD 6, the " -"original [.filename]#vinum# implementation is no longer available in the " -"code base." +"the extref:{handbook}geom[GEOM architecture, geom], while retaining the " +"original ideas, terminology, and on-disk metadata. This rewrite is called " +"_gvinum_ (for _GEOM vinum_). While this chapter uses the term " +"[.filename]#vinum#, any command invocations should be performed with " +"`gvinum`. The name of the kernel module has changed from the original " +"[.filename]#vinum.ko# to [.filename]#geom_vinum.ko#, and all device nodes " +"reside under [.filename]#/dev/gvinum# instead of [.filename]#/dev/vinum#. " +"As of FreeBSD 6, the original [.filename]#vinum# implementation is no longer " +"available in the code base." msgstr "" #. type: Title == @@ -1621,9 +1621,9 @@ msgid "" "loads (visible by a single dash in the left column of the screen right after " "the boot process starts), an attempt can be made to interrupt the primary " "bootstrap by pressing kbd:[space]. This will make the bootstrap stop in " -"extref:{handbook}[stage two, boot-boot1]. An attempt can be made here to " -"boot off an alternate partition, like the partition containing the previous " -"root file system that has been moved away from `a`." +"extref:{handbook}boot[stage two, boot-boot1]. An attempt can be made here " +"to boot off an alternate partition, like the partition containing the " +"previous root file system that has been moved away from `a`." msgstr "" #. type: Title ==== @@ -1650,12 +1650,13 @@ msgstr "" msgid "" "Similarly, if the above situation has been recovered, by booting from a " "\"Fixit\" media, and the bootstrap has been re-installed using `bsdlabel -B` " -"as described in extref:{handbook}[stage two, boot-boot1], the bootstrap will " -"trash the [.filename]#vinum# header, and [.filename]#vinum# will no longer " -"find its disk(s). Though no actual [.filename]#vinum# configuration data or " -"data in [.filename]#vinum# volumes will be trashed, and it would be possible " -"to recover all the data by entering exactly the same [.filename]#vinum# " -"configuration data again, the situation is hard to fix. It is necessary to " -"move the entire [.filename]#vinum# partition by at least 4 KB, to have the " -"[.filename]#vinum# header and the system bootstrap no longer collide." +"as described in extref:{handbook}boot[stage two, boot-boot1], the bootstrap " +"will trash the [.filename]#vinum# header, and [.filename]#vinum# will no " +"longer find its disk(s). Though no actual [.filename]#vinum# configuration " +"data or data in [.filename]#vinum# volumes will be trashed, and it would be " +"possible to recover all the data by entering exactly the same " +"[.filename]#vinum# configuration data again, the situation is hard to fix. " +"It is necessary to move the entire [.filename]#vinum# partition by at least " +"4 KB, to have the [.filename]#vinum# header and the system bootstrap no " +"longer collide." msgstr "" |