diff options
Diffstat (limited to 'documentation/content/en/articles/committers-guide/_index.po')
| -rw-r--r-- | documentation/content/en/articles/committers-guide/_index.po | 8465 |
1 files changed, 8465 insertions, 0 deletions
diff --git a/documentation/content/en/articles/committers-guide/_index.po b/documentation/content/en/articles/committers-guide/_index.po new file mode 100644 index 0000000000..bb85f6fe75 --- /dev/null +++ b/documentation/content/en/articles/committers-guide/_index.po @@ -0,0 +1,8465 @@ +# SOME DESCRIPTIVE TITLE +# Copyright (C) YEAR The FreeBSD Project +# This file is distributed under the same license as the FreeBSD Documentation package. +# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: FreeBSD Documentation VERSION\n" +"POT-Creation-Date: 2024-01-17 20:35-0300\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" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#. type: YAML Front Matter: description +#: documentation/content/en/articles/committers-guide/_index.adoc:1 +#, no-wrap +msgid "Introductory information for FreeBSD committers" +msgstr "" + +#. type: Title = +#: documentation/content/en/articles/committers-guide/_index.adoc:1 +#: documentation/content/en/articles/committers-guide/_index.adoc:12 +#, no-wrap +msgid "Committer's Guide" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:45 +msgid "Abstract" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:48 +msgid "" +"This document provides information for the FreeBSD committer community. All " +"new committers should read this document before they start, and existing " +"committers are strongly encouraged to review it from time to time." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:53 +msgid "" +"Almost all FreeBSD developers have commit rights to one or more " +"repositories. However, a few developers do not, and some of the information " +"here applies to them as well. (For instance, some people only have rights " +"to work with the Problem Report database.) Please see <<non-committers>> " +"for more information." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:55 +msgid "" +"This document may also be of interest to members of the FreeBSD community " +"who want to learn more about how the project works." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:57 +msgid "'''" +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:61 +#, no-wrap +msgid "Administrative Details" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:68 +#, no-wrap +msgid "_Login Methods_" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:70 +#, no-wrap +msgid "man:ssh[1], protocol 2 only" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:71 +#, no-wrap +msgid "_Main Shell Host_" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:73 +#, no-wrap +msgid "`freefall.FreeBSD.org`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:74 +#, no-wrap +msgid "_Reference Machines_" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:76 +#, no-wrap +msgid "`ref*.FreeBSD.org`, `universe*.freeBSD.org` (see also link:https://www.FreeBSD.org/internal/machines/[FreeBSD Project Hosts])" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:77 +#, no-wrap +msgid "_SMTP Host_" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:79 +#, no-wrap +msgid "`smtp.FreeBSD.org:587` (see also <<smtp-setup>>)." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:80 +#, no-wrap +msgid "`_src/_` Git Repository" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:82 +#, no-wrap +msgid "`ssh://git@gitrepo.FreeBSD.org/src.git`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:83 +#, no-wrap +msgid "`_doc/_` Git Repository" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:85 +#, no-wrap +msgid "`ssh://git@gitrepo.FreeBSD.org/doc.git`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:86 +#, no-wrap +msgid "`_ports/_` Git Repository" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:88 +#, no-wrap +msgid "`ssh://git@gitrepo.FreeBSD.org/ports.git`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:89 +#, no-wrap +msgid "_Internal Mailing Lists_" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:91 +#, no-wrap +msgid "developers (technically called all-developers), doc-developers, doc-committers, ports-developers, ports-committers, src-developers, src-committers. (Each project repository has its own -developers and -committers mailing lists. Archives for these lists can be found in the files [.filename]#/local/mail/repository-name-developers-archive# and [.filename]#/local/mail/repository-name-committers-archive# on `freefall.FreeBSD.org`.)" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:92 +#, no-wrap +msgid "_Core Team monthly reports_" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:94 +#, no-wrap +msgid "[.filename]#/home/core/public/reports# on the `FreeBSD.org` cluster." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:95 +#, no-wrap +msgid "_Ports Management Team monthly reports_" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:97 +#, no-wrap +msgid "[.filename]#/home/portmgr/public/monthly-reports# on the `FreeBSD.org` cluster." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:98 +#, no-wrap +msgid "_Noteworthy `src/` Git Branches:_" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:99 +#, no-wrap +msgid "`stable/n` (`n`-STABLE), `main` (-CURRENT)" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:102 +msgid "" +"man:ssh[1] is required to connect to the project hosts. For more " +"information, see <<ssh.guide>>." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:104 +msgid "Useful links:" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:106 +msgid "link:https://www.FreeBSD.org/internal/[FreeBSD Project Internal Pages]" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:107 +msgid "link:https://www.FreeBSD.org/internal/machines/[FreeBSD Project Hosts]" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:108 +msgid "" +"link:https://www.FreeBSD.org/administration/[FreeBSD Project Administrative " +"Groups]" +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:110 +#, no-wrap +msgid "OpenPGP Keys for FreeBSD" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:115 +msgid "" +"Cryptographic keys conforming to the OpenPGP (__Pretty Good Privacy__) " +"standard are used by the FreeBSD project to authenticate committers. " +"Messages carrying important information like public SSH keys can be signed " +"with the OpenPGP key to prove that they are really from the committer. See " +"https://nostarch.com/releases/pgp_release.pdf[PGP & GPG: Email for the " +"Practical Paranoid by Michael Lucas] and http://en.wikipedia.org/wiki/" +"Pretty_Good_Privacy[] for more information." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:117 +#, no-wrap +msgid "Creating a Key" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:121 +msgid "" +"Existing keys can be used, but should be checked with [." +"filename]#documentation/tools/checkkey.sh# first. In this case, make sure " +"the key has a FreeBSD user ID." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:123 +msgid "" +"For those who do not yet have an OpenPGP key, or need a new key to meet " +"FreeBSD security requirements, here we show how to generate one." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:128 +msgid "" +"Install [.filename]#security/gnupg#. Enter these lines in [.filename]#~/." +"gnupg/gpg.conf# to set minimum acceptable defaults for signing and new key " +"preferences (see the link:https://www.gnupg.org/documentation/manuals/gnupg/" +"GPG-Options.html[GnuPG options documentation] for more details):" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:135 +#, no-wrap +msgid "" +"# Sorted list of preferred algorithms for signing (strongest to weakest).\n" +"personal-digest-preferences SHA512 SHA384 SHA256 SHA224\n" +"# Default preferences for new keys\n" +"default-preference-list SHA512 SHA384 SHA256 SHA224 AES256 CAMELLIA256 AES192 CAMELLIA192 AES CAMELLIA128 CAST5 BZIP2 ZLIB ZIP Uncompressed\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:137 +msgid "Generate a key:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:144 +#, no-wrap +msgid "" +"% gpg --full-gen-key\n" +"gpg (GnuPG) 2.1.8; Copyright (C) 2015 Free Software Foundation, Inc.\n" +"This is free software: you are free to change and redistribute it.\n" +"There is NO WARRANTY, to the extent permitted by law.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:165 +#, no-wrap +msgid "" +"Warning: using insecure memory!\n" +"Please select what kind of key you want:\n" +" (1) RSA and RSA (default)\n" +" (2) DSA and Elgamal\n" +" (3) DSA (sign only)\n" +" (4) RSA (sign only)\n" +"Your selection? 1\n" +"RSA keys may be between 1024 and 4096 bits long.\n" +"What keysize do you want? (2048) 2048 <.>\n" +"Requested keysize is 2048 bits\n" +"Please specify how long the key should be valid.\n" +"\t 0 = key does not expire\n" +" <n> = key expires in n days\n" +" <n>w = key expires in n weeks\n" +" <n>m = key expires in n months\n" +" <n>y = key expires in n years\n" +"Key is valid for? (0) 3y <.>\n" +"Key expires at Wed Nov 4 17:20:20 2015 MST\n" +"Is this correct? (y/N) y\n" +"GnuPG needs to construct a user ID to identify your key.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:171 +#, no-wrap +msgid "" +"Real name: Chucky Daemon <.>\n" +"Email address: notreal@example.com\n" +"Comment:\n" +"You selected this USER-ID:\n" +"\"Chucky Daemon <notreal@example.com>\"\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:174 +#, no-wrap +msgid "" +"Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? o\n" +"You need a Passphrase to protect your secret key.\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:177 +msgid "" +"2048-bit keys with a three-year expiration provide adequate protection at " +"present (2022-10)." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:179 +msgid "" +"A three year key lifespan is short enough to obsolete keys weakened by " +"advancing computer power, but long enough to reduce key management problems." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:181 +msgid "" +"Use your real name here, preferably matching that shown on government-issued " +"ID to make it easier for others to verify your identity. Text that may help " +"others identify you can be entered in the `Comment` section." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:185 +msgid "" +"After the email address is entered, a passphrase is requested. Methods of " +"creating a secure passphrase are contentious. Rather than suggest a single " +"way, here are some links to sites that describe various methods: https://" +"world.std.com/~reinhold/diceware.html[], https://www.iusmentis.com/security/" +"passphrasefaq/[], https://xkcd.com/936/[], https://en.wikipedia.org/wiki/" +"Passphrase[]." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:189 +msgid "" +"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." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:191 +msgid "" +"Committing the new key is shown in <<commit-steps, Steps for New " +"Committers>>." +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:193 +#, no-wrap +msgid "Kerberos and LDAP web Password for FreeBSD Cluster" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:198 +msgid "" +"The FreeBSD cluster requires a Kerberos password to access certain " +"services. The Kerberos password also serves as the LDAP web password, since " +"LDAP is proxying to Kerberos in the cluster. Some of the services which " +"require this include:" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:200 +msgid "https://bugs.freebsd.org/bugzilla[Bugzilla]" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:201 +msgid "https://ci.freebsd.org[Jenkins]" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:203 +msgid "" +"To create a new Kerberos account in the FreeBSD cluster, or to reset a " +"Kerberos password for an existing account using a random password generator:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:207 +#, no-wrap +msgid "% ssh kpasswd.freebsd.org\n" +msgstr "" + +#. type: delimited block = 4 +#: 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: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:219 +#, no-wrap +msgid "% kpasswd\n" +msgstr "" + +#. type: delimited block = 4 +#: 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 " +"the `ssh kpasswd.freebsd.org` method shown above must be used first to " +"initialize the Kerberos account." +msgstr "" + +#. type: Title == +#: 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:234 +msgid "" +"The FreeBSD repository has a number of components which, when combined, " +"support the basic operating system source, documentation, third party " +"application ports infrastructure, and various maintained utilities. When " +"FreeBSD commit bits are allocated, the areas of the tree where the bit may " +"be used are specified. Generally, the areas associated with a bit reflect " +"who authorized the allocation of the commit bit. Additional areas of " +"authority may be added at a later date: when this occurs, the committer " +"should follow normal commit bit allocation procedures for that area of the " +"tree, seeking approval from the appropriate entity and possibly getting a " +"mentor for that area for some period of time." +msgstr "" + +#. type: Table +#: 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:241 +#, no-wrap +msgid "__Responsible__" +msgstr "" + +#. type: Table +#: 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:244 +#, no-wrap +msgid "src" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:245 +#, no-wrap +msgid "core@" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:247 +#, no-wrap +msgid "src/" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:248 +#, no-wrap +msgid "doc" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:249 +#, no-wrap +msgid "doceng@" +msgstr "" + +#. type: Table +#: 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:252 +#, no-wrap +msgid "ports" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:253 +#, no-wrap +msgid "portmgr@" +msgstr "" + +#. type: Table +#: 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: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, " +"common sense dictates that a committer who has not previously worked in an " +"area of the tree seek review prior to committing, seek approval from the " +"appropriate responsible party, and/or work with a mentor. Since the rules " +"regarding code maintenance differ by area of the tree, this is as much for " +"the benefit of the committer working in an area of less familiarity as it is " +"for others working on the tree." +msgstr "" + +#. type: Plain text +#: 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 " +"work is occurring." +msgstr "" + +#. type: Title === +#: 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:265 +msgid "" +"All committers may modify [.filename]#src/share/misc/committers-*.dot#, [." +"filename]#src/usr.bin/calendar/calendars/calendar.freebsd#, and [." +"filename]#ports/astro/xearth/files#." +msgstr "" + +#. type: Plain text +#: 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 " +"comment fixes without approval from a src committer, subject to the normal " +"care and tending of commits." +msgstr "" + +#. type: Plain text +#: 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 " +"can provide a \"Reviewed by\" but not an \"Approved by\"." +msgstr "" + +#. type: Plain text +#: 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 core, doceng, or portmgr, as appropriate. " +"When approved, they will be added to 'access' and the normal mentoring " +"period will ensue, which will involve a continuing of \"Approved by\" for " +"some period." +msgstr "" + +#. type: Title ==== +#: 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: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 " +"tree. These fixes do not need approval or review from a doc committer if " +"the author doesn't have a doc commit bit." +msgstr "" + +#. type: Plain text +#: 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:279 +msgid "Typos" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:280 +msgid "Trivial fixes" +msgstr "" + +#. type: Plain text +#: 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: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: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: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:290 +msgid "Changes in [.filename]#doc/shared/contrib-additional.adoc#" +msgstr "" + +#. type: Plain text +#: 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:293 +msgid "All link:#commit-steps[Steps for New Committers], doc related" +msgstr "" + +#. type: Plain text +#: 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:296 +msgid "Used by {security-officer} and {re}." +msgstr "" + +#. type: Plain text +#: 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:299 +msgid "Used by {donations}." +msgstr "" + +#. type: Plain text +#: 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}" +"[FreeBSD Documentation Project Primer for New Contributors] for more details." +msgstr "" + +#. type: Title == +#: 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:306 +#, no-wrap +msgid "Git basics" +msgstr "" + +#. type: Plain text +#: 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 " +"Willie Willus' link:https://gist.github.com/" +"williewillus/068e9a8543de3a7ef80adb2938657b6b[Git - Quick Primer] are both " +"good overviews. The Git book is also complete, but much longer https://git-" +"scm.com/book/en/v2. There is also this website https://dangitgit.com/ for " +"common traps and pitfalls of Git, in case you need guidance to fix things " +"up. Finally, an introduction link:https://eagain.net/articles/git-for-" +"computer-scientists/[targeted at computer scientists] has proven helpful to " +"some at explaining the Git world view." +msgstr "" + +#. type: Plain text +#: 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:317 +#, no-wrap +msgid "Git Mini Primer" +msgstr "" + +#. type: Plain text +#: 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:321 +#, no-wrap +msgid "Scope" +msgstr "" + +#. type: Plain text +#: 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, " +"updating the sources, bisecting and touches briefly on how to cope with a " +"few local changes. It covers the basics, and tries to give good pointers to " +"more in-depth treatment for when the reader finds the basics insufficient. " +"Other sections of this guide cover more advanced topics related to " +"contributing to the project." +msgstr "" + +#. type: Plain text +#: 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 " +"for Git on the web, but the https://git-scm.com/book/en/v2[Git Book] " +"provides one of the better treatments." +msgstr "" + +#. type: Title ==== +#: 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: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:338 +#, no-wrap +msgid "Daily use" +msgstr "" + +#. type: delimited block = 4 +#: 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:346 +msgid "Clone the repository:" +msgstr "" + +#. type: delimited block . 4 +#: 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: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:359 +#, no-wrap +msgid "" +"% git remote -v\n" +"freebsd https://git.freebsd.org/${repo}.git (fetch)\n" +"freebsd https://git.freebsd.org/${repo}.git (push)\n" +msgstr "" + +#. type: Plain text +#: 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: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 " +"suggested config is by executing `/usr/local/bin/gen-gitconfig.sh` script on " +"freefall:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:372 +#, no-wrap +msgid "" +"% gen-gitconfig.sh\n" +"[...]\n" +"% git config user.name (your name in gecos)\n" +"% git config user.email (your login)@FreeBSD.org\n" +msgstr "" + +#. type: Plain text +#: 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: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: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:388 +#, no-wrap +msgid "" +"% git remote -v\n" +"freebsd https://git.freebsd.org/${repo}.git (fetch)\n" +"freebsd git@gitrepo.freebsd.org:${repo}.git (push)\n" +msgstr "" + +#. type: Plain text +#: 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:393 +msgid "Install commit message template hook:" +msgstr "" + +#. type: Plain text +#: 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:400 +#, no-wrap +msgid "" +"% cd .git/hooks\n" +"% ln -s ../../.hooks/prepare-commit-msg\n" +msgstr "" + +#. type: Plain text +#: 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:407 +#, no-wrap +msgid "% git config --add core.hooksPath .hooks\n" +msgstr "" + +#. type: Plain text +#: 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:415 +#, no-wrap +msgid "" +"% cd .git/hooks\n" +"% ln -s ../../tools/tools/git/hooks/prepare-commit-msg\n" +msgstr "" + +#. type: Title ===== +#: 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: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: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:429 +#, no-wrap +msgid "" +"% git config --add remote.freebsd.fetch '+refs/internal/*:refs/internal/*'\n" +"% git fetch\n" +"% git checkout -b admin internal/admin\n" +msgstr "" + +#. type: Plain text +#: 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: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: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:441 +msgid "For pushing, specify the full refspec:" +msgstr "" + +#. type: delimited block . 4 +#: 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:447 +#, no-wrap +msgid "Keeping Current With The FreeBSD src Tree" +msgstr "" + +#. type: Plain text +#: 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 " +"repository. However, there are times when you may wish to do a shallow " +"clone." +msgstr "" + +#. type: Title ===== +#: 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:457 +msgid "FreeBSD-CURRENT uses the `main` branch." +msgstr "" + +#. type: Plain text +#: 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: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: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:465 +msgid "https://www.freebsd.org/releng/[] shows:" +msgstr "" + +#. type: Plain text +#: 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: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:470 +msgid "Examples:" +msgstr "" + +#. type: Plain text +#: 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: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:474 +#, no-wrap +msgid "Repositories" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:477 +msgid "" +"Please see the <<admin,Administrative Details>> for the latest information " +"on where to get FreeBSD sources. $URL below can be obtained from that page." +msgstr "" + +#. type: Plain text +#: 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 " +"applications is discussed elsewhere and generally of little concern to the " +"casual user." +msgstr "" + +#. type: Title ===== +#: 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: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 " +"worktree feature to have all your active branches checked out into separate " +"directories but with only one copy of the repository." +msgstr "" + +#. type: delimited block . 4 +#: 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: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 " +"used. If no `<directory>` is given: the name of the new directory will " +"match the name of the repo ([.filename]#doc#, [.filename]#ports# or [." +"filename]#src#)." +msgstr "" + +#. type: Plain text +#: 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 " +"easiest to keep up to date as well. If you are interested in the history, " +"but are working with only one branch and are short on space, you can also " +"use --single-branch to only download the one branch (though some merge " +"commits will not reference the merged-from branch which may be important for " +"some users who are interested in detailed versions of history)." +msgstr "" + +#. type: Title ===== +#: 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: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 " +"FreeBSD, or when you are just starting out and plan to track the tree more " +"fully. You can also use it to limit history to only so many revisions. " +"However, see below for a significant limitation of this approach." +msgstr "" + +#. type: delimited block . 4 +#: 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: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 " +"your mind later, you can do `git fetch --unshallow` to get the old history." +msgstr "" + +#. type: delimited block = 4 +#: 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 " +"to be updated when a security advisory is issued." +msgstr "" + +#. type: Title ===== +#: 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: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:532 +#, no-wrap +msgid "" +"% cd src\n" +"% make buildworld\n" +"% make buildkernel\n" +"% make installkernel\n" +"% make installworld\n" +msgstr "" + +#. type: Plain text +#: 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: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." +msgstr "" + +#. type: Title ===== +#: 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: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:545 +#, no-wrap +msgid "% git pull --ff-only\n" +msgstr "" + +#. type: Plain text +#: 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 " +"always doing a fast forward merge/pull, you'll ensure that you have an exact " +"copy of the FreeBSD tree. This will be important if you want to maintain " +"local patches." +msgstr "" + +#. type: Plain text +#: 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 " +"available." +msgstr "" + +#. type: Title ==== +#: 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: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: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 " +"want):" +msgstr "" + +#. type: delimited block . 4 +#: 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: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:569 +#, no-wrap +msgid "Note: checking out '08b8197a742a96964d2924391bf9fdfeb788865d'.\n" +msgstr "" + +#. type: delimited block . 4 +#: 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" +"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:576 +#, 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:578 +#: documentation/content/en/articles/committers-guide/_index.adoc:1686 +#, no-wrap +msgid " git checkout -b <new-branch-name>\n" +msgstr "" + +#. type: delimited block . 4 +#: 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: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 " +"abbreviated to the shortest unique length. Git itself is inconsistent about " +"how many digits it displays." +msgstr "" + +#. type: Title ==== +#: 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: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 " +"down which commit caused the regression." +msgstr "" + +#. type: Plain text +#: 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 " +"https://www.metaltoad.com/blog/beginners-guide-git-bisect-process-" +"elimination or https://git-scm.com/docs/git-bisect for more details. The " +"man git-bisect page is good at describing what can go wrong, what to do when " +"versions won't build, when you want to use terms other than 'good' and " +"'bad', etc, none of which will be covered here." +msgstr "" + +#. type: Plain text +#: 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 " +"it the working version and `git bisect bad XXXXX` will tell it the bad " +"version. The bad version will almost always be HEAD (a special tag for what " +"you have checked out). The good version will be the last one you checked " +"out. The `--first-parent` argument is necessary so that subsequent `git " +"bisect` commands do not try to check out a vendor branch which lacks the " +"full FreeBSD source tree." +msgstr "" + +#. type: delimited block = 4 +#: 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:610 +#, no-wrap +msgid "" +"5ef0bd68b515 (HEAD -> main, freebsd/main, freebsd/HEAD) HEAD@{0}: pull --ff-only: Fast-forward\n" +"a8163e165c5b (upstream/main) HEAD@{1}: checkout: moving from b6fb97efb682994f59b21fe4efb3fcfc0e5b9eeb to main\n" +"...\n" +msgstr "" + +#. type: Plain text +#: 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 " +"5ef0bd68b515) and good would be a8163e165c5b. As you can see from the " +"output, HEAD@{1} also often works, but isn't foolproof if you have done " +"other things to your Git tree after updating, but before you discover the " +"need to bisect." +msgstr "" + +#. type: delimited block = 4 +#: 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 " +"the process:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:625 +#, no-wrap +msgid "" +"% git bisect start --first-parent\n" +"% git bisect good a8163e165c5b\n" +"% git bisect bad HEAD\n" +"Bisecting: 1722 revisions left to test after this (roughly 11 steps)\n" +"[c427b3158fd8225f6afc09e7e6f62326f9e4de7e] Fixup r361997 by balancing parens. Duh.\n" +msgstr "" + +#. type: Plain text +#: 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, " +"type `git bisect skip`. You will get a similar message to the above after " +"each step. When you are done, report the bad version to the developer (or " +"fix the bug yourself and send a patch). `git bisect reset` will end the " +"process and return you back to where you started (usually tip of `main`). " +"Again, the git-bisect manual (linked above) is a good resource for when " +"things go wrong or for unusual cases." +msgstr "" + +#. type: Title ==== +#: 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: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 " +"altered while you were transferring it. You also can prove that you " +"submitted the code and not someone else." +msgstr "" + +#. type: Plain text +#: 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 - " +"Signing Your Work] chapter of the Git's book." +msgstr "" + +#. type: Plain text +#: 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 " +"introduced the feature]." +msgstr "" + +#. type: Plain text +#: 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:655 +#, no-wrap +msgid "" +"% git config --add user.signingKey LONG-KEY-ID\n" +"% git config --add commit.gpgSign true\n" +"% git config --add tag.gpgSign true\n" +"% git config --add push.gpgSign if-asked\n" +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: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: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 " +"`DEADBEEF`, use `DEADBEEF!`." +msgstr "" + +#. type: Title ===== +#: 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: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:676 +msgid "" +"Tag signatures can be verified with `git verify-tag <tag name>`, or `git tag " +"-v <tag name>`." +msgstr "" + +# +# +#. Commented out for now until we decide what to do. +#. 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:685 +#, no-wrap +msgid "Ports Considerations" +msgstr "" + +#. type: Plain text +#: 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: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)." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:695 +msgid "" +"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:697 +#, no-wrap +msgid "Commit message formats" +msgstr "" + +#. type: Plain text +#: 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-msg[." +"hooks/prepare-commit-message]. It can be enabled by running ``git config --" +"add core.hooksPath .hooks``." +msgstr "" + +#. type: Plain text +#: 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:706 +#, no-wrap +msgid "category/port: Summary.\n" +msgstr "" + +#. type: delimited block . 4 +#: 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:710 +#, no-wrap +msgid "PR:\t 12345\n" +msgstr "" + +#. type: delimited block = 4 +#: 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 " +"less." +msgstr "" + +#. type: delimited block = 4 +#: 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: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: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:724 +#, no-wrap +msgid "Managing Local Changes" +msgstr "" + +#. type: Plain text +#: 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: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 " +"most things, there is very little difference. However, if you have local " +"changes, you can use the same tool to manage them as you use to pull in " +"changes from FreeBSD. All changes that you have not pushed are local and " +"can easily be modified (git rebase, discussed below does this)." +msgstr "" + +#. type: Title ===== +#: 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: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 " +"changes (which pushes them onto the stash stack). Most people use this to " +"save changes before updating the tree as described above. They then use " +"`git stash apply` to re-apply them to the tree. The stash is a stack of " +"changes that can be examined with `git stash list`. The git-stash man page " +"(https://git-scm.com/docs/git-stash) has all the details." +msgstr "" + +#. type: Plain text +#: 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 " +"branch and rebasing. Stashing is also integrated with the `git pull` " +"command: just add `--autostash` to the command line." +msgstr "" + +#. type: Title ===== +#: 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: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 " +"manageable, but can lead to a convoluted history that's hard to upstream " +"should that ever be necessary, or hard to replicate if you need to do so. " +"Git also allows one to merge, along with the same problems. That's one way " +"to manage the branch, but it's the least flexible." +msgstr "" + +#. type: Plain text +#: 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 " +"at a newer location on the parent branch. We will cover the most common " +"scenarios that arise using it." +msgstr "" + +#. type: Plain text +#: 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: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 " +"as a baseline. The FreeBSD ls command changes from time to time, and you'll " +"need to cope with those changes. Fortunately, with Git rebase it usually is " +"automatic." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:786 +#, no-wrap +msgid "" +"% cd src\n" +"% git checkout main\n" +"% git checkout -b no-color-ls\n" +"% cd bin/ls\n" +"% vi ls.c # hack the changes in\n" +"% git diff # check the changes\n" +"diff --git a/bin/ls/ls.c b/bin/ls/ls.c\n" +"index 7378268867ef..cfc3f4342531 100644\n" +"--- a/bin/ls/ls.c\n" +"+++ b/bin/ls/ls.c\n" +"@@ -66,6 +66,7 @@ __FBSDID(\"$FreeBSD$\");\n" +" #include <stdlib.h>\n" +" #include <string.h>\n" +" #include <unistd.h>\n" +"+#undef COLORLS\n" +" #ifdef COLORLS\n" +" #include <termcap.h>\n" +" #include <signal.h>\n" +"% # these look good, make the commit...\n" +"% git commit ls.c\n" +msgstr "" + +#. type: Plain text +#: 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 " +"and install it like you normally would, following the directions in the " +"handbook. Git differs from other version control systems in that you have " +"to tell it explicitly which files to commit. I have opted to do it on the " +"commit command line, but you can also do it with `git add` which many of the " +"more in depth tutorials cover." +msgstr "" + +#. type: Plain text +#: 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: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 " +"command before you update, and one after. The following assumes you are " +"starting with an unmodified tree. It is important to start rebasing " +"operations with a clean tree (Git requires this)." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:806 +#, no-wrap +msgid "" +"% git checkout main\n" +"% git pull --ff-only\n" +"% git rebase -i main no-color-ls\n" +msgstr "" + +#. type: Plain text +#: 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 " +"while updating the baseline (though you also use the Git rebase command to " +"curate the commits you have in the branch)." +msgstr "" + +#. type: Plain text +#: 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: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 " +"will just describe a common issue that may arise. A pointer to a complete " +"treatment can be found at the end of this section." +msgstr "" + +#. type: Plain text +#: 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 " +"something like this:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:833 +#, no-wrap +msgid "" +"Auto-merging bin/ls/ls.c\n" +"CONFLICT (content): Merge conflict in bin/ls/ls.c\n" +"error: could not apply 646e0f9cda11... no color ls\n" +"Resolve all conflicts manually, mark them as resolved with\n" +"\"git add/rm <conflicted_files>\", then run \"git rebase --continue\".\n" +"You can instead skip this commit: run \"git rebase --skip\".\n" +"To abort and get back to the state before \"git rebase\", run \"git rebase --abort\".\n" +"Could not apply 646e0f9cda11... no color ls\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:836 +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):" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:845 +#, no-wrap +msgid "" +" <<<<<<< HEAD\n" +" #ifdef COLORLS_NEW\n" +" #include <terminfo.h>\n" +" =======\n" +" #undef COLORLS\n" +" #ifdef COLORLS\n" +" #include <termcap.h>\n" +" >>>>>>> 646e0f9cda11... no color ls\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:849 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:853 +msgid "#undef COLORLS_NEW #ifdef COLORLS_NEW #include <terminfo.h>" +msgstr "" + +#. type: delimited block . 4 +#: 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:860 +msgid "% git add ls.c % git rebase --continue" +msgstr "" + +#. type: delimited block . 4 +#: 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:870 +#, no-wrap +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:873 +#, 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" +msgstr "" + +#. type: Title ===== +#: documentation/content/en/articles/committers-guide/_index.adoc:874 +#, no-wrap +msgid "Switching to a Different FreeBSD Branch" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:878 +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:881 +msgid "% git checkout main % # build and install here..." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:887 +#, no-wrap +msgid "" +"If you have a local branch, though, there are one or two caveats.\n" +"First, rebase will rewrite history, so you will likely want to do something to save it.\n" +"Second, jumping branches tends to cause more conflicts.\n" +"If we pretend the example above was relative to stable/12, then to move to `main`, I'd suggest the following:\n" +"[source,shell]\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:891 +#, no-wrap +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:898 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:900 +#, no-wrap +msgid "[[mfc-with-git]]\n" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:900 +#, no-wrap +msgid "MFC (Merge From Current) Procedures" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:901 +#, no-wrap +msgid "Summary" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:905 +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 -" +"i` to squash them together and edit the commit message." +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:906 +#, no-wrap +msgid "Single commit MFC" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:909 +#: documentation/content/en/articles/committers-guide/_index.adoc:949 +#: documentation/content/en/articles/committers-guide/_index.adoc:985 +#: documentation/content/en/articles/committers-guide/_index.adoc:1101 +#: documentation/content/en/articles/committers-guide/_index.adoc:1114 +#: documentation/content/en/articles/committers-guide/_index.adoc:1141 +#: documentation/content/en/articles/committers-guide/_index.adoc:1153 +#: documentation/content/en/articles/committers-guide/_index.adoc:1219 +#: documentation/content/en/articles/committers-guide/_index.adoc:1237 +#: documentation/content/en/articles/committers-guide/_index.adoc:1259 +#: documentation/content/en/articles/committers-guide/_index.adoc:1277 +#: documentation/content/en/articles/committers-guide/_index.adoc:1297 +#: documentation/content/en/articles/committers-guide/_index.adoc:1312 +#: documentation/content/en/articles/committers-guide/_index.adoc:1331 +#: documentation/content/en/articles/committers-guide/_index.adoc:1363 +#: documentation/content/en/articles/committers-guide/_index.adoc:1410 +#: documentation/content/en/articles/committers-guide/_index.adoc:1474 +msgid "[source,shell]" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:912 +msgid "% git checkout stable/X % git cherry-pick -x $HASH --edit" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:916 +#, 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:918 +#: documentation/content/en/articles/committers-guide/_index.adoc:939 +#: documentation/content/en/articles/committers-guide/_index.adoc:962 +#: documentation/content/en/articles/committers-guide/_index.adoc:973 +#: documentation/content/en/articles/committers-guide/_index.adoc:1191 +#: documentation/content/en/articles/committers-guide/_index.adoc:1285 +#: documentation/content/en/articles/committers-guide/_index.adoc:1370 +#: documentation/content/en/articles/committers-guide/_index.adoc:1382 +#: documentation/content/en/articles/committers-guide/_index.adoc:1394 +#: documentation/content/en/articles/committers-guide/_index.adoc:1420 +#: documentation/content/en/articles/committers-guide/_index.adoc:1432 +#: documentation/content/en/articles/committers-guide/_index.adoc:1439 +#: documentation/content/en/articles/committers-guide/_index.adoc:1481 +#: documentation/content/en/articles/committers-guide/_index.adoc:1515 +#: documentation/content/en/articles/committers-guide/_index.adoc:1522 +#: documentation/content/en/articles/committers-guide/_index.adoc:1531 +#: documentation/content/en/articles/committers-guide/_index.adoc:1560 +#: documentation/content/en/articles/committers-guide/_index.adoc:1576 +#: documentation/content/en/articles/committers-guide/_index.adoc:1609 +#: documentation/content/en/articles/committers-guide/_index.adoc:1630 +#: documentation/content/en/articles/committers-guide/_index.adoc:1661 +#: documentation/content/en/articles/committers-guide/_index.adoc:1673 +#: documentation/content/en/articles/committers-guide/_index.adoc:1704 +#: documentation/content/en/articles/committers-guide/_index.adoc:1713 +#: documentation/content/en/articles/committers-guide/_index.adoc:1723 +#: documentation/content/en/articles/committers-guide/_index.adoc:1739 +#: documentation/content/en/articles/committers-guide/_index.adoc:1755 +#: documentation/content/en/articles/committers-guide/_index.adoc:1766 +#: documentation/content/en/articles/committers-guide/_index.adoc:1773 +#: documentation/content/en/articles/committers-guide/_index.adoc:1786 +#: documentation/content/en/articles/committers-guide/_index.adoc:1806 +#: documentation/content/en/articles/committers-guide/_index.adoc:1820 +#: documentation/content/en/articles/committers-guide/_index.adoc:1836 +#: documentation/content/en/articles/committers-guide/_index.adoc:1848 +#: documentation/content/en/articles/committers-guide/_index.adoc:1867 +#: documentation/content/en/articles/committers-guide/_index.adoc:1878 +#: documentation/content/en/articles/committers-guide/_index.adoc:1888 +#: documentation/content/en/articles/committers-guide/_index.adoc:1926 +#: documentation/content/en/articles/committers-guide/_index.adoc:1934 +#: documentation/content/en/articles/committers-guide/_index.adoc:1945 +#: documentation/content/en/articles/committers-guide/_index.adoc:1966 +#: documentation/content/en/articles/committers-guide/_index.adoc:2026 +#, no-wrap +msgid "[source,shell]\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:921 +msgid "% git checkout stable/X % git cherry-pick -x $HASH -m 1 --edit" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:924 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:927 +#, 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" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:928 +#, no-wrap +msgid "MFC to RELENG branch" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:932 +msgid "" +"MFCs to branches that require approval require a bit more care. The process " +"is the same for either a typical merge or an exceptional direct commit." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:937 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:942 +msgid "% git checkout releng/13.0 % git cherry-pick -x $HASH --edit" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:945 +#, 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" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:946 +#, no-wrap +msgid "Multiple commit MFC" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:957 +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:960 +#, no-wrap +msgid "If the push fails due to losing the commit race, rebase and try again:\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:968 +msgid "" +"% git checkout stable/X % git pull % git checkout tmp-branch % git rebase " +"stable/X % git push freebsd HEAD:stable/X" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:971 +#, no-wrap +msgid "Once the MFC is complete, you can delete the temporary branch:\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:976 +msgid "% git checkout stable/X % git branch -d tmp-branch" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:978 +#, no-wrap +msgid "MFC a vendor import" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:983 +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 " +"additional difficulty because there are two parents for a merge commit. " +"Generally, you'll want the first parent's diff since that's the diff to " +"`main` (though there may be some exceptions)." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:987 +msgid "% git cherry-pick -x -m 1 $HASH" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:990 +#, no-wrap +msgid "" +"is typically what you want.\n" +"This will tell cherry-pick to apply the correct diff.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:995 +#, no-wrap +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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:998 +msgid "% git cherry-pick --abort % git cherry-pick -x -m 2 $HASH" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1000 +#, no-wrap +msgid "to do that. The `--abort` will cleanup the failed first attempt.\n" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1001 +#, no-wrap +msgid "Redoing a MFC" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1006 +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:1008 +msgid "% git reset --hard freebsd/stable/12" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1011 +#, no-wrap +msgid "" +"though if you have some revs you want to keep, and others you don't,\n" +"using `git rebase -i` is better.\n" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1012 +#, no-wrap +msgid "Considerations when MFCing" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1015 +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:1019 +#, no-wrap +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1021 +#, no-wrap +msgid "With Subversion, we used the following practices to achieve these goals:\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1025 +#, no-wrap +msgid "" +"* Using `MFC` and `MFS` tags to mark commits that merged changes from another branch.\n" +"* Squashing fixup commits into the main commit when merging a change.\n" +"* Recording mergeinfo so that `svn mergeinfo --show-revs` worked.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1029 +#, no-wrap +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1032 +#, 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" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1033 +#, no-wrap +msgid "Finding Eligible Hashes to MFC" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1039 +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 " +"(but not other metadata such as log messages) to determine if two commits " +"are identical. This works well when each commit from `main` is landed as a " +"single commit to a stable branch, but it falls over if multiple commits from " +"`main` are squashed together as a single commit to a stable branch. The " +"project makes extensive use of `git cherry-pick -x` with all lines preserved " +"to work around these difficulties and is working on automated tooling to " +"take advantage of this." +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1040 +#, no-wrap +msgid "Commit message standards" +msgstr "" + +#. type: Title ===== +#: documentation/content/en/articles/committers-guide/_index.adoc:1041 +#, no-wrap +msgid "Marking MFCs" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1044 +msgid "The project has adopted the following practice for marking MFCs:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1046 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1048 +#, no-wrap +msgid "When merging multiple commits, keep all the \"cherry picked from\" lines.\n" +msgstr "" + +#. type: Title ===== +#: documentation/content/en/articles/committers-guide/_index.adoc:1049 +#, no-wrap +msgid "Trim Metadata?" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1053 +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 " +"the metadata from the original commit unchanged, or should it be altered to " +"reflect information about the MFC commit itself?" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1062 +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 " +"in the MFC so that MFC commits are included in the bug tracker's audit " +"trail. Other fields are less clear. For example, Phabricator shows the " +"diff of the last commit tagged to a review, so including Phabricator URLs " +"replaces the main commit with the landed commits. The list of reviewers is " +"also not clear. If a reviewer has approved a change to `main`, does that " +"mean they have approved the MFC commit? Is that true if it's identical code " +"only, or with merely trivial rework? It's clearly not true for more " +"extensive reworks. Even for identical code what if the commit doesn't " +"conflict but introduces an ABI change? A reviewer may have ok'd a commit for " +"`main` due to the ABI breakage but may not approve of merging the same " +"commit as-is. One will have to use one's best judgment until clear " +"guidelines can be agreed upon." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1066 +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 " +"added via `git commit --amend` or similar after the original commit has been " +"reviewed and approved. We may also want to reserve some metadata fields in " +"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:1069 +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:1072 +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 " +"commit --amend`. However, as compared to svn, at least the existing commit " +"message can be pre-populated and metadata fields can be added or removed " +"without having to re-enter the entire commit message." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1074 +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:1076 +msgid "[[vendor-import-git]]" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:1076 +#, no-wrap +msgid "Vendor Imports with Git" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1079 +msgid "This section describes the vendor import procedure with Git in detail." +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1080 +#, no-wrap +msgid "Branch naming convention" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1083 +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:1089 +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. ====" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1092 +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:1093 +#, no-wrap +msgid "Updating an old vendor import" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1099 +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 " +"to the FreeBSD tree. Git worktrees are thus quite small and fast and the " +"preferred method to use. Make sure that whatever directory you choose below " +"(the `../mtree`) does not currently exist." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1103 +msgid "% git worktree add ../mtree vendor/NetBSD/mtree" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1105 +#, no-wrap +msgid "Update the Sources in the Vendor Branch" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1108 +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:1112 +msgid "" +"This example assumes the NetBSD source is checked out from their GitHub " +"mirror in `~/git/NetBSD`. Note that \"upstream\" might have added or " +"removed files, so we want to make sure deletions are propagated as well. " +"package:net/rsync[] is commonly installed, so I'll use that." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1126 +#, no-wrap +msgid "" +"% cd ../mtree\n" +"% rsync -va --del --exclude=\".git\" ~/git/NetBSD/usr.sbin/mtree/ .\n" +"% git add -A\n" +"% git status\n" +"...\n" +"% git diff --staged\n" +"...\n" +"% git commit -m \"Vendor import of NetBSD's mtree at 2020-12-11\"\n" +"[vendor/NetBSD/mtree 8e7aa25fcf1] Vendor import of NetBSD's mtree at 2020-12-11\n" +" 7 files changed, 114 insertions(+), 82 deletions(-)\n" +"% git tag -a vendor/NetBSD/mtree/20201211\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1130 +#, no-wrap +msgid "" +"Note: I run the `git diff` and `git status` commands to make sure nothing weird was present.\n" +"Also I used `-m` to illustrate, but you should compose a proper message in an editor (using a commit message template).\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1135 +#, no-wrap +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" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1136 +#, no-wrap +msgid "Updating the FreeBSD Copy" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1139 +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:1143 +msgid "% git push --follow-tags freebsd vendor/NetBSD/mtree" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1146 +#, no-wrap +msgid "`--follow-tags` tells `git push` to also push tags associated with the locally committed revision.\n" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1147 +#, no-wrap +msgid "Updating the FreeBSD source tree" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1151 +msgid "" +"Now you need to update the mtree in FreeBSD. The sources live in `contrib/" +"mtree` since it is upstream software." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1156 +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:1161 +#, no-wrap +msgid "" +"This would generate a subtree merge commit of `contrib/mtree` against the local `vendor/NetBSD/mtree` branch.\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" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1162 +#, no-wrap +msgid "Rebasing your change against latest FreeBSD source tree" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1165 +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:1168 +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:1170 +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 +#: documentation/content/en/articles/committers-guide/_index.adoc:1187 +#, no-wrap +msgid "" +"* cd to the top of the repo\n" +"* Create a side branch `XXX` with the **contents** of the merged tree.\n" +"* Update this side branch `XXX` to be merged and up-to-date with FreeBSD's `main` branch.\n" +"** In the worst case scenario, you would still have to resolve merge conflicts, if there was any, but this should be really rare.\n" +"** Resolve conflicts, and collapse multiple commits down to 1 if need be (without conflicts, there's no collapse needed)\n" +"* checkout `main`\n" +"* create a branch `YYY` (allows for easier unwinding if things go wrong)\n" +"* Re-do the subtree merge\n" +"* Instead of resolving any conflicts from the subtree merge, checkout the contents of XXX on top of it.\n" +"** The trailing `.` is important, as is being at the top level of the repo.\n" +"** Rather than switching branches to XXX, it splats the contents of XXX on top of the repo\n" +"* Commit the results with the prior commit message (the example assumes there's only one merge on the XXX branch).\n" +"* Make sure the branches are the same.\n" +"* Do whatever review you need, including having others check it out if you think that's needed.\n" +"* Push the commit, if you 'lost the race' again, just redo these steps again (see below for a recipe)\n" +"* Delete the branches once the commit is upstream. They are throw-a-way.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1189 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1202 +#, no-wrap +msgid "" +"% cd ../src\t\t\t# CD to top of tree\n" +"% git checkout -b XXX\t\t# create new throw-away XXX branch for merge\n" +"% git fetch freebsd\t\t# Get changes from upstream from upstream\n" +"% git merge freebsd/main\t# Merge the changes and resolve conflicts\n" +"% git checkout -b YYY freebsd/main # Create 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" +"% git diff XXX YYY\t\t# Should be empty\n" +"% 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:1206 +#, 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:1208 +msgid "" +"% git checkout -B YYY freebsd/main # Create new throw-away YYY branch if " +"starting over is just going to be easier" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1210 +#, no-wrap +msgid "Pushing the changes" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1215 +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 " +"that it allows you to publish rough drafts of your work for others to " +"review. While Phabricator is good for content review, publishing the " +"updated vendor branch and merge commits lets others check the details as " +"they will eventually appear in the repository." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1217 +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:1223 +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1230 +#, no-wrap +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" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1231 +#, no-wrap +msgid "How to redo things if need be" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1235 +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:1244 +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:1247 +#, no-wrap +msgid "Then go check it out as above and push as above when ready.\n" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:1248 +#, no-wrap +msgid "Creating a new vendor branch" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1255 +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 " +"is importing `glorbnitz` into the FreeBSD tree, release 3.1415. For the " +"sake of simplicity, we will not trim this release. It is a simple user " +"command that puts the nitz device into different magical glorb states and is " +"small enough trimming will not save much." +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1256 +#, no-wrap +msgid "Create the repo" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1265 +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:1268 +#, no-wrap +msgid "At this point, you have a new repo, where all new commits will go on the `vendor/glorbnitz` branch.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1270 +#, 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" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1271 +#, no-wrap +msgid "Copy the sources in" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1275 +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:1280 +msgid "% cp -r ~/glorbnitz/* . % git add *" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1283 +#, no-wrap +msgid "At this point, you should have a pristine copy of glorbnitz ready to commit.\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1287 +msgid "% git commit -m \"Import GlorbNitz frobnosticator revision 3.1415\"" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1291 +#, no-wrap +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 <<commit-log-message,commit log message>> section instead of emulating the brief style used here.\n" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1292 +#, no-wrap +msgid "Now import it into our repository" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1295 +msgid "Now you need to import the branch into our repository." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1301 +msgid "" +"% cd /path/to/freebsd/repo/src % git remote add glorbnitz /some/where/" +"glorbnitz % git fetch glorbnitz vendor/glorbnitz" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1306 +#, no-wrap +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" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1307 +#, no-wrap +msgid "Tag and push" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1310 +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:1318 +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:1321 +#, no-wrap +msgid "By 'good' we mean:\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1327 +#, no-wrap +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" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1328 +#, no-wrap +msgid "Time to finally merge it into the base tree" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1337 +#, no-wrap +msgid "" +"% cd ../src\n" +"% git subtree add -P contrib/glorbnitz vendor/glorbnitz\n" +"# Make sure the commit is good with \"git show\"\n" +"% git commit --amend # one last sanity check on commit message\n" +"% git push freebsd\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1340 +#, no-wrap +msgid "Here 'good' means:\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1345 +#, 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 <<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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1351 +#, no-wrap +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" +msgstr "" + +#. type: Title ===== +#: documentation/content/en/articles/committers-guide/_index.adoc:1352 +#, no-wrap +msgid "Keeping current" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1358 +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 " +"a lot easier to commit those to a branch (or use `git stash`) before doing " +"the following." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1361 +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:1365 +msgid "% git config --global pull.ff only" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1368 +#, no-wrap +msgid "You may need to omit the --global if you want this setting to apply to only this repository.\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1374 +msgid "% cd freebsd-src % git checkout main % git pull (--ff-only|--rebase)" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1378 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1380 +#, no-wrap +msgid "The longer form is also recommended.\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1387 +msgid "" +"% cd freebsd-src % git checkout main % git fetch freebsd % git merge --ff-" +"only freebsd/main" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1392 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1396 +msgid "% git rebase -i main working" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1403 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1405 +#, no-wrap +msgid "[[git-push-upstream]]\n" +msgstr "" + +#. type: Title ===== +#: documentation/content/en/articles/committers-guide/_index.adoc:1405 +#, no-wrap +msgid "Time to push changes upstream" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1408 +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:1412 +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:1416 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1418 +#, no-wrap +msgid "Use\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1422 +msgid "freefall% gen-gitconfig.sh" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1425 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1430 +#, no-wrap +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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1434 +msgid "% git push freebsd working:main" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1437 +#, no-wrap +msgid "If your push is rejected due to losing a commit race, rebase your branch before trying again:\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1444 +msgid "" +"% git checkout working % git fetch freebsd % git rebase freebsd/main % git " +"push freebsd working:main" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1447 +#, no-wrap +msgid "[[git-push-upstream-alt]]\n" +msgstr "" + +#. type: Title ===== +#: documentation/content/en/articles/committers-guide/_index.adoc:1447 +#, no-wrap +msgid "Time to push changes upstream (alternative)" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1453 +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:1457 +msgid "% git checkout main % git merge --ff-only `working` % git push freebsd" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1461 +#, no-wrap +msgid "" +"If you lose the race, then try again with\n" +"[source,shell]\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1464 +msgid "% git pull --rebase % git push freebsd" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1467 +#, 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" +msgstr "" + +#. type: Title ===== +#: documentation/content/en/articles/committers-guide/_index.adoc:1468 +#, no-wrap +msgid "Finding the Subversion Revision" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1472 +msgid "" +"You'll need to make sure that you've fetched the notes (see the <<git-mini-" +"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:1476 +msgid "% git log" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1479 +#, no-wrap +msgid "If you have a specific version in mind, you can use this construct:\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1483 +msgid "% git log --grep revision=XXXX" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1487 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1489 +#, no-wrap +msgid "[[git-faq]]\n" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:1489 +#, no-wrap +msgid "Git FAQ" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1492 +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:1498 +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. ====" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1499 +#, no-wrap +msgid "Users" +msgstr "" + +#. type: Title ===== +#: documentation/content/en/articles/committers-guide/_index.adoc:1501 +#, 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:1506 +#, 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" +"With SVN mirroring, I could checkout multiple trees from the same repository.\n" +"How do I do this with Git?\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1510 +#, no-wrap +msgid "" +"**A:** You can use Git worktrees.\n" +"There's a number of ways to do this, but the simplest way is to use a clone to track -current, and a worktree to track stable releases.\n" +"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:1513 +#, 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:1517 +msgid "" +"% git clone -o freebsd --config remote.freebsd.fetch='+refs/notes/*:refs/" +"notes/*' $URL freebsd-current" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1520 +#, no-wrap +msgid "then once that's cloned, you can simply create a worktree from it:\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1525 +msgid "% cd freebsd-current % git worktree add ../freebsd-stable-12 stable/12" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1529 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1539 +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1542 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1544 +#, no-wrap +msgid "Here's https://adventurist.me/posts/00296[a good writeup] that goes into more detail.\n" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1545 +#, no-wrap +msgid "Developers" +msgstr "" + +#. type: Title ===== +#: documentation/content/en/articles/committers-guide/_index.adoc:1547 +#, 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:1550 +#, 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:1552 +#, no-wrap +msgid "**A:** First, don't panic.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1556 +#, no-wrap +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1558 +#, no-wrap +msgid "The following answer assumes you committed to `main` and want to create a branch called `issue`:\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1564 +#, no-wrap +msgid "" +"% git branch issue # Create the 'issue' branch\n" +"% git reset --hard freebsd/main # Reset 'main' back to the official tip\n" +"% git checkout issue # Back to where you were\n" +msgstr "" + +#. type: Title ===== +#: documentation/content/en/articles/committers-guide/_index.adoc:1566 +#, no-wrap +msgid "Ooops! I committed something to the wrong branch!" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1570 +#, 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:1574 +#, no-wrap +msgid "" +"**A:** The answer is similar to the previous one, but with cherry picking.\n" +"This assumes there's only one commit on wilma, but will generalize to more complicated situations.\n" +"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:1582 +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:1586 +#, no-wrap +msgid "" +"Git experts would first rewind the wilma branch by 1 commit, switch over to fred and then use `git reflog` to see what that 1 deleted commit was and\n" +"cherry-pick it over.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1588 +#, 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:1594 +#, 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" +"You can cherry pick those changes into `main`, then push to the parent repository.\n" +"Once you've done that, cleanup couldn't be simpler: just `git rebase -i`.\n" +"Git will notice you've done this and skip the common changes automatically (even if you had to change the commit message or tweak the commit slightly).\n" +"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:1596 +#, 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:1602 +#, no-wrap +msgid "" +"**A:** The more general answer would be the same as the previous.\n" +"You'd checkout/create the `fred` branch, cherry pick the changes you want from `wilma` one at a time, then rebase `wilma` to remove those changes you cherry picked.\n" +"`git rebase -i main wilma` will toss you into an editor, and remove the `pick` lines that correspond to the commits you copied to `fred`.\n" +"If all goes well, and there are no conflicts, you're done.\n" +"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:1607 +#, 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:1614 +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1618 +#, no-wrap +msgid "" +"The last step is optional.\n" +"If you are going to try again to split, you'd omit it.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1622 +#, 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" +"How do I find what `wilma` was before I started.\n" +"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:1624 +#, 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:1628 +#, 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:1643 +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 ... %" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1651 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1659 +#, no-wrap +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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1664 +msgid "% git checkout -B wilma 869cbd3 % git branch -D fred" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1671 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1677 +msgid "% git checkout 869cbd3 M\tfaq.md Note: checking out '869cbd3'." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1681 +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." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1684 +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:1689 +msgid "HEAD is now at 869cbd3 Encourage contributions % git checkout -B wilma" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1692 +#, 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" +msgstr "" + +#. type: Title ===== +#: documentation/content/en/articles/committers-guide/_index.adoc:1693 +#, 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:1697 +#, 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:1699 +#, 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:1702 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1707 +#, no-wrap +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1711 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1715 +msgid "git reset --hard HEAD^2" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1718 +#, 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:1721 +#, 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:1725 +msgid "git branch -f main freebsd/main" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1730 +#, no-wrap +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" +msgstr "" + +#. type: Title ===== +#: documentation/content/en/articles/committers-guide/_index.adoc:1731 +#, no-wrap +msgid "Mixing and matching branches" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1735 +#, 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:1737 +#, no-wrap +msgid "**A:** This is a job for cherry pick.\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1743 +msgid "" +"% git checkout worker % git checkout -b feature\t# create a new branch % git " +"cherry-pick main..async\t# bring in the changes" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1748 +#, no-wrap +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1750 +#, 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:1753 +#, 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:1759 +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:1764 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1768 +msgid "% git rebase -i main kernel" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1771 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1775 +msgid "% git rebase -i main userland" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1778 +#, no-wrap +msgid "and do the same thing you did with the `kernel` branch.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1781 +#, 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:1784 +#, 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:1790 +msgid "% git checkout kernel % git log driver % git cherry-pick $HASH" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1796 +#, no-wrap +msgid "" +"**Q:** OK. I have the same situation as the above, but my commits are all mixed up.\n" +"I need parts of one commit to go to one branch and the rest to go to the other.\n" +"In fact, I have several.\n" +"Your rebase method to select sounds tricky.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1799 +#, 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:1804 +#, 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:1808 +msgid "% git reset HEAD^" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1811 +#, no-wrap +msgid "Note: Do not, repeat do not, add `--hard` here since that also removes the changes from your tree.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1815 +#, no-wrap +msgid "" +"Now, if you are lucky, the change needing to be split up falls entirely along file lines.\n" +"In that case you can just do the usual `git add` for the files in each group than do a `git commit`.\n" +"Note: when you do this, you'll lose the commit message when you do the reset, so if you need it for some reason, you should save a copy (though `git log $HASH` can recover it).\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1818 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1822 +msgid "git add -i foo/bar.c" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1828 +#, no-wrap +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" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:1829 +#, no-wrap +msgid "Cloning and Mirroring" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1832 +#, 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:1834 +#, 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:1838 +msgid "% git clone --mirror $URL" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1842 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1846 +#, no-wrap +msgid "" +"First, this is a 'bare repository' which has the repository database, but no checked out worktree.\n" +"This is great for mirroring, but terrible for day to day work.\n" +"There's a number of ways around this with `git worktree`:\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1854 +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1857 +#, no-wrap +msgid "But if you aren't using your mirror for further local clones, then it's a poor match.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1860 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1862 +#, no-wrap +msgid "**Q:** So what can I do instead?\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1865 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1869 +#, no-wrap +msgid " fetch = +refs/heads/*:refs/remotes/freebsd/*\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1872 +#, no-wrap +msgid "which says just fetch the branch refs.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1876 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1880 +msgid "git config --add remote.freebsd.fetch '+refs/*:refs/freebsd/*'" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1884 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1886 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1890 +msgid "git log refs/freebsd/vendor/zlib/1.2.10" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1893 +#, no-wrap +msgid "would look at the log for the vendor branch for zlib starting at 1.2.10.\n" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:1894 +#, no-wrap +msgid "Collaborating with others" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1898 +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 " +"changes to the tree. The FreeBSD project's Git repositories do not, yet, " +"allow user-created branches to be pushed to the repository, and therefore if " +"you wish to share your changes with others you must use another mechanism, " +"such as a hosted GitLab or GitHub, to share changes in a user-generated " +"branch." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1900 +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:1902 +msgid "" +"Before you begin, make sure that your local Git repo is up to date and has " +"the correct origins set <<keeping_current,as shown above.>>" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1909 +msgid "" +"[source,shell] ```` % git remote -v freebsd https://git.freebsd.org/src.git " +"(fetch) freebsd ssh://git@gitrepo.freebsd.org/src.git (push) ````" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1912 +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/" +"getting-started-with-github/fork-a-repo[guidelines]. The destination of the " +"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:1915 +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:1922 +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)" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1924 +#, no-wrap +msgid "With this in place you can create a branch <<keeping_a_local_branch,as shown above.>>\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1928 +msgid "% git checkout -b gnn-pr2001-fix" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1932 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1938 +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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1940 +#, no-wrap +msgid " git push --set-upstream github gnn-pr2001-fix\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1943 +#, no-wrap +msgid "Setting the push as +git+ advises allows it to succeed:\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1959 +#, no-wrap +msgid "" +"% git push --set-upstream github gnn-feature\n" +"Enumerating objects: 20486, done.\n" +"Counting objects: 100% (20486/20486), done.\n" +"Delta compression using up to 8 threads\n" +"Compressing objects: 100% (12202/12202), done.\n" +"Writing objects: 100% (20180/20180), 56.25 MiB | 13.15 MiB/s, done.\n" +"Total 20180 (delta 11316), reused 12972 (delta 7770), pack-reused 0\n" +"remote: Resolving deltas: 100% (11316/11316), completed with 247 local objects.\n" +"remote:\n" +"remote: Create a pull request for 'gnn-feature' on GitHub by visiting:\n" +"remote: https://github.com/gvnn3/freebsd-src/pull/new/gnn-feature\n" +"remote:\n" +"To github.com:gvnn3/freebsd-src.git\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1961 +#, no-wrap +msgid "" +"[new branch] gnn-feature -> gnn-feature\n" +"Branch 'gnn-feature' set up to track remote branch 'gnn-feature' from 'github'.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1964 +#, 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:1977 +#, no-wrap +msgid "" +"% git push\n" +"Enumerating objects: 4, done.\n" +"Counting objects: 100% (4/4), done.\n" +"Delta compression using up to 8 threads\n" +"Compressing objects: 100% (2/2), done.\n" +"Writing objects: 100% (3/3), 314 bytes | 1024 bytes/s, done.\n" +"Total 3 (delta 1), reused 1 (delta 0), pack-reused 0\n" +"remote: Resolving deltas: 100% (1/1), completed with 1 local object.\n" +"To github.com:gvnn3/freebsd-src.git\n" +" 9e5243d7b659..cf6aeb8d7dda gnn-feature -> gnn-feature\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1981 +#, no-wrap +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:1983 +#, no-wrap +msgid "[[github-pull-land]]\n" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:1983 +#, no-wrap +msgid "Landing a github pull request" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1988 +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 " +"way to submit patches at this time, sometimes good fixes come in this way " +"and it is easiest just to bring them into a committer's tree and have them " +"pushed into the FreeBSD's tree from there. Similar steps can be used to " +"pull branches from other repositories and land those. When committing pull " +"requests from others, one should take extra care to examine all the changes " +"to ensure they are exactly as represented." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1992 +msgid "" +"Before beginning, make sure that the local Git repo is up to date and has " +"the correct origins set <<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:1998 +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)" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2018 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2020 +#, no-wrap +msgid "Author: github-user <38923459+github-user@users.noreply.github.com>\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2024 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2036 +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2041 +#, no-wrap +msgid "" +"[.procedure]\n" +"====\n" +"For complicated pull requests that have multiple commits with conflicts, follow the following outline.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2049 +#, no-wrap +msgid "" +". checkout the pull request `git checkout github/pull/XXX`\n" +". create a branch to rebase `git checkout -b staging`\n" +". rebase the `staging` branch to the latest `main` with `git rebase -i main staging`\n" +". resolve conflicts and do whatever testing is needed\n" +". fast forward the `staging` branch into `main` as above\n" +". final sanity check of changes to make sure all is well\n" +". push to FreeBSD's Git repository.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2054 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2056 +#, no-wrap +msgid "[[vcs-history]]\n" +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:2056 +#, no-wrap +msgid "Version Control History" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2059 +msgid "The project has moved to <<git-primer,git>>." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2065 +msgid "" +"The FreeBSD source repository switched from CVS to Subversion on May 31st, " +"2008. The first real SVN commit is __r179447__. The source repository " +"switched from Subversion to Git on December 23rd, 2020. The last real svn " +"commit is __r368820__. The first real git commit hash is " +"__5ef5f51d2bef80b0ede9b10ad5b0e9440b60518c__." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2071 +msgid "" +"The FreeBSD `doc/www` repository switched from CVS to Subversion on May " +"19th, 2012. The first real SVN commit is __r38821__. The documentation " +"repository switched from Subversion to Git on December 8th, 2020. The last " +"SVN commit is __r54737__. The first real git commit hash is " +"__3be01a475855e7511ad755b2defd2e0da5d58bbe__." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2077 +msgid "" +"The FreeBSD `ports` repository switched from CVS to Subversion on July 14th, " +"2012. The first real SVN commit is __r300894__. The ports repository " +"switched from Subversion to Git on April 6, 2021. The last SVN commit is " +"__r569609__ The first real git commit hash is " +"__ed8d3eda309dd863fb66e04bccaa513eee255cbf__." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2079 +msgid "[[conventions]]" +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:2079 +#, no-wrap +msgid "Setup, Conventions, and Traditions" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2084 +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:2086 +msgid "[[conventions-committers]]" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:2086 +#, no-wrap +msgid "For New Committers" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2089 +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:2092 +#, no-wrap +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2097 +#, no-wrap +msgid "" +"[[commit-steps]]\n" +"[.procedure]\n" +"====\n" +"*Steps for New Committers*\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2144 +#, no-wrap +msgid "" +". Add an Author Entity\n" +"+\n" +"[.filename]#doc/shared/authors.adoc# - Add an author entity. Later steps depend on this entity, and missing this step will cause the [.filename]#doc/# build to fail. This is a relatively easy task, but remains a good first test of version control skills.\n" +". Update the List of Developers and Contributors\n" +"+\n" +"[.filename]#doc/shared/contrib-committers.adoc# - Add an entry, which will then appear in the \"Developers\" section of the extref:{contributors}[Contributors List, staff-committers]. Entries are sorted by last name.\n" +"+\n" +"[.filename]#doc/shared/contrib-additional.adoc# - _Remove_ the entry. Entries are sorted by first name.\n" +". Add a News Item\n" +"+\n" +"[.filename]#doc/website/data/en/news/news.toml# - Add an entry. Look for the other entries that announce new committers and follow the format. Use the date from the commit bit approval email.\n" +". Add a PGP Key\n" +"+\n" +"`{des}` has written a shell script ([.filename]#doc/documentation/tools/addkey.sh#) to make this easier. See the https://cgit.freebsd.org/doc/plain/documentation/static/pgpkeys/README[README] file for more information.\n" +"+\n" +"Use [.filename]#doc/documentation/tools/checkkey.sh# to verify that keys meet minimal best-practices standards.\n" +"+\n" +"After adding and checking a key, add both updated files to source control and then commit them. Entries in this file are sorted by last name.\n" +"+\n" +"[NOTE]\n" +"======\n" +"It is very important to have a current PGP/GnuPG key in the repository. The key may be required for positive identification of a committer. For example, the `{admins}` might need it for account recovery. A complete keyring of `FreeBSD.org` users is available for download from link:https://docs.FreeBSD.org/pgpkeys/pgpkeys.txt[https://docs.FreeBSD.org/pgpkeys/pgpkeys.txt].\n" +"======\n" +". Update Mentor and Mentee Information\n" +"+\n" +"[.filename]#src/share/misc/committers-<repository>.dot# - Add an entry to the current committers section, where _repository_ is `doc`, `ports`, or `src`, depending on the commit privileges granted.\n" +"+\n" +"Add an entry for each additional mentor/mentee relationship in the bottom section.\n" +". Generate a Kerberos Password\n" +"+\n" +"See <<kerberos-ldap>> to generate or set a Kerberos account for use with other FreeBSD services like the link:https://bugs.freebsd.org/bugzilla/[bug-tracking database] (you get a bug-tracking account as part of that step).\n" +". Optional: Enable Wiki Account\n" +"+\n" +"link:https://wiki.freebsd.org[FreeBSD Wiki] Account - A wiki account allows sharing projects and ideas.\n" +"Those who do not yet have an account can follow instructions on the link:https://wiki.freebsd.org/Wiki/About[Wiki/About page] to obtain one.\n" +"Contact mailto:wiki-admin@FreeBSD.org[wiki-admin@FreeBSD.org] if you need help with your Wiki account.\n" +". Optional: Update Wiki Information\n" +"+\n" +"Wiki Information - After gaining access to the wiki, some people add entries to the https://wiki.freebsd.org/HowWeGotHere[How We Got Here], https://wiki.freebsd.org/IRC/Nicknames[IRC Nicks], https://wiki.freebsd.org/Community/Dogs[Dogs of FreeBSD], and or https://wiki.freebsd.org/Community/Cats[Cats of FreeBSD] pages.\n" +". Optional: Update Ports with Personal Information\n" +"+\n" +"[.filename]#ports/astro/xearth/files/freebsd.committers.markers# and [.filename]#src/usr.bin/calendar/calendars/calendar.freebsd# - Some people add entries for themselves to these files to show where they are located or the date of their birthday.\n" +". Optional: Prevent Duplicate Mailings\n" +"+\n" +"Subscribers to {dev-commits-doc-all}, {dev-commits-ports-all} or {dev-commits-src-all} might wish to unsubscribe to avoid receiving duplicate copies of commit messages and followups.\n" +"====\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2146 +#, no-wrap +msgid "[[conventions-everyone]]\n" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:2146 +#, no-wrap +msgid "For Everyone" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2166 +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. ====== ====" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2168 +msgid "[[smtp-setup]]" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:2168 +#, no-wrap +msgid "SMTP Access Setup" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2171 +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:2192 +msgid "" +"[.procedure] ==== . Point your mail client at `smtp.FreeBSD.org:587`. . " +"Enable STARTTLS. . Ensure your `From:` address is set to " +"`_yourusername_@FreeBSD.org`. . For authentication, you can use your " +"FreeBSD Kerberos username and password (see <<kerberos-ldap>>). The " +"`_yourusername_/mail` principal is preferred, as it is only valid for " +"authenticating to mail resources. + [NOTE] ====== Do not include `@FreeBSD." +"org` when entering in your username. ====== + .Additional Notes [NOTE] " +"====== * Will only accept mail from `_yourusername_@FreeBSD.org`. If you are " +"authenticated as one user, you are not permitted to send mail from another. " +"* A header will be appended with the SASL username: (`Authenticated sender: " +"_username_`). * Host has various rate limits in place to cut down on brute " +"force attempts. ====== ====" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2194 +msgid "[[smtp-setup-local-mta]]" +msgstr "" + +#. type: Title ===== +#: documentation/content/en/articles/committers-guide/_index.adoc:2194 +#, 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:2197 +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:2202 +msgid "[[smtp-setup-local-postfix]] .Using Postfix [example] ====" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2204 +msgid "" +"To tell a local Postfix instance that anything from `_yourusername_@FreeBSD." +"org` should be forwarded to the FreeBSD.org servers, add this to your [." +"filename]#main.cf#:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2206 +msgid "[.programlisting]" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2212 +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:2215 +#, no-wrap +msgid "Create [.filename]#/usr/local/etc/postfix/relayhost_maps# with the following content:\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2217 +#: documentation/content/en/articles/committers-guide/_index.adoc:2224 +#: documentation/content/en/articles/committers-guide/_index.adoc:2231 +#: documentation/content/en/articles/committers-guide/_index.adoc:2239 +#: documentation/content/en/articles/committers-guide/_index.adoc:2254 +#: documentation/content/en/articles/committers-guide/_index.adoc:2264 +#: documentation/content/en/articles/committers-guide/_index.adoc:2278 +#: documentation/content/en/articles/committers-guide/_index.adoc:2308 +#, no-wrap +msgid "[.programlisting]\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2219 +msgid "yourusername@FreeBSD.org [smtp.freebsd.org]:587" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2222 +#, no-wrap +msgid "Create [.filename]#/usr/local/etc/postfix/sasl_passwd# with the following content:\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2226 +#, no-wrap +msgid "[smtp.freebsd.org]:587 yourusername:yourpassword\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2229 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2234 +msgid "" +"smtpd_sender_login_maps = hash:/usr/local/etc/postfix/sender_login_maps " +"smtpd_sender_restrictions = reject_known_sender_login_mismatch" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2237 +#, no-wrap +msgid "Create [.filename]#/usr/local/etc/postfix/sender_login_maps# with the following content:\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2241 +msgid "yourusername@FreeBSD.org yourlocalusername" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2245 +#, no-wrap +msgid "" +"Where _yourlocalusername_ is the SASL username used to connect to the local instance of Postfix.\n" +"====\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2250 +#, no-wrap +msgid "" +"[[smtp-setup-local-opensmtpd]]\n" +".Using OpenSMTPD\n" +"[example]\n" +"====\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2252 +#, 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" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2257 +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\"" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2260 +#, no-wrap +msgid "Where _yourlocalusername_ is the SASL username used to connect to the local instance of OpenSMTPD.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2262 +#, 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:2266 +msgid "freebsd\tyourusername:yourpassword" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2273 +#, no-wrap +msgid "" +"====\n" +"[[smtp-setup-local-exim]]\n" +".Using Exim\n" +"[example]\n" +"====\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2276 +#, 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:2285 +#, no-wrap +msgid "" +"Routers section: (at the top of the list):\n" +"freebsd_send:\n" +" driver = manualroute\n" +" domains = !+local_domains\n" +" transport = freebsd_smtp\n" +" 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:2297 +#, no-wrap +msgid "" +"Transport Section:\n" +"freebsd_smtp:\n" +" driver = smtp\n" +" tls_certificate=<local certificate>\n" +" tls_privatekey=<local certificate private key>\n" +" tls_require_ciphers = EECDH+ECDSA+AESGCM:EECDH+aRSA+AESGCM:EECDH+ECDSA+SHA384:EECDH+ECDSA+SHA256:EECDH+aRSA+SHA384:EECDH+aRSA+SHA256:EECDH+AESGCM:EECDH:EDH+AESGCM:EDH+aRSA:HIGH:!MEDIUM:!LOW:!aNULL:!eNULL:!LOW:!RC4:!MD5:!EXP:!PSK:!SRP:!DSS\n" +" dkim_domain = <local DKIM domain>\n" +" dkim_selector = <local DKIM selector>\n" +" dkim_private_key= <local DKIM private key>\n" +" dnssec_request_domains = *\n" +" hosts_require_auth = smtp.freebsd.org\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2303 +#, no-wrap +msgid "" +"Authenticators:\n" +"fixed_plain:\n" +" driver = plaintext\n" +" public_name = PLAIN\n" +" client_send = ^example/mail^examplePassword\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2306 +#, 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:2310 +msgid "example@freebsd.org:smtp.freebsd.org::587" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2313 +#, no-wrap +msgid "====\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2315 +#, no-wrap +msgid "[[mentors]]\n" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:2315 +#, no-wrap +msgid "Mentors" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2320 +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 " +"the project and guiding their first steps in the developer community. The " +"mentor is also personally responsible for the mentee's actions during this " +"initial period." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2323 +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:2327 +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 [." +"filename]#mentors#. This file is in the [.filename]#admin# orphan branch of " +"each repository. Detailed information on how to access these branches can " +"be found in <<admin-branch>>." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2329 +msgid "[[pre-commit-review]]" +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:2329 +#, no-wrap +msgid "Pre-Commit Review" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2334 +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` " +"repository. Other branches and the `ports` and `docs` trees have their own " +"review policies, but these guidelines generally apply to commits requiring " +"review:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2340 +#, no-wrap +msgid "" +"* All non-trivial changes should be reviewed before they are committed to the repository.\n" +"* Reviews may be conducted by email, in Bugzilla, in Phabricator, or by another mechanism. Where possible, reviews should be public.\n" +"* The developer responsible for a code change is also responsible for making all necessary review-related changes.\n" +"* Code review can be an iterative process, which continues until the patch is ready to be committed. Specifically, once a patch is sent out for review, it should receive an explicit \"looks good\" before it is committed. So long as it is explicit, this can take whatever form makes sense for the review method.\n" +"* Timeouts are not a substitute for review.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2342 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2349 +#, no-wrap +msgid "" +"* Review other people's patches. If you help out, everybody will be more willing to do the same for you; goodwill is our currency.\n" +"* Ping the patch. If it is urgent, provide reasons why it is important to you to get this patch landed and ping it every couple of days. If it is not urgent, the common courtesy ping rate is one week. Remember that you are asking for valuable time from other professional developers.\n" +"* Ask for help on mailing lists, IRC, etc. Others may be able to either help you directly, or suggest a reviewer.\n" +"* Split your patch into multiple smaller patches that build on each other. The smaller your patch, the higher the probability that somebody will take a quick look at it.\n" +"+\n" +"When making large changes, it is helpful to keep this in mind from the beginning of the effort as breaking large changes into smaller ones is often difficult after the fact.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2354 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2357 +#, no-wrap +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2359 +#, no-wrap +msgid "[[commit-log-message]]\n" +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:2359 +#, no-wrap +msgid "Commit Log Messages" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2362 +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:2363 +#, no-wrap +msgid "Why are commit messages important?" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2367 +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 " +"commit message. How important is this commit message? Should you spend some " +"significant effort writing it? Does it really matter if you write simply " +"fixed a bug?" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2370 +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:2373 +msgid "" +"FreeBSD has hundreds of active developers and hundreds of thousands of " +"commits spanning decades of history. Over that time the developer community " +"has learned how valuable good commit messages are; sometimes these are hard-" +"learned lessons." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2375 +msgid "Commit messages serve at least three purposes:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2382 +#, no-wrap +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2388 +#, no-wrap +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2394 +#, no-wrap +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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2396 +#, 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" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2398 +#, no-wrap +msgid "Having established the importance, here are elements of a good FreeBSD commit message:\n" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:2399 +#, no-wrap +msgid "Start with a subject line" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2403 +msgid "" +"Commit messages should start with a single-line subject that briefly " +"summarizes the change. The subject should, by itself, allow the reader to " +"quickly determine if the change is of interest or not." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:2404 +#, no-wrap +msgid "Keep subject lines short" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2409 +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 " +"aim for about 50 or fewer if possible." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:2410 +#, 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:2413 +msgid "" +"If the change relates to a specific component the subject line may be " +"prefixed with that component name and a colon (:)." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2415 +msgid "✓ `foo: Add -k option to keep temporary data`" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2417 +msgid "" +"Include the prefix in the 63-character limit suggested above, so that `git " +"log --oneline` avoids wrapping." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:2418 +#, no-wrap +msgid "Capitalize the first letter of the subject" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2422 +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:2423 +#, no-wrap +msgid "Do not end the subject line with punctuation" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2427 +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:2428 +#, 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:2431 +msgid "Separate the body from the subject with a blank line." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2433 +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:2435 +msgid "✓ `ls: Fix typo in usage text`" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:2436 +#, no-wrap +msgid "Limit messages to 72 columns" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2442 +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. " +"Limiting messages to 72 characters also keeps the commit message in " +"formatted patches below RFC 2822's suggested email line length limit of 78 " +"characters. This limit works well with a variety of tools that may render " +"commit messages; line wrapping might be inconsistent with longer line length." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:2443 +#, no-wrap +msgid "Use the present tense, imperative mood" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2448 +msgid "" +"This facilitates short subject lines and provides consistency, including " +"with automatically generated commit messages (e.g., as generated by git " +"revert). This is important when reading a list of commit subjects. Think " +"of the subject as finishing the sentence \"when applied, this change will ..." +"\"." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2453 +#, no-wrap +msgid "" +"✓ `foo: Implement the -k (keep) option`\n" +"✗ `foo: Implemented the -k option`\n" +"✗ `This change implements the -k option in foo`\n" +"✗ `-k option added`" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:2454 +#, no-wrap +msgid "Focus on what and why, not how" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2457 +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:2461 +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:2463 +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:2464 +#, 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:2467 +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. " +"When this happens consider whether it would be valuable to have that " +"explanation as a comment in the code itself." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:2468 +#, no-wrap +msgid "Write commit messages for your future self" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2472 +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 " +"and rejected, limitations of the change, and so on. Imagine yourself " +"revisiting the change a year or two in the future, and write the commit " +"message in a way that would provide that necessary context." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:2473 +#, no-wrap +msgid "Commit messages should stand alone" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2477 +msgid "" +"You may include references to mailing list postings, benchmark result web " +"sites, or code review links. However, the commit message should contain all " +"of the relevant information in case these references are no longer available " +"in the future." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2481 +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 " +"hash), include the subject line from the referenced commit (or another " +"suitable brief reference). With each VCS migration (from CVS to Subversion " +"to Git) revision identifiers from previous systems may become difficult to " +"follow." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:2482 +#, no-wrap +msgid "Include appropriate metadata in a footer" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2485 +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:2487 +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:2489 +msgid "The key words or phrases are:" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2494 +#, no-wrap +msgid "" +"[.informaltable]\n" +"[cols=\"20%,80%\", frame=\"none\"]" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2495 +#, no-wrap +msgid "`PR:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2497 +#, 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:2498 +#, no-wrap +msgid "`Reported by:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2502 +#, 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" +"Typically used when there is no PR, for example if the issue was reported on\n" +"a mailing list." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2504 +#, no-wrap +msgid "" +"`Submitted by:` +\n" +"(deprecated)" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2506 +#, 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:2507 +#, no-wrap +msgid "`Reviewed by:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2522 +#, 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" +"\n" +"Reviewed by a developer:\n" +"[source,shell]\n" +"....\n" +"Reviewed by: username\n" +"....\n" +"\n" +"Reviewed by a ports maintainer that is not a developer:\n" +"[source,shell]\n" +"....\n" +"Reviewed by: Full Name <valid@email> (maintainer)\n" +"...." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2523 +#, no-wrap +msgid "`Tested by:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2525 +#, 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:2526 +#, no-wrap +msgid "`Approved by:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2552 +#, 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" +"\n" +"There are several cases where approval is customary:\n" +"\n" +"* while a new committer is under mentorship\n" +"* commits to an area of the tree covered by the LOCKS file (src)\n" +"* during a release cycle\n" +"* committing to a repo where you do not hold a commit bit (e.g. src committer committing to docs)\n" +"* committing to a port maintained by someone else\n" +"\n" +"While under mentorship, get mentor approval before the commit. Enter the mentor's username in this field, and note that they are a mentor:\n" +"\n" +"[source,shell]\n" +"....\n" +"Approved by: username-of-mentor (mentor)\n" +"....\n" +"\n" +"If a team approved these commits then include the team name followed by the username of the approver in parentheses. For example:\n" +"\n" +"[source,shell]\n" +"....\n" +"Approved by: re (username)\n" +"...." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2553 +#, no-wrap +msgid "`Obtained from:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2555 +#, 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:2556 +#, no-wrap +msgid "`Fixes:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2558 +#, 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 --oneline GIT-COMMIT-HASH`." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2559 +#, no-wrap +msgid "`MFC after:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2561 +#, 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:2562 +#, no-wrap +msgid "`MFC to:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2564 +#, 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:2565 +#, no-wrap +msgid "`MFH:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2567 +#, 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:2568 +#, no-wrap +msgid "`Relnotes:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2570 +#, 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:2571 +#, no-wrap +msgid "`Security:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2573 +#, 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:2574 +#, no-wrap +msgid "`Event:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2576 +#, 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:2577 +#, no-wrap +msgid "`Sponsored by:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2579 +#, 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:2580 +#, no-wrap +msgid "`Pull Request:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2584 +#, 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" +"It should include the entire URL to the pull request, as these often act as code reviews for the code.\n" +"For example: `https://github.com/freebsd/freebsd-src/pull/745`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2585 +#, no-wrap +msgid "`Co-authored-by:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2588 +#, no-wrap +msgid "" +"The name and email address of an additional author of the commit.\n" +"GitHub has a detailed description of the Co-authored-by trailer at https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors." +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2589 +#, no-wrap +msgid "`Signed-off-by:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2591 +#, no-wrap +msgid "ID certifies compliance with https://developercertificate.org/" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2592 +#, no-wrap +msgid "`Differential Revision:`" +msgstr "" + +#. type: Table +#: documentation/content/en/articles/committers-guide/_index.adoc:2594 +#, 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:2596 +#, 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:2602 +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:2606 +#: documentation/content/en/articles/committers-guide/_index.adoc:2624 +#: documentation/content/en/articles/committers-guide/_index.adoc:2639 +#: documentation/content/en/articles/committers-guide/_index.adoc:2655 +#: documentation/content/en/articles/committers-guide/_index.adoc:2670 +#, no-wrap +msgid "...\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2608 +#, no-wrap +msgid "PR:\t\t12345\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2611 +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:2614 +#, no-wrap +msgid "Commit Log for a Commit Needing Review" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2620 +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 " +"been approved." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2626 +#, no-wrap +msgid "Reviewed by:\t-arch\n" +msgstr "" + +#. type: Block title +#: documentation/content/en/articles/committers-guide/_index.adoc:2630 +#, no-wrap +msgid "Commit Log for a Commit Needing Approval" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2635 +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:2641 +#, no-wrap +msgid "Approved by:\tabc (maintainer)\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2644 +msgid "Where _abc_ is the account name of the person who approved." +msgstr "" + +#. type: Block title +#: documentation/content/en/articles/committers-guide/_index.adoc:2646 +#, 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:2651 +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:2657 +#, no-wrap +msgid "Obtained from:\tOpenBSD\n" +msgstr "" + +#. type: Block title +#: documentation/content/en/articles/committers-guide/_index.adoc:2661 +#, 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:2666 +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:2672 +#, no-wrap +msgid "MFC after:\t2 weeks\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2675 +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`, " +"`months`." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2678 +msgid "It is often necessary to combine these." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2682 +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 " +"of the tree they normally work in, so they have the change reviewed by the " +"`arch` mailing list. Since the change is complex, the developer opts to MFC " +"after one month to allow adequate testing." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2684 +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:2685 +#, no-wrap +msgid "Example Combined Commit Log" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2696 +#, no-wrap +msgid "" +"PR:\t\t54321\n" +"Reviewed by:\t-arch\n" +"Obtained from:\tNetBSD\n" +"MFC after:\t1 month\n" +"Relnotes:\tyes\n" +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:2701 +#, no-wrap +msgid "Preferred License for New Files" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2707 +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/" +"software-license]. The rest of this section is intended to help you get " +"started. As a rule, when in doubt, ask. It is much easier to give advice " +"than to fix the source tree." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2709 +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:2740 +#, no-wrap +msgid "" +"/*-\n" +" * SPDX-License-Identifier: BSD-2-Clause\n" +" *\n" +" * Copyright (c) [year] [your name]\n" +" *\n" +" * Redistribution and use in source and binary forms, with or without\n" +" * modification, are permitted provided that the following conditions\n" +" * are met:\n" +" * 1. Redistributions of source code must retain the above copyright\n" +" * notice, this list of conditions and the following disclaimer.\n" +" * 2. Redistributions in binary form must reproduce the above copyright\n" +" * notice, this list of conditions and the following disclaimer in the\n" +" * documentation and/or other materials provided with the distribution.\n" +" *\n" +" * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND\n" +" * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n" +" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\n" +" * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE\n" +" * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n" +" * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\n" +" * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\n" +" * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\n" +" * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\n" +" * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\n" +" * SUCH DAMAGE.\n" +" *\n" +" * [id for your version control system, if any]\n" +" */\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2746 +msgid "" +"The FreeBSD project strongly discourages the so-called \"advertising " +"clause\" in new code. Due to the large number of contributors to the " +"FreeBSD project, complying with this clause for many commercial vendors has " +"become difficult. If you have code in the tree with the advertising clause, " +"please consider removing it. In fact, please consider using the above " +"license for your code." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2750 +msgid "" +"The FreeBSD project discourages completely new licenses and variations on " +"the standard licenses. New licenses require the approval of {core-email} to " +"reside in the `src` repository. The more different licenses that are used " +"in the tree, the more problems that this causes to those wishing to utilize " +"this code, typically from unintended consequences from a poorly worded " +"license." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2754 +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 " +"must be conditional or even disabled by default. For example, the GENERIC " +"kernel must be compiled under only licenses identical to or substantially " +"similar to the BSD license. GPL, APSL, CDDL, etc, licensed software must " +"not be compiled into GENERIC." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2757 +msgid "" +"Developers are reminded that in open source, getting \"open\" right is just " +"as important as getting \"source\" right, as improper handling of " +"intellectual property has serious consequences. Any questions or concerns " +"should immediately be brought to the attention of the core team." +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:2759 +#, no-wrap +msgid "Keeping Track of Licenses Granted to the FreeBSD Project" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2764 +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 " +"are the Terminus fonts for use with man:vt[4]. Here the author Dimitar " +"Zhekov has allowed us to use the \"Terminus BSD Console\" font under a 2-" +"clause BSD license rather than the regular Open Font License he normally " +"uses." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2769 +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 " +"FreeBSD project is granted a special license we require the {core-email} to " +"be notified. Any developers involved in arranging such a license grant, " +"please send details to the {core-email} including:" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2771 +msgid "" +"Contact details for people or organizations granting the special license." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2772 +msgid "" +"What files, directories etc. in the repositories are covered by the license " +"grant including the revision numbers where any specially licensed material " +"was committed." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2773 +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 " +"question." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2774 +msgid "The license text." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2775 +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:2776 +msgid "Any other relevant information." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2779 +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 " +"acknowledgment of receipt including the license details. This receipt will " +"be persistently archived and serve as our permanent record of the license " +"grant." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2782 +msgid "" +"The license archive should contain only details of license grants; this is " +"not the place for any discussions around licensing or other subjects. " +"Access to data within the license archive will be available on request to " +"the {core-email}." +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:2784 +#, no-wrap +msgid "SPDX Tags in the tree" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2795 +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 " +"requirements mechanically. All _SPDX-License-Identifier_ tags in the tree " +"should be considered to be informative. All files in the FreeBSD source " +"tree with these tags also have a copy of the license which governs use of " +"that file. In the event of a discrepancy, the verbatim license is " +"controlling. The project tries to follow the https://spdx.github.io/spdx-" +"spec/[SPDX Specification, Version 2.2]. How to mark source files and valid " +"algebraic expressions are found in https://spdx.github.io/spdx-spec/appendix-" +"IV-SPDX-license-expressions/[Appendix IV] and https://spdx.github.io/spdx-" +"spec/appendix-V-using-SPDX-short-identifiers-in-source-files/[Appendix V]. " +"The project draws identifiers from SPDX's list of valid https://spdx.org/" +"licenses/[short license identifiers]. The project uses only the _SPDX-" +"License-Identifier_ tag." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2797 +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:2798 +#, no-wrap +msgid "Developer Relations" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2804 +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 " +"check with other committers before jumping in with a commit. When working " +"on a bug in an area of the system which is clearly orphaned (and there are a " +"few such areas, to our shame), the same applies. When modifying parts of " +"the system which are maintained, formally or informally, consider asking for " +"a review just as a developer would have before becoming a committer. For " +"ports, contact the listed `MAINTAINER` in the [.filename]#Makefile#." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2808 +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 " +"history to see who has committed changes in the past. To list the names and " +"email addresses of all commit authors for a given file in the last 2 years " +"and the number of commits each has authored, ordered by descending number of " +"commits, use:" +msgstr "" + +#. type: delimited block - 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2812 +#, 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:2815 +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:2820 +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:2826 +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 " +"it is part of the repository. If a commit does results in controversy " +"erupting, it may be advisable to consider backing the change out again until " +"the matter is settled. Remember, with a version control system we can " +"always change it back." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2830 +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 " +"stupid, because they have questionable parentage, or because they are trying " +"to destroy hard work, personal image, or FreeBSD, but basically because they " +"have a different outlook on the world. Different is good." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2833 +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 " +"their vision of the problem, with an open mind." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2839 +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 " +"not beat up others for your mistake. Do not waste time on embarrassment or " +"recrimination, just fix the problem and move on." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2843 +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 " +"it; this does not apply if nobody will review code." +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:2845 +#, no-wrap +msgid "If in Doubt..." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2849 +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:2853 +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 " +"way everyone will be able to learn from the question and the answer." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2855 +msgid "For project specific or administrative questions ask, in order:" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2857 +msgid "Your mentor or former mentor." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2858 +msgid "An experienced committer on IRC, email, etc." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2859 +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:2860 +msgid "If still not sure, ask on {developers-name}." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2862 +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 " +"the same question." +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:2864 +#, no-wrap +msgid "Bugzilla" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2869 +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 " +"sure to close the PR. It is also considered nice if you take time to close " +"any other PRs associated with your commits." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2871 +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:2875 +msgid "Log in using your old account." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2876 +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:2877 +msgid "" +"Log in using `FreeBSD.org` account and post comment to newly opened bug to " +"confirm ownership. See <<kerberos-ldap>> for more details on how to generate " +"or set a password for your `FreeBSD.org` account." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2878 +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:2881 +msgid "You can find out more about Bugzilla at:" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2883 +msgid "extref:{pr-guidelines}[FreeBSD Problem Report Handling Guidelines]" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2884 +msgid "link:https://www.FreeBSD.org/support/[https://www.FreeBSD.org/support]" +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:2886 +#, no-wrap +msgid "Phabricator" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2890 +msgid "" +"The FreeBSD Project utilizes https://reviews.freebsd.org[Phabricator] for " +"code review requests. See the https://wiki.freebsd.org/" +"Phabricator[Phabricator wiki page] for details." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2892 +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:2896 +msgid "Change your Phabricator account email to your `FreeBSD.org` email." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2897 +msgid "" +"Open new bug on our bug tracker using your `FreeBSD.org` account, see " +"<<bugzilla>> for more information. Choose `Services` as the Product, and " +"`Code Review` as the Component. In bug description request that your " +"Phabricator account be renamed, and provide a link to your Phabricator user. " +"For example, `https://reviews.freebsd.org/p/bob_example.com/`" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2902 +msgid "" +"Phabricator accounts cannot be merged, please do not open a new account." +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:2905 +#, no-wrap +msgid "Who's Who" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2908 +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. " +"Briefly, and by no means all-inclusively, these are:" +msgstr "" + +#. type: Labeled list +#: documentation/content/en/articles/committers-guide/_index.adoc:2909 +#, no-wrap +msgid "`{doceng}`" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2915 +msgid "" +"doceng is the group responsible for the documentation build infrastructure, " +"approving new documentation committers, and ensuring that the FreeBSD " +"website and documentation on the FTP site is up to date with respect to the " +"Subversion tree. It is not a conflict resolution body. The vast majority " +"of documentation related discussion takes place on the {freebsd-doc}. More " +"details regarding the doceng team can be found in its https://www.FreeBSD." +"org/internal/doceng/[charter]. Committers interested in contributing to the " +"documentation should familiarize themselves with the extref:{fdp-primer}" +"[Documentation Project Primer]." +msgstr "" + +#. type: Labeled list +#: documentation/content/en/articles/committers-guide/_index.adoc:2916 +#, no-wrap +msgid "`{re-members}`" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2921 +msgid "" +"These are the members of the `{re}`. This team is responsible for setting " +"release deadlines and controlling the release process. During code freezes, " +"the release engineers have final authority on all changes to the system for " +"whichever branch is pending release status. If there is something you want " +"merged from FreeBSD-CURRENT to FreeBSD-STABLE (whatever values those may " +"have at any given time), these are the people to talk to about it." +msgstr "" + +#. type: Labeled list +#: documentation/content/en/articles/committers-guide/_index.adoc:2922 +#, no-wrap +msgid "`{so}`" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2924 +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:2929 +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 " +"to. _Never_ send email directly to these lists. Only send replies to this " +"list when they are short and are directly related to a commit." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2934 +msgid "" +"{developers-name}:: All committers are subscribed to -developers. This list " +"was created to be a forum for the committers \"community\" issues. Examples " +"are Core voting, announcements, etc." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2938 +msgid "" +"The {developers-name} is for the exclusive use of FreeBSD committers. To " +"develop FreeBSD, committers must have the ability to openly discuss matters " +"that will be resolved before they are publicly announced. Frank discussions " +"of work in progress are not suitable for open publication and may harm " +"FreeBSD." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2942 +msgid "" +"All FreeBSD committers are expected not to not publish or forward messages " +"from the {developers-name} outside the list membership without permission of " +"all of the authors. Violators will be removed from the {developers-name}, " +"resulting in a suspension of commit privileges. Repeated or flagrant " +"violations may result in permanent revocation of commit privileges." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2948 +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 " +"a sense of a closed list where general decisions affecting all of the " +"FreeBSD using community are made without being \"open\". Last, but not " +"least __never, never ever, email the {developers-name} and CC:/BCC: another " +"FreeBSD list__. Never, ever email another FreeBSD email list and CC:/BCC: " +"the {developers-name}. Doing so can greatly diminish the benefits of this " +"list." +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:2949 +#, no-wrap +msgid "SSH Quick-Start Guide" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2954 +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 " +"convenience. If you want to use man:ssh-agent[1], make sure that you run it " +"before running other applications. X users, for example, usually do this " +"from their [.filename]#.xsession# or [.filename]#.xinitrc#. See man:ssh-" +"agent[1] for details." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2955 +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:2959 +msgid "Only ECDSA, Ed25519 or RSA keys are supported." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:2961 +msgid "" +"Send your public key ([.filename]#$HOME/.ssh/id_ecdsa.pub#, [." +"filename]#$HOME/.ssh/id_ed25519.pub#, or [.filename]#$HOME/.ssh/id_rsa.pub#) " +"to the person setting you up as a committer so it can be put into [." +"filename]#yourlogin# in [.filename]#/etc/ssh-keys/# on `freefall`." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2966 +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 " +"authentication agent (man:ssh-agent[1]). Use `ssh-add -d` to remove keys " +"stored in the agent." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2968 +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:2970 +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:2972 +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:2974 +#, no-wrap +msgid "Coverity(R) Availability for FreeBSD Committers" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2978 +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 " +"analysis results of the automated Coverity runs, can sign up at http://scan." +"coverity.com/[Coverity Scan]." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2981 +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/" +"CoverityPrevent[https://wiki.freebsd.org/CoverityPrevent]. Please note that " +"this mini-guide is only readable by FreeBSD developers, so if you cannot " +"access this page, you will have to ask someone to add you to the appropriate " +"Wiki access list." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2983 +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 " +"questions to the mailing list of the FreeBSD developers." +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:2985 +#, no-wrap +msgid "The FreeBSD Committers' Big List of Rules" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2990 +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-" +"conduct/[https://www.FreeBSD.org/internal/code-of-conduct]. As committers, " +"you form the public face of the project, and how you behave has a vital " +"impact on the public perception of it. This guide expands on the parts of " +"the _Code of Conduct_ specific to committers." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2992 +#: documentation/content/en/articles/committers-guide/_index.adoc:3022 +msgid "Respect other committers." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2993 +#: documentation/content/en/articles/committers-guide/_index.adoc:3038 +msgid "Respect other contributors." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2994 +#: documentation/content/en/articles/committers-guide/_index.adoc:3053 +msgid "Discuss any significant change _before_ committing." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2995 +msgid "" +"Respect existing maintainers (if listed in the `MAINTAINER` field in [." +"filename]#Makefile# or in [.filename]#MAINTAINER# in the top-level " +"directory)." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2996 +#: documentation/content/en/articles/committers-guide/_index.adoc:3068 +msgid "" +"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." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2997 +msgid "" +"Changes go to FreeBSD-CURRENT before FreeBSD-STABLE unless specifically " +"permitted by the release engineer or unless they are not applicable to " +"FreeBSD-CURRENT. Any non-trivial or non-urgent change which is applicable " +"should also be allowed to sit in FreeBSD-CURRENT for at least 3 days before " +"merging so that it can be given sufficient testing. The release engineer has " +"the same authority over the FreeBSD-STABLE branch as outlined for the " +"maintainer in rule #5." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:2998 +#: documentation/content/en/articles/committers-guide/_index.adoc:3083 +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:2999 +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:3000 +#: documentation/content/en/articles/committers-guide/_index.adoc:3098 +msgid "When in doubt on any procedure, ask first!" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3001 +#: documentation/content/en/articles/committers-guide/_index.adoc:3103 +msgid "Test your changes before committing them." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3002 +#: documentation/content/en/articles/committers-guide/_index.adoc:3112 +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:3013 +msgid "" +"As noted, breaking some of these rules can be grounds for suspension or, " +"upon repeated offense, permanent removal of commit privileges. Individual " +"members of core have the power to temporarily suspend commit privileges " +"until core as a whole has the chance to review the issue. In case of an " +"\"emergency\" (a committer doing damage to the repository), a temporary " +"suspension may also be done by the repository meisters. Only a 2/3 majority " +"of core has the authority to suspend commit privileges for longer than a " +"week or to remove them permanently. This rule does not exist to set core up " +"as a bunch of cruel dictators who can dispose of committers as casually as " +"empty soda cans, but to give the project a kind of safety fuse. If someone " +"is out of control, it is important to be able to deal with this immediately " +"rather than be paralyzed by debate. In all cases, a committer whose " +"privileges are suspended or revoked is entitled to a \"hearing\" by core, " +"the total duration of the suspension being determined at that time. A " +"committer whose privileges are suspended may also request a review of the " +"decision after 30 days and every 30 days thereafter (unless the total " +"suspension period is less than 30 days). A committer whose privileges have " +"been revoked entirely may request a review after a period of 6 months has " +"elapsed. This review policy is _strictly informal_ and, in all cases, core " +"reserves the right to either act on or disregard requests for review if they " +"feel their original decision to be the right one." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3017 +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 " +"does not mean that they have special dispensation to step outside any of the " +"lines painted here; core's \"special powers\" only kick in when it acts as a " +"group, not on an individual basis. As individuals, the core team members " +"are all committers first and core second." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3018 +#, no-wrap +msgid "Details" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3026 +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 " +"contrary, one does not get to be a committer by being stupid and nothing " +"rankles more than being treated that way by one of your peers. Whether we " +"always feel respect for one another or not (and everyone has off days), we " +"still have to _treat_ other committers with respect at all times, on public " +"forums and in private email." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3028 +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 " +"arguments about code into issues that affect our long-term ability to work " +"harmoniously together is just not worth the trade-off by any conceivable " +"stretch of the imagination." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3034 +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 " +"confrontational. First calm down, then think about how to communicate in " +"the most effective fashion for convincing the other persons that your side " +"of the argument is correct, do not just blow off some steam so you can feel " +"better in the short term at the cost of a long-term flame war. Not only is " +"this very bad \"energy economics\", but repeated displays of public " +"aggression which impair our ability to work well together will be dealt with " +"severely by the project leadership and may result in suspension or " +"termination of your commit privileges. The project leadership will take " +"into account both public and private communications brought before it. It " +"will not seek the disclosure of private communications, but it will take it " +"into account if it is volunteered by the committers involved in the " +"complaint." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3037 +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 " +"trading that away." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3050 +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 " +"and attention. Do not forget that your work as a contributor was very " +"important to you. Remember what it was like. Do not discourage, belittle, " +"or demean contributors. Treat them with respect. They are our committers in " +"waiting. They are every bit as important to the project as committers. " +"Their contributions are as valid and as important as your own. After all, " +"you made many contributions before you became a committer. Always remember " +"that." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3052 +msgid "" +"Consider the points raised under <<respect,Respect other committers>> and " +"apply them also to contributors." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3059 +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 " +"Phabricator service. The commit will only happen once something resembling " +"consensus has been reached. This does not mean that permission is required " +"before correcting every obvious syntax error or manual page misspelling, " +"just that it is good to develop a feel for when a proposed change is not " +"quite such a no-brainer and requires some feedback first. People really do " +"not mind sweeping changes if the result is something clearly better than " +"what they had before, they just do not like being _surprised_ by those " +"changes. The very best way of making sure that things are on the right " +"track is to have code reviewed by one or more other committers." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3061 +msgid "When in doubt, ask for review!" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3062 +msgid "Respect existing maintainers if listed." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3067 +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, " +"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." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3073 +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 " +"system makes it unnecessary to have an ongoing dispute raging when it is far " +"easier to simply reverse the disputed change, get everyone calmed down again " +"and then try to figure out what is the best way to proceed. If the change " +"turns out to be the best thing after all, it can be easily brought back. If " +"it turns out not to be, then the users did not have to live with the bogus " +"change in the tree while everyone was busily debating its merits. People " +"_very_ rarely call for back-outs in the repository since discussion " +"generally exposes bad or controversial changes before the commit even " +"happens, but on such rare occasions the back-out should be done without " +"argument so that we can get immediately on to the topic of figuring out " +"whether it was bogus or not." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3074 +msgid "" +"Changes go to FreeBSD-CURRENT before FreeBSD-STABLE unless specifically " +"permitted by the release engineer or unless they are not applicable to " +"FreeBSD-CURRENT. Any non-trivial or non-urgent change which is applicable " +"should also be allowed to sit in FreeBSD-CURRENT for at least 3 days before " +"merging so that it can be given sufficient testing. The release engineer has " +"the same authority over the FreeBSD-STABLE branch as outlined in rule #5." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3080 +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 " +"turns out to be bad. Please respect this and give the release engineer your " +"full cooperation when it comes to the FreeBSD-STABLE branch. The management " +"of FreeBSD-STABLE may frequently seem to be overly conservative to the " +"casual observer, but also bear in mind the fact that conservatism is " +"supposed to be the hallmark of FreeBSD-STABLE and different rules apply " +"there than in FreeBSD-CURRENT. There is also really no point in having " +"FreeBSD-CURRENT be a testing ground if changes are merged over to FreeBSD-" +"STABLE immediately. Changes need a chance to be tested by the FreeBSD-" +"CURRENT developers, so allow some time to elapse before merging unless the " +"FreeBSD-STABLE fix is critical, time sensitive or so obvious as to make " +"further testing unnecessary (spelling fixes to manual pages, obvious bug/" +"typo fixes, etc.) In other words, apply common sense." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3082 +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 " +"member of the `{re}`." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3093 +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. " +"There will be occasions when, despite everyone's very best attempts at self-" +"control, tempers are lost and angry words are exchanged. The best thing " +"that can be done in such cases is to minimize the effects of this until " +"everyone has cooled back down. Do not air angry words in public and do not " +"forward private correspondence or other private communications to public " +"mailing lists, mail aliases, instant messaging channels or social media " +"sites. What people say one-to-one is often much less sugar-coated than what " +"they would say in public, and such communications therefore have no place " +"there - they only serve to inflame an already bad situation. If the person " +"sending a flame-o-gram at least had the grace to send it privately, then " +"have the grace to keep it private yourself. If you feel you are being " +"unfairly treated by another developer, and it is causing you anguish, bring " +"the matter up with core rather than taking it public. Core will do its best " +"to play peace makers and get things back to sanity. In cases where the " +"dispute involves a change to the codebase and the participants do not appear " +"to be reaching an amicable agreement, core may appoint a mutually-agreeable " +"third party to resolve the dispute. All parties involved must then agree to " +"be bound by the decision reached by this third party." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3094 +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:3097 +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 " +"jumping in after a long absence and committing 10 megabytes worth of " +"accumulated stuff. People who abuse this on a regular basis will have their " +"commit privileges suspended until they get back from the FreeBSD Happy " +"Reeducation Camp we run in Greenland." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3102 +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, " +"chances are good that you do not actually know the way we do things and " +"really need to ask first or you are going to completely embarrass yourself " +"in public. There is no shame in asking \"how in the heck do I do this?\" We " +"already know you are an intelligent person; otherwise, you would not be a " +"committer." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3111 +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 " +"still make world. If your changes are to a branch, make sure your testing " +"occurs with a machine which is running that code. If you have a change " +"which also may break another architecture, be sure and test on all supported " +"architectures. Please ensure your change works for <<compilers,supported " +"toolchains>>. Please refer to the https://www.FreeBSD.org/internal/[FreeBSD " +"Internal Page] for a list of available resources. As other architectures " +"are added to the FreeBSD supported platforms list, the appropriate shared " +"testing resources will be made available." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3114 +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:3119 +msgid "" +"The trees mentioned above are for contributed software usually imported onto " +"a vendor branch. Committing something there may cause unnecessary headaches " +"when importing newer versions of the software. As a general consider " +"sending patches upstream to the vendor. Patches may be committed to FreeBSD " +"first with permission of the maintainer." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3123 +msgid "" +"Reasons for modifying upstream software range from wanting strict control " +"over a tightly coupled dependency to lack of portability in the canonical " +"repository's distribution of their code. Regardless of the reason, effort " +"to minimize the maintenance burden of fork is helpful to fellow " +"maintainers. Avoid committing trivial or cosmetic changes to files since it " +"makes every merge thereafter more difficult: such patches need to be " +"manually re-verified every import." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3126 +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 " +"{freebsd-arch} and ask." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3127 +#, no-wrap +msgid "Policy on Multiple Architectures" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3131 +msgid "" +"FreeBSD has added several new architecture ports during recent release " +"cycles and is truly no longer an i386(TM) centric operating system. 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:3135 +msgid "" +"Our 32-bit reference platform is i386, and our 64-bit reference platform is " +"amd64. Major design work (including major API and ABI changes) must prove " +"itself on at least one 32-bit and at least one 64-bit platform, preferably " +"the primary reference platforms, before it may be committed to the source " +"tree." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3139 +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 " +"during the development process, and are distinct from the requirements for " +"features and architectures listed in that section. The Tier rules for " +"feature support on architectures at release-time are more strict than the " +"rules for changes during the development process." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3141 +#, no-wrap +msgid "Policy on Multiple Compilers" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3155 +msgid "" +"FreeBSD builds with both Clang and GCC. The project does this in a careful " +"and controlled way to maximize benefits from this extra work, while keeping " +"the extra work to a minimum. Supporting both Clang and GCC improves the " +"flexibility our users have. These compilers have different strengths and " +"weaknesses, and supporting both allows users to pick the best one for their " +"needs. Clang and GCC support similar dialects of C and C++, necessitating a " +"relatively small amount of conditional code. The project gains increased " +"code coverage and improves the code quality by using features from both " +"compilers. The project is able to build in more user environments and " +"leverage more CI environments by supporting this range, increasing " +"convenience for users and giving them more tools to test with. By carefully " +"constraining the range of versions supported to modern versions of these " +"compilers, the project avoids unduly increasing the testing matrix. Older " +"and obscure compilers, as well as older dialects of the languages, have " +"extremely limited support that allow user programs to build with them, but " +"without constraining the base system to being built with them. The exact " +"balance continues to evolve to ensure the benefits of extra work remain " +"greater than the burdens it imposes. The project used to support really old " +"Intel compilers or old GCC versions, but we traded supporting those obsolete " +"compilers for a carefully selected range of modern compilers. This section " +"documents where we use different compilers, and the expectations around that." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3160 +msgid "" +"The FreeBSD project provides an in-tree Clang compiler. Due to being in the " +"tree, this compiler is the most supported compiler. All changes must " +"compile with it, prior to commit. Complete testing, as appropriate for the " +"change, should be done with this compiler." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3168 +msgid "" +"At any moment in time, the FreeBSD project also supports one or more out-of-" +"tree compilers. At present, this is GCC 12.x. Ideally, committers should " +"test compile with this compiler, especially for large or risky changes. " +"This compiler is available as the `${TARGET_ARCH}-gcc${VERSION}` package, " +"such as package:devel/freebsd-gcc12@aarch64[aarch64-gcc12] or package:devel/" +"freebsd-gcc12@riscv64[riscv64-gcc12]. The project runs automated CI jobs to " +"build everything with these compilers. Committers are expected to fix the " +"jobs they break with their changes. Committers may test build with, for " +"example `CROSS_TOOLCHAIN=aarch64-gcc12` or `CROSS_TOOLCHAIN=llvm15` where " +"necessary." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3172 +msgid "" +"The FreeBSD project also has some CI pipelines on github. For pull requests " +"on github and some branches pushed to the github forks, a number of cross " +"compilation jobs run. These test FreeBSD building using a version of Clang " +"that sometimes lags the in-tree compiler by a major version for a time." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3178 +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 " +"removing the old-style K&R function declarations and definitions, will land " +"in the tree prior to the compiler landing. Committers should try to be " +"mindful about this and be receptive to looking into problems with their code " +"or changes with these new compilers. Also, just after a new compiler " +"version hits the tree, people may need to compile things with the old " +"version if there was an undetected regression suspected." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3182 +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 " +"assembler syntax and features of the linkers and ensure both variants work. " +"These components will be tested as part of FreeBSD's CI jobs for Clang or " +"GCC." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3188 +msgid "" +"The FreeBSD project provides headers and libraries that allow other " +"compilers to be used to build software not in the base system. These " +"headers have support for making the environment as strict as the standard, " +"supporting prior dialects of ANSI-C back to C89, and other edge cases our " +"large ports collection has uncovered. This support constrains retirement of " +"older standards in places like header files, but does not constrain updating " +"the base system to newer dialects. Nor does it require the base system to " +"compile with these older standards as a whole. Breaking this support will " +"cause packages in the ports collection to fail, so should be avoided where " +"possible, and promptly fixed when it is easy to do so." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3193 +msgid "" +"The FreeBSD build system currently accommodates these different " +"environments. As new warnings are added to compilers, the project tries to " +"fix them. However, sometimes these warnings require extensive rework, so " +"are suppressed in some way by using make variables that evaluate to the " +"proper thing depending on the compiler version. Developers should be " +"mindful of this, and ensure any compiler specific flags are properly " +"conditionalized." +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3194 +#, no-wrap +msgid "Current Compiler Versions" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3199 +msgid "" +"The in-tree compiler is currently Clang 15.x. Currently, GCC 12 and Clang " +"12, 13, 14 and 15 are tested in the github and project's CI jenkins jobs. " +"Work is underway to get the tree ready for Clang 16. The oldest project " +"supported branch has Clang 12, so the bootstrap portions of the build must " +"work for Clang major versions 12 to 15." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3200 +#, no-wrap +msgid "Other Suggestions" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3204 +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:3206 +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 " +"references are correct and that the man page has all of the appropriate " +"`MLINKS` installed." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3213 +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 " +"obfuscates the functionality change when asking for differences between " +"revisions, which can hide any new bugs. Do not include whitespace changes " +"with content changes in commits to [.filename]#doc/#. The extra clutter in " +"the diffs makes the translators' job much more difficult. Instead, make any " +"style or whitespace changes in separate commits that are clearly labeled as " +"such in the commit message." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3214 +#, no-wrap +msgid "Deprecating Features" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3217 +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:3219 +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:3220 +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:3221 +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 " +"release notes." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3222 +#, no-wrap +msgid "Privacy and Confidentiality" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3225 +msgid "Most FreeBSD business is done in public." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3228 +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:3229 +msgid "Certain sensitive matters must remain private or held under embargo." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3235 +msgid "" +"There unfortunately cannot be complete transparency. As a FreeBSD developer " +"you will have a certain degree of privileged access to information. " +"Consequently you are expected to respect certain requirements for " +"confidentiality. Sometimes the need for confidentiality comes from external " +"collaborators or has a specific time limit. Mostly though, it is a matter " +"of not releasing private communications." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3236 +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:3241 +msgid "" +"Where there are security problems that affect many different operating " +"systems, FreeBSD frequently depends on early access to be able to prepare " +"advisories for coordinated release. Unless FreeBSD developers can be " +"trusted to maintain security, such early access will not be made available. " +"The Security Officer is responsible for controlling pre-release access to " +"information about vulnerabilities, and for timing the release of all " +"advisories. He may request help under condition of confidentiality from any " +"developer with relevant knowledge to prepare security fixes." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3242 +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:3247 +msgid "" +"Communications to core will initially be treated as confidential. " +"Eventually however, most of Core's business will be summarized into the " +"monthly or quarterly core reports. Care will be taken to avoid publicising " +"any sensitive details. Records of some particularly sensitive subjects may " +"not be reported on at all and will be retained only in Core's private " +"archives." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3248 +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:3251 +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:3252 +msgid "Private communications must not be made public without permission." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3255 +msgid "" +"Beyond the specific requirements above there is a general expectation not to " +"publish private communications between developers without the consent of all " +"parties involved. Ask permission before forwarding a message onto a public " +"mailing list, or posting it to a forum or website that can be accessed by " +"other than the original correspondents." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3256 +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:3259 +msgid "" +"Similarly to personal communications, certain internal communications " +"channels, including FreeBSD Committer only mailing lists and restricted " +"access IRC channels are considered private communications. Permission is " +"required to publish material from these sources." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3260 +msgid "Core may approve publication." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3262 +msgid "" +"Where it is impractical to obtain permission due to the number of " +"correspondents or where permission to publish is unreasonably withheld, Core " +"may approve release of such private matters that merit more general " +"publication." +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:3264 +#, no-wrap +msgid "Support for Multiple Architectures" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3271 +msgid "" +"FreeBSD is a highly portable operating system intended to function on many " +"different types of hardware architectures. Maintaining clean separation of " +"Machine Dependent (MD) and Machine Independent (MI) code, as well as " +"minimizing MD code, is an important part of our strategy to remain agile " +"with regards to current hardware trends. Each new hardware architecture " +"supported by FreeBSD adds substantially to the cost of code maintenance, " +"toolchain support, and release engineering. It also dramatically increases " +"the cost of effective testing of kernel changes. As such, there is strong " +"motivation to differentiate between classes of support for various " +"architectures while remaining strong in a few key architectures that are " +"seen as the FreeBSD \"target audience\"." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3272 +#, no-wrap +msgid "Statement of General Intent" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3277 +msgid "" +"The FreeBSD Project targets \"production quality commercial off-the-shelf " +"(COTS) workstation, server, and high-end embedded systems\". By retaining a " +"focus on a narrow set of architectures of interest in these environments, " +"the FreeBSD Project is able to maintain high levels of quality, stability, " +"and performance, as well as minimize the load on various support teams on " +"the project, such as the ports team, documentation team, security officer, " +"and release engineering teams. Diversity in hardware support broadens the " +"options for FreeBSD consumers by offering new features and usage " +"opportunities, but these benefits must always be carefully considered in " +"terms of the real-world maintenance cost associated with additional platform " +"support." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3284 +msgid "" +"The FreeBSD Project differentiates platform targets into four tiers. Each " +"tier includes a list of guarantees consumers may rely on as well as " +"obligations by the Project and developers to fulfill those guarantees. " +"These lists define the minimum guarantees for each tier. The Project and " +"developers may provide additional levels of support beyond the minimum " +"guarantees for a given tier, but such additional support is not guaranteed. " +"Each platform target is assigned to a specific tier for each stable branch. " +"As a result, a platform target might be assigned to different tiers on " +"concurrent stable branches." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3285 +#, no-wrap +msgid "Platform Targets" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3292 +msgid "" +"Support for a hardware platform consists of two components: kernel support " +"and userland Application Binary Interfaces (ABIs). Kernel platform support " +"includes things needed to run a FreeBSD kernel on a hardware platform such " +"as machine-dependent virtual memory management and device drivers. A " +"userland ABI specifies an interface for user processes to interact with a " +"FreeBSD kernel and base system libraries. A userland ABI includes system " +"call interfaces, the layout and semantics of public data structures, and the " +"layout and semantics of arguments passed to subroutines. Some components of " +"an ABI may be defined by specifications such as the layout of C++ exception " +"objects or calling conventions for C functions." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3294 +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 " +"data structures and the layout and semantics of arguments to public " +"functions within the kernel itself." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3299 +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 " +"x86_64 and i386 userland ABIs. A FreeBSD kernel should support a \"native\" " +"ABI as the default ABI. The native \"ABI\" generally shares certain " +"properties with the kernel ABI such as the C calling convention, sizes of " +"basic types, etc." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3301 +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:3302 +#, no-wrap +msgid "Tier 1: Fully-Supported Architectures" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3307 +msgid "" +"Tier 1 platforms are the most mature FreeBSD platforms. They are supported " +"by the security officer, release engineering, and Ports Management Team. " +"Tier 1 architectures are expected to be Production Quality with respect to " +"all aspects of the FreeBSD operating system, including installation and " +"development environments." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3309 +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:3311 +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:3312 +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:3313 +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:3314 +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:3315 +msgid "" +"Changes to userland ABIs will generally include compatibility shims to " +"ensure correct operation of binaries compiled against any stable branch " +"where the platform is Tier 1. These shims might not be enabled in the " +"default install. If compatibility shims are not provided for an ABI change, " +"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:3316 +msgid "" +"Changes to certain portions of the kernel ABI will include compatibility " +"shims to ensure correct operation of kernel modules compiled against the " +"oldest supported release on the branch. Note that not all parts of the " +"kernel ABI are protected." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3317 +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:3318 +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:3319 +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:3320 +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:3321 +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:3322 +msgid "Tier 1 platforms will be included in the source tree." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3323 +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:3325 +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:3327 +msgid "" +"Build and test automation support either in the FreeBSD.org cluster or some " +"other location easily available for all developers. Embedded platforms may " +"substitute an emulator available in the FreeBSD.org cluster for actual " +"hardware." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3328 +#: documentation/content/en/articles/committers-guide/_index.adoc:3358 +msgid "Inclusion in the `make universe` and `make tinderbox` targets." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3329 +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:3331 +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:3333 +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:3334 +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:3335 +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 " +"systems are commonly available for the platform in question, or it can mean " +"cross-builds hosted on some other Tier 1 architecture." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3336 +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:3337 +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 " +"modified to preserve functionality of existing kernel modules." +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3338 +#, no-wrap +msgid "Tier 2: Developmental and Niche Architectures" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3342 +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:3346 +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 " +"from Tier 1 status to Tier 2 status as the availability of resources to " +"continue to maintain the system in a Production Quality state diminishes. " +"Well-supported niche architectures may also be Tier 2." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3348 +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:3350 +msgid "" +"The ports infrastructure should include basic support for Tier 2 " +"architectures sufficient to support building ports and packages. This " +"includes support for basic packages such as ports-mgmt/pkg, but there is no " +"guarantee that arbitrary ports will be buildable or functional." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3351 +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:3352 +msgid "Tier 2 platforms will be included in the source tree." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3353 +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:3354 +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:3356 +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:3360 +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:3362 +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:3363 +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:3364 +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:3365 +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:3366 +#, no-wrap +msgid "Tier 3: Experimental Architectures" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3370 +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:3373 +msgid "" +"Tier 3 platforms are architectures in the early stages of development, for " +"non-mainstream hardware platforms, or which are considered legacy systems " +"unlikely to see broad future use. Initial support for Tier 3 platforms may " +"exist in a separate repository rather than the main source repository." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3376 +msgid "" +"The FreeBSD Project provides no guarantees to consumers of Tier 3 platforms " +"and is not committed to maintaining resources to support development. Tier " +"3 platforms may not always be buildable, nor are any kernel or userland ABIs " +"considered stable." +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3377 +#, no-wrap +msgid "Unsupported Architectures" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3381 +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:3384 +msgid "" +"After a platform transitions to unsupported, all support for the platform is " +"removed from the source, ports and documentation trees. Note that ports " +"support should remain as long as the platform is supported in a branch " +"supported by ports." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3385 +#, no-wrap +msgid "Policy on Changing the Tier of an Architecture" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3389 +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 " +"Security Officer, Release Engineering, and ports management teams. For a " +"platform to be promoted to a higher tier, any missing support guarantees " +"must be satisfied before the promotion is completed." +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:3391 +#, no-wrap +msgid "Ports Specific FAQ" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3394 +#, no-wrap +msgid "Adding a New Port" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3397 +#, no-wrap +msgid "How do I add a new port?" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3401 +msgid "" +"Adding a port to the tree is relatively simple. Once the port is ready to be " +"added, as explained later <<ports-qa-add-new-extra,here>>, you need to add " +"the port's directory entry in the category's [.filename]#Makefile#. In this " +"[.filename]#Makefile#, ports are listed in alphabetical order and added to " +"the `SUBDIR` variable, like this:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3405 +#, no-wrap +msgid "\tSUBDIR += newport\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3408 +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:3413 +#, no-wrap +msgid "" +"% git add category/Makefile category/newport\n" +"% git commit\n" +"% git push\n" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3417 +msgid "" +"Don't forget to <<port-commit-message-formats,setup git hooks for the ports " +"tree as explained here>>; a specific hook has been developed to verify the " +"category's [.filename]#Makefile#." +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3420 +#, 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:3423 +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:3426 +msgid "" +"The extref:{porters-handbook}testing[Porters Handbook's Testing Chapter] " +"contains more detailed instructions. See the extref:{porters-handbook}" +"testing[Portclippy / Portfmt, testing-portclippy] and the extref:{porters-" +"handbook}testing[poudriere, testing-poudriere] sections." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3428 +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:3430 +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 " +"Contributors, contrib-additional] section of the FreeBSD Contributors List." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3433 +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:3437 +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 " +"includes this sequence:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3447 +#, no-wrap +msgid "" +"# make install\n" +"# make package\n" +"# make deinstall\n" +"# pkg add package you built above\n" +"# make deinstall\n" +"# make reinstall\n" +"# make package\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3450 +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:3453 +#, no-wrap +msgid "Removing an Existing Port" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3456 +#, no-wrap +msgid "How do I remove an existing port?" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3459 +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:3461 +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:3462 +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:3463 +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:3467 +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:3470 +msgid "Then, remove the port:" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3474 +msgid "Remove the port's files and directory with `git rm`." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3475 +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:3476 +#: documentation/content/en/articles/committers-guide/_index.adoc:3491 +msgid "Add an entry to [.filename]#ports/MOVED#." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3477 +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:3482 +msgid "" +"Alternatively, you can use the rmport script, from [.filename]#ports/Tools/" +"scripts#. This script was written by {vd}. When sending questions about " +"this script to the {freebsd-ports}, please also CC {crees}, the current " +"maintainer." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3484 +#, 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:3489 +msgid "" +"Perform a thorough check of the ports collection for any dependencies on the " +"old port location/name, and update them. Running `grep` on [." +"filename]#INDEX# is not enough because some ports have dependencies enabled " +"by compile-time options. A full man:git-grep[1] of the ports collection is " +"recommended." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3490 +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:3492 +msgid "" +"Search for entries in xml files inside [.filename]#ports/security/vuxml# and " +"adjust them accordingly. In particular, check for previous packages with the " +"new name which version could include the new port." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3493 +msgid "Move the port with `git mv`." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3494 +#: documentation/content/en/articles/committers-guide/_index.adoc:3505 +msgid "Commit the changes." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3497 +#, 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:3502 +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:3503 +msgid "Add the new port to the [.filename]#new-cat/Makefile#." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3504 +msgid "Change stuff in [.filename]#new-cat/new-port#." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3508 +#, no-wrap +msgid "Ports Freeze" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3511 +#, no-wrap +msgid "What is a “ports freeze”?" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3518 +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 " +"with a release. It usually lasted a couple of weeks. During that time, " +"build problems were fixed, and the release packages were built. This " +"practice is no longer used, as the packages for the releases are built from " +"the current stable, quarterly branch." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3520 +msgid "" +"For more information on how to merge commits to the quarterly branch, see " +"<<ports-qa-misc-request-mfh>>." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3522 +#, no-wrap +msgid "Quarterly Branches" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3525 +#, 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:3528 +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:3530 +#, 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:3533 +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 " +"repository, so basically:" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3539 +#, no-wrap +msgid "" +"% git checkout 2021Q2\n" +"% git cherry-pick -x $HASH\n" +"(verify everything is OK, for example by doing a build test)\n" +"% git push\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3543 +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` " +"branch is included in the new commit message of the quarterly branch." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3545 +#, no-wrap +msgid "Creating a New Category" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3548 +#, no-wrap +msgid "What is the procedure for creating a new category?" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3553 +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:" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3557 +msgid "Perform any needed moves. (This only applies to physical categories.)" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3558 +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:3559 +msgid "Assign the PR back to you." +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3562 +#, 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:3567 +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:3569 +msgid "To do this, you will need to:" +msgstr "" + +#. type: delimited block = 6 +#: documentation/content/en/articles/committers-guide/_index.adoc:3573 +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 " +"the PKGORIGIN is correct." +msgstr "" + +#. type: delimited block = 6 +#: documentation/content/en/articles/committers-guide/_index.adoc:3574 +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 " +"ports hierarchy, catching any errors here will save you having to re-run " +"that step later on." +msgstr "" + +#. type: delimited block = 6 +#: documentation/content/en/articles/committers-guide/_index.adoc:3575 +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:3578 +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 " +"installed packages to the port directory they were built from. If this entry " +"is wrong, common port tools like man:pkg-version[8] and man:portupgrade[1] " +"fail." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3580 +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 " +"every port in the ports tree, even those not connected to the build, so you " +"can run it directly after the move operation. Hint: do not forget to look at " +"the ``PKGORIGIN``s of any slave ports of the ports you just moved!" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3581 +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 " +"enable building the new category in [.filename]#ports/Makefile#. Run make " +"checksubdirs in the affected category directories to check the SUBDIR " +"entries. Next, in the [.filename]#ports/# directory, run make index. This " +"can take over 40 minutes on even modern systems; however, it is a necessary " +"step to prevent problems for other people." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3582 +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 [." +"filename]#Makefile# changes for the old category or categories." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3583 +msgid "Add appropriate entries to [.filename]#ports/MOVED#." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3584 +msgid "Update the documentation by modifying:" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3585 +#: documentation/content/en/articles/committers-guide/_index.adoc:3594 +msgid "" +"the extref:{porters-handbook}[list of categories, PORTING-CATEGORIES] in the " +"Porter's Handbook" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3587 +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 " +"previous locations in the repository." +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3589 +#, 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:3592 +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:3596 +#: documentation/content/en/articles/committers-guide/_index.adoc:3690 +#, no-wrap +msgid "Miscellaneous Questions" +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3599 +#, 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:3602 +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:3604 +msgid "" +"Most infrastructure changes to a port (that is, modernizing, but not " +"changing the functionality). For example, the blanket covers converting to " +"new `USES` macros, enabling verbose builds, and switching to new ports " +"system syntaxes." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3605 +msgid "Trivial and _tested_ build and runtime fixes." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3606 +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:3611 +msgid "" +"Exceptions to this are anything maintained by the {portmgr}, or the " +"{security-officer}. No unauthorized commits may ever be made to ports " +"maintained by those groups." +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3614 +#, 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:3618 +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:3620 +msgid "" +"Reports for all the package builds (official, experimental, and non-" +"regression) are aggregated at link:pkg-status.FreeBSD.org[pkg-status.FreeBSD." +"org]." +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3622 +#, 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:3625 +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:3627 +#, 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:3631 +msgid "" +"Any file directly under [.filename]#ports/#, or any file under a " +"subdirectory that starts with an uppercase letter ([.filename]#Mk/#, [." +"filename]#Tools/#, etc.). In particular, the {portmgr} is very protective " +"of [.filename]#ports/Mk/bsd.port*.mk# so do not commit changes to those " +"files unless you want to face their wrath." +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3633 +#, 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:3637 +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 " +"includes a summary of the relevant diffs between the original and new " +"distfile to ensure that the distfile has not been corrupted or maliciously " +"altered. If the current version of the port has been in the ports tree for " +"a while, a copy of the old distfile will usually be available on the ftp " +"servers; otherwise the author or maintainer should be contacted to find out " +"why the distfile has changed." +msgstr "" + +#. type: Title ==== +#: documentation/content/en/articles/committers-guide/_index.adoc:3639 +#, 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:3643 +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:3645 +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 " +"commit." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3649 +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:3650 +msgid "Select the product your patch is about." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3651 +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:3652 +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 " +"says “Hide Advanced Fields”, no need to do anything." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3653 +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:3654 +msgid "Submit. Wait for the build to run." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3655 +msgid "{portmgr} will reply with a possible fallout." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3656 +msgid "Depending on the fallout:" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3657 +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:3658 +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:3659 +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:3662 +#, no-wrap +msgid "Issues Specific to Developers Who Are Not Committers" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3667 +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 " +"(except things specific to commits and the mailing list memberships that go " +"with them). In particular, we recommend that you read:" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3669 +msgid "<<admin>>" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3670 +msgid "<<conventions-everyone>>" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3674 +msgid "" +"Get your mentor to add you to the \"Additional Contributors\" ([." +"filename]#doc/shared/contrib-additional.adoc#), if you are not already " +"listed there." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3676 +msgid "<<developer.relations>>" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3677 +msgid "<<ssh.guide>>" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3678 +msgid "<<rules>>" +msgstr "" + +#. type: Title == +#: documentation/content/en/articles/committers-guide/_index.adoc:3680 +#, no-wrap +msgid "Information About Google Analytics" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3683 +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:3687 +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:3692 +#, 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:3696 +msgid "" +"`people.FreeBSD.org` is the same as `freefall.FreeBSD.org`. Just create a [." +"filename]#public_html# directory. Anything you place in that directory will " +"automatically be visible under https://people.FreeBSD.org/[https://people." +"FreeBSD.org/]." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3697 +#, no-wrap +msgid "Where are the mailing list archives stored?" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3700 +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:3701 +#, 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:3704 +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:3706 +#, no-wrap +msgid "Benefits and Perks for FreeBSD Committers" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3709 +#, no-wrap +msgid "Recognition" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3713 +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 " +"every engineer would dream of meeting is a great perk!" +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3715 +#, no-wrap +msgid "FreeBSD Mall" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3718 +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:3720 +#, no-wrap +msgid "`Gandi.net`" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3723 +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:3727 +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 " +"the billing information and select the currency. Then send an mail to " +"mailto:non-profit@gandi.net[non-profit@gandi.net] using your `@freebsd.org` " +"mail address, and indicate your Gandi handle." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3729 +#, no-wrap +msgid "`rsync.net`" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3732 +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:3734 +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/freebsd." +"html] using your `@freebsd.org` address to receive this free account." +msgstr "" + +#. type: Title === +#: documentation/content/en/articles/committers-guide/_index.adoc:3736 +#, no-wrap +msgid "`JetBrains`" +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3739 +msgid "" +"https://www.jetbrains.com[JetBrains] is a software development company which " +"makes tools for software developers and project managers. The company offers " +"many integrated development environments (IDEs) for different programming " +"languages." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3741 +msgid "" +"JetBrains offers 100 free yearly licenses for all https://www.jetbrains.com/" +"products[JetBrains IDE products]. Simply sign up at https://account." +"jetbrains.com/a/322tl3z7[https://account.jetbrains.com/a/322tl3z7] using " +"your `@freebsd.org` address and the account will have a license attached to " +"it automatically. Once the account is active, use it in any of the products " +"to activate them and you're done." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:3745 +msgid "" +"Please, only use these licences personally and do not share them with anyone " +"outside of the FreeBSD project, as that would be a violation of the terms of " +"the donation." +msgstr "" |