diff options
author | Danilo G. Baio <dbaio@FreeBSD.org> | 2023-05-21 17:51:54 +0000 |
---|---|---|
committer | Danilo G. Baio <dbaio@FreeBSD.org> | 2023-05-21 17:51:54 +0000 |
commit | 226b58b79dbc99f588ae5240aabe06e6ac6a1dea (patch) | |
tree | e8cf7a6cbbfb6abee5ea6c3c2d80b4883a3fb45c /documentation/content/en/articles/committers-guide | |
parent | f7e514ee7f5b6ccaefb3ff14bca73d3ba7d98a33 (diff) |
Diffstat (limited to 'documentation/content/en/articles/committers-guide')
-rw-r--r-- | documentation/content/en/articles/committers-guide/_index.po | 2399 |
1 files changed, 1170 insertions, 1229 deletions
diff --git a/documentation/content/en/articles/committers-guide/_index.po b/documentation/content/en/articles/committers-guide/_index.po index b0c44503ce..e1d331ec20 100644 --- a/documentation/content/en/articles/committers-guide/_index.po +++ b/documentation/content/en/articles/committers-guide/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2023-04-20 20:56-0300\n" +"POT-Creation-Date: 2023-05-21 14:43-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" @@ -987,36 +987,80 @@ msgstr "" #. type: Title ===== #: documentation/content/en/articles/committers-guide/_index.adoc:437 #, no-wrap -msgid "Branch names" +msgid "Branch Names" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:444 +#: documentation/content/en/articles/committers-guide/_index.adoc:439 +msgid "FreeBSD-CURRENT uses the `main` branch." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:441 +msgid "`main` is the default branch." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:443 +msgid "For FreeBSD-STABLE, branch names include `stable/12` and `stable/13`." +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:445 msgid "" -"The branch names in the new Git repository are similar to the old names. " -"For the stable branches, they are stable/X where X is the major release " -"(like 11 or 12). The main branch in the new repository is 'main'. The main " -"branch in the old GitHub mirror was 'master', but is now 'main'. Both " -"reflect the defaults of Git at the time they were created. The 'main' " -"branch is the default branch if you omit the '-b branch' or '--branch " -"branch' options below." +"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:447 +msgid "https://www.freebsd.org/releng/[] shows:" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:449 +msgid "`main` and `stable/⋯` branches open" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:450 +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:452 +msgid "Examples:" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:454 +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:455 +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:445 +#: documentation/content/en/articles/committers-guide/_index.adoc:456 #, no-wrap msgid "Repositories" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:448 +#: documentation/content/en/articles/committers-guide/_index.adoc:459 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:451 +#: documentation/content/en/articles/committers-guide/_index.adoc:462 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 " @@ -1025,13 +1069,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:452 +#: documentation/content/en/articles/committers-guide/_index.adoc:463 #, no-wrap msgid "Deep Clone" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:456 +#: documentation/content/en/articles/committers-guide/_index.adoc:467 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 " @@ -1040,22 +1084,23 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:459 +#: documentation/content/en/articles/committers-guide/_index.adoc:470 #, no-wrap -msgid "% git clone -o freebsd $URL -b branch [dir]\n" +msgid "% git clone -o freebsd $URL -b branch [<directory>]\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:464 +#: documentation/content/en/articles/committers-guide/_index.adoc:475 msgid "" -"is how you make a deep clone. 'branch' should be one of the branches listed " -"in the previous section. It is optional if it is the main branch. 'dir' is " -"an optional directory to place it in (the default will be the name of the " -"repo you are cloning (src, doc, etc))." +"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:469 +#: documentation/content/en/articles/committers-guide/_index.adoc:480 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 " @@ -1067,13 +1112,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:470 +#: documentation/content/en/articles/committers-guide/_index.adoc:481 #, no-wrap msgid "Shallow Clone" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:476 +#: documentation/content/en/articles/committers-guide/_index.adoc:487 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 " @@ -1083,21 +1128,21 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:480 +#: documentation/content/en/articles/committers-guide/_index.adoc:491 #, 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:485 +#: documentation/content/en/articles/committers-guide/_index.adoc:496 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." +"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:490 +#: documentation/content/en/articles/committers-guide/_index.adoc:501 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 " @@ -1105,19 +1150,19 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:492 +#: documentation/content/en/articles/committers-guide/_index.adoc:503 #, no-wrap msgid "Building" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:496 +#: documentation/content/en/articles/committers-guide/_index.adoc:507 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:503 +#: documentation/content/en/articles/committers-guide/_index.adoc:514 #, no-wrap msgid "" "% cd src\n" @@ -1128,12 +1173,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:505 +#: documentation/content/en/articles/committers-guide/_index.adoc:516 msgid "so that won't be covered in depth here." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:508 +#: documentation/content/en/articles/committers-guide/_index.adoc:519 msgid "" "If you want to build a custom kernel, extref:{handbook}[the kernel config " "section, kernelconfig] of the FreeBSD Handbook recommends creating a file " @@ -1142,57 +1187,57 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:509 +#: documentation/content/en/articles/committers-guide/_index.adoc:520 #, no-wrap msgid "Updating" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:513 +#: documentation/content/en/articles/committers-guide/_index.adoc:524 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:516 +#: documentation/content/en/articles/committers-guide/_index.adoc:527 #, no-wrap msgid "% git pull --ff-only\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:521 +#: documentation/content/en/articles/committers-guide/_index.adoc:532 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." +"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:524 +#: documentation/content/en/articles/committers-guide/_index.adoc:535 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 " +"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:525 +#: documentation/content/en/articles/committers-guide/_index.adoc:536 #, no-wrap msgid "Selecting a Specific Version" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:529 +#: documentation/content/en/articles/committers-guide/_index.adoc:540 msgid "" -"In Git, the 'git checkout' checks out both branches and specific versions. " +"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:531 +#: documentation/content/en/articles/committers-guide/_index.adoc:542 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 " @@ -1200,26 +1245,26 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:534 +#: documentation/content/en/articles/committers-guide/_index.adoc:545 #, no-wrap msgid "% git checkout 08b8197a74\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:537 +#: documentation/content/en/articles/committers-guide/_index.adoc:548 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:540 +#: documentation/content/en/articles/committers-guide/_index.adoc:551 #, no-wrap msgid "Note: checking out '08b8197a742a96964d2924391bf9fdfeb788865d'.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:544 +#: documentation/content/en/articles/committers-guide/_index.adoc:555 #, no-wrap msgid "" "You are in a 'detached HEAD' state. You can look around, make experimental\n" @@ -1228,7 +1273,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:547 +#: documentation/content/en/articles/committers-guide/_index.adoc:558 #, no-wrap msgid "" "If you want to create a new branch to retain commits you create, you may\n" @@ -1236,20 +1281,20 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:549 -#: documentation/content/en/articles/committers-guide/_index.adoc:1697 +#: documentation/content/en/articles/committers-guide/_index.adoc:560 +#: documentation/content/en/articles/committers-guide/_index.adoc:1668 #, no-wrap msgid " git checkout -b <new-branch-name>\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:551 +#: documentation/content/en/articles/committers-guide/_index.adoc:562 #, 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:555 +#: documentation/content/en/articles/committers-guide/_index.adoc:566 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 " @@ -1258,13 +1303,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:556 +#: documentation/content/en/articles/committers-guide/_index.adoc:567 #, no-wrap msgid "Bisecting" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:560 +#: documentation/content/en/articles/committers-guide/_index.adoc:571 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 " @@ -1272,9 +1317,9 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:565 +#: documentation/content/en/articles/committers-guide/_index.adoc:576 msgid "" -"Git makes bisecting changes easy with a powerful 'git bisect' command. " +"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 " @@ -1284,11 +1329,11 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:572 +#: documentation/content/en/articles/committers-guide/_index.adoc:583 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 " +"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 " @@ -1297,14 +1342,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:576 +#: documentation/content/en/articles/committers-guide/_index.adoc:587 msgid "" -"If you want to know the last version you checked out, you should use 'git " -"reflog':" +"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:581 +#: documentation/content/en/articles/committers-guide/_index.adoc:592 #, no-wrap msgid "" "5ef0bd68b515 (HEAD -> main, freebsd/main, freebsd/HEAD) HEAD@{0}: pull --ff-only: Fast-forward\n" @@ -1313,9 +1358,9 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:585 +#: documentation/content/en/articles/committers-guide/_index.adoc:596 msgid "" -"shows me moving the working tree to the main branch (a816...) and then " +"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 " "5rf0bd68) and good would be a8163e165. As you can see from the output, " "HEAD@{1} also often works, but isn't foolproof if you have done other things " @@ -1323,7 +1368,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:589 +#: documentation/content/en/articles/committers-guide/_index.adoc:600 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 " @@ -1331,7 +1376,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:596 +#: documentation/content/en/articles/committers-guide/_index.adoc:607 #, no-wrap msgid "" "% git bisect start --first-parent\n" @@ -1342,26 +1387,26 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:605 +#: documentation/content/en/articles/committers-guide/_index.adoc:616 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 " +"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). " +"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:607 +#: documentation/content/en/articles/committers-guide/_index.adoc:618 #, no-wrap msgid "Signing the commits, tags, and pushes, with GnuPG" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:612 +#: documentation/content/en/articles/committers-guide/_index.adoc:623 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 " @@ -1370,7 +1415,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:614 +#: documentation/content/en/articles/committers-guide/_index.adoc:625 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 - " @@ -1378,7 +1423,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:616 +#: documentation/content/en/articles/committers-guide/_index.adoc:627 msgid "" "The rationale behind signing pushes can be found in the https://github.com/" "git/git/commit/a85b377d0419a9dfaca8af2320cc33b051cbed04[commit that " @@ -1386,14 +1431,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:619 +#: documentation/content/en/articles/committers-guide/_index.adoc:630 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:626 +#: documentation/content/en/articles/committers-guide/_index.adoc:637 #, no-wrap msgid "" "% git config --add user.signingKey LONG-KEY-ID\n" @@ -1404,14 +1449,14 @@ msgstr "" #. push.gpgSign should probably be set to `yes` once we enable it, or be set with --global, so that it is enabled for all repositories. #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:634 +#: documentation/content/en/articles/committers-guide/_index.adoc:645 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:640 +#: documentation/content/en/articles/committers-guide/_index.adoc:651 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 " @@ -1419,20 +1464,20 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:642 +#: documentation/content/en/articles/committers-guide/_index.adoc:653 #, no-wrap msgid "Verifying signatures" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:645 +#: documentation/content/en/articles/committers-guide/_index.adoc:656 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:647 +#: documentation/content/en/articles/committers-guide/_index.adoc:658 msgid "" "Tag signatures can be verified with `git verity-tag <tag name>`, or `git tag " "-v <tag name>`." @@ -1444,20 +1489,20 @@ msgstr "" #. Git pushes are a bit different, they live in a special ref in the repository. #. TODO: write how to verify them #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:656 +#: documentation/content/en/articles/committers-guide/_index.adoc:667 #, no-wrap msgid "Ports Considerations" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:659 +#: documentation/content/en/articles/committers-guide/_index.adoc:670 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:662 +#: documentation/content/en/articles/committers-guide/_index.adoc:673 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." @@ -1466,21 +1511,21 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:666 +#: documentation/content/en/articles/committers-guide/_index.adoc:677 msgid "" "There is also a mirror on GitHub, see extref:{handbook}/mirrors[External " -"mirrors, mirrors] for an overview. The 'current' branch is 'main' . The " -"quarterly branches are named 'yyyyQn' for year 'yyyy' and quarter 'n'." +"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:668 +#: documentation/content/en/articles/committers-guide/_index.adoc:679 #, no-wrap msgid "Commit message formats" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:672 +#: documentation/content/en/articles/committers-guide/_index.adoc:683 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[." @@ -1489,32 +1534,32 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:674 +#: documentation/content/en/articles/committers-guide/_index.adoc:685 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:677 +#: documentation/content/en/articles/committers-guide/_index.adoc:688 #, no-wrap msgid "category/port: Summary.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:679 +#: documentation/content/en/articles/committers-guide/_index.adoc:690 #, no-wrap msgid "Description of why the changes where made.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:681 +#: documentation/content/en/articles/committers-guide/_index.adoc:692 #, no-wrap msgid "PR:\t 12345\n" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:687 +#: documentation/content/en/articles/committers-guide/_index.adoc:698 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 " @@ -1522,39 +1567,39 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:689 +#: documentation/content/en/articles/committers-guide/_index.adoc:700 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:691 +#: documentation/content/en/articles/committers-guide/_index.adoc:702 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:693 +#: documentation/content/en/articles/committers-guide/_index.adoc:704 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:695 +#: documentation/content/en/articles/committers-guide/_index.adoc:706 #, no-wrap msgid "Managing Local Changes" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:698 +#: documentation/content/en/articles/committers-guide/_index.adoc:709 msgid "" "This section addresses tracking local changes. If you have no local " "changes, you can stop reading now (it is the last section and OK to skip)." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:704 +#: documentation/content/en/articles/committers-guide/_index.adoc:715 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 " @@ -1565,40 +1610,40 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:705 +#: documentation/content/en/articles/committers-guide/_index.adoc:716 #, no-wrap msgid "Keeping local changes" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:712 +#: documentation/content/en/articles/committers-guide/_index.adoc:723 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 " +"`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 " +"`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:716 +#: documentation/content/en/articles/committers-guide/_index.adoc:727 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." +"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:717 +#: documentation/content/en/articles/committers-guide/_index.adoc:728 #, no-wrap msgid "Keeping a local branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:724 +#: documentation/content/en/articles/committers-guide/_index.adoc:735 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 " @@ -1609,21 +1654,21 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:728 +#: documentation/content/en/articles/committers-guide/_index.adoc:739 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 " +"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:730 +#: documentation/content/en/articles/committers-guide/_index.adoc:741 msgid "====== Create a branch" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:735 +#: documentation/content/en/articles/committers-guide/_index.adoc:746 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 " @@ -1633,7 +1678,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:757 +#: documentation/content/en/articles/committers-guide/_index.adoc:768 #, no-wrap msgid "" "% cd src\n" @@ -1659,24 +1704,24 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:764 +#: documentation/content/en/articles/committers-guide/_index.adoc:775 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 " +"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:766 +#: documentation/content/en/articles/committers-guide/_index.adoc:777 msgid "====== Time to update" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:771 +#: documentation/content/en/articles/committers-guide/_index.adoc:782 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 " @@ -1686,7 +1731,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:777 +#: documentation/content/en/articles/committers-guide/_index.adoc:788 #, no-wrap msgid "" "% git checkout main\n" @@ -1695,7 +1740,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:782 +#: documentation/content/en/articles/committers-guide/_index.adoc:793 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 " @@ -1704,14 +1749,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:784 +#: documentation/content/en/articles/committers-guide/_index.adoc:795 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:791 +#: documentation/content/en/articles/committers-guide/_index.adoc:802 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 " @@ -1720,7 +1765,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:794 +#: documentation/content/en/articles/committers-guide/_index.adoc:805 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 " @@ -1728,7 +1773,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:804 +#: documentation/content/en/articles/committers-guide/_index.adoc:815 #, no-wrap msgid "" "Auto-merging bin/ls/ls.c\n" @@ -1742,7 +1787,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:807 +#: documentation/content/en/articles/committers-guide/_index.adoc:818 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 " @@ -1750,7 +1795,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:816 +#: documentation/content/en/articles/committers-guide/_index.adoc:827 #, no-wrap msgid "" " <<<<<<< HEAD\n" @@ -1764,7 +1809,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:820 +#: documentation/content/en/articles/committers-guide/_index.adoc:831 #, no-wrap msgid "" "The new code is first, and your code is second.\n" @@ -1773,12 +1818,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:824 +#: documentation/content/en/articles/committers-guide/_index.adoc:835 msgid "#undef COLORLS_NEW #ifdef COLORLS_NEW #include <terminfo.h>" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:828 +#: documentation/content/en/articles/committers-guide/_index.adoc:839 #, no-wrap msgid "" "save the file.\n" @@ -1787,12 +1832,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:831 +#: documentation/content/en/articles/committers-guide/_index.adoc:842 msgid "% git add ls.c % git rebase --continue" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:836 +#: documentation/content/en/articles/committers-guide/_index.adoc:847 #, no-wrap msgid "" "which tells Git that ls.c has been fixed and to continue the rebase operation.\n" @@ -1801,17 +1846,17 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:841 +#: documentation/content/en/articles/committers-guide/_index.adoc:852 #, 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" +"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:844 +#: documentation/content/en/articles/committers-guide/_index.adoc:855 #, 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" @@ -1819,36 +1864,36 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:845 +#: documentation/content/en/articles/committers-guide/_index.adoc:856 #, no-wrap msgid "Switching to a Different FreeBSD Branch" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:849 +#: documentation/content/en/articles/committers-guide/_index.adoc:860 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:852 +#: documentation/content/en/articles/committers-guide/_index.adoc:863 msgid "% git checkout main % # build and install here..." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:858 +#: documentation/content/en/articles/committers-guide/_index.adoc:869 #, 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" +"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:862 +#: documentation/content/en/articles/committers-guide/_index.adoc:873 #, no-wrap msgid "" "% git checkout no-color-ls\n" @@ -1857,143 +1902,36 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:869 +#: documentation/content/en/articles/committers-guide/_index.adoc:880 #, 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" +"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: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:870 -#, no-wrap -msgid "Migrating from an existing Git clone" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:872 -msgid "" -"If you have work based on a previous Git conversion or a locally running git-" -"svn conversion, migrating to new repository can encounter problems because " -"Git has no knowledge about the connection between the two." -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:875 -msgid "" -"When you have only a few local changes, the easiest way would be to cherry-" -"pick those changes to the new base: [source,shell]" -msgstr "" - -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:878 -msgid "% git checkout main % git cherry-pick old_branch..your_branch" +"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:881 -#, no-wrap -msgid "" -"Or alternatively, do the same thing with rebase:\n" -"[source,shell]\n" -msgstr "" - -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:883 -msgid "% git rebase --onto main master your_branch" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:887 -#, no-wrap -msgid "" -"If you do have a lot of changes, you would probably want to perform a merge instead.\n" -"The idea is to create a merge point that consolidates the history of the old_branch, and the new FreeBSD repository (main).\n" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:890 -#, no-wrap -msgid "" -"You can find out by looking up the same commit that are found on both parents:\n" -"[source,shell]\n" -msgstr "" - -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:892 -msgid "% git show old_branch" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:895 -#, no-wrap -msgid "" -"You will see a commit message, now search for that in the new branch:\n" -"[source,shell]\n" -msgstr "" - -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:897 -msgid "% git log --grep=\"commit message on old_branch\" freebsd/main" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:900 -#, no-wrap -msgid "" -"You would help locate the commit hash on the new main branch, create a helper branch (in the example we call it 'stage') from that hash:\n" -"[source,shell]\n" -msgstr "" - -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:902 -msgid "% git checkout -b stage _hash_found_from_git_log_" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:905 -#, no-wrap -msgid "" -"Then perform a merge of the old branch:\n" -"[source,shell]\n" -msgstr "" - -#. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:907 -msgid "% git merge -s ours -m \"Mark old branch as merged\" old_branch" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:910 -#, no-wrap -msgid "" -"With that, it's possible to merge your work branch or the main branch in any order without problem.\n" -"Eventually, when you are ready to commit your work back to main, you can perform a rebase to main, or do a squash commit by combining everything into one commit.\n" -msgstr "" - -#. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:912 +#: documentation/content/en/articles/committers-guide/_index.adoc:882 #, no-wrap msgid "[[mfc-with-git]]\n" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:912 +#: documentation/content/en/articles/committers-guide/_index.adoc:882 #, no-wrap msgid "MFC (Merge From Current) Procedures" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:913 +#: documentation/content/en/articles/committers-guide/_index.adoc:883 #, no-wrap msgid "Summary" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:917 +#: documentation/content/en/articles/committers-guide/_index.adoc:887 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 -" @@ -2001,40 +1939,39 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:918 +#: documentation/content/en/articles/committers-guide/_index.adoc:888 #, no-wrap msgid "Single commit MFC" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:921 -#: documentation/content/en/articles/committers-guide/_index.adoc:961 -#: documentation/content/en/articles/committers-guide/_index.adoc:997 -#: documentation/content/en/articles/committers-guide/_index.adoc:1113 -#: documentation/content/en/articles/committers-guide/_index.adoc:1126 -#: documentation/content/en/articles/committers-guide/_index.adoc:1153 -#: documentation/content/en/articles/committers-guide/_index.adoc:1165 -#: documentation/content/en/articles/committers-guide/_index.adoc:1202 -#: documentation/content/en/articles/committers-guide/_index.adoc:1230 -#: documentation/content/en/articles/committers-guide/_index.adoc:1248 -#: documentation/content/en/articles/committers-guide/_index.adoc:1270 -#: documentation/content/en/articles/committers-guide/_index.adoc:1288 -#: documentation/content/en/articles/committers-guide/_index.adoc:1308 -#: documentation/content/en/articles/committers-guide/_index.adoc:1323 -#: documentation/content/en/articles/committers-guide/_index.adoc:1342 -#: documentation/content/en/articles/committers-guide/_index.adoc:1374 -#: documentation/content/en/articles/committers-guide/_index.adoc:1421 -#: documentation/content/en/articles/committers-guide/_index.adoc:1485 +#: documentation/content/en/articles/committers-guide/_index.adoc:891 +#: documentation/content/en/articles/committers-guide/_index.adoc:931 +#: documentation/content/en/articles/committers-guide/_index.adoc:967 +#: documentation/content/en/articles/committers-guide/_index.adoc:1083 +#: documentation/content/en/articles/committers-guide/_index.adoc:1096 +#: documentation/content/en/articles/committers-guide/_index.adoc:1123 +#: documentation/content/en/articles/committers-guide/_index.adoc:1135 +#: documentation/content/en/articles/committers-guide/_index.adoc:1201 +#: documentation/content/en/articles/committers-guide/_index.adoc:1219 +#: documentation/content/en/articles/committers-guide/_index.adoc:1241 +#: documentation/content/en/articles/committers-guide/_index.adoc:1259 +#: documentation/content/en/articles/committers-guide/_index.adoc:1279 +#: documentation/content/en/articles/committers-guide/_index.adoc:1294 +#: documentation/content/en/articles/committers-guide/_index.adoc:1313 +#: documentation/content/en/articles/committers-guide/_index.adoc:1345 +#: documentation/content/en/articles/committers-guide/_index.adoc:1392 +#: documentation/content/en/articles/committers-guide/_index.adoc:1456 msgid "[source,shell]" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:924 +#: documentation/content/en/articles/committers-guide/_index.adoc:894 msgid "% git checkout stable/X % git cherry-pick -x $HASH --edit" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:928 +#: documentation/content/en/articles/committers-guide/_index.adoc:898 #, no-wrap msgid "" "For MFC commits, for example a vendor import, you would need to specify one parent for cherry-pick purposes.\n" @@ -2042,64 +1979,65 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:930 -#: documentation/content/en/articles/committers-guide/_index.adoc:951 -#: documentation/content/en/articles/committers-guide/_index.adoc:974 -#: documentation/content/en/articles/committers-guide/_index.adoc:985 -#: documentation/content/en/articles/committers-guide/_index.adoc:1296 -#: documentation/content/en/articles/committers-guide/_index.adoc:1381 -#: documentation/content/en/articles/committers-guide/_index.adoc:1393 -#: documentation/content/en/articles/committers-guide/_index.adoc:1405 -#: documentation/content/en/articles/committers-guide/_index.adoc:1431 -#: documentation/content/en/articles/committers-guide/_index.adoc:1443 -#: documentation/content/en/articles/committers-guide/_index.adoc:1450 -#: documentation/content/en/articles/committers-guide/_index.adoc:1492 -#: documentation/content/en/articles/committers-guide/_index.adoc:1526 -#: documentation/content/en/articles/committers-guide/_index.adoc:1533 +#: documentation/content/en/articles/committers-guide/_index.adoc:900 +#: documentation/content/en/articles/committers-guide/_index.adoc:921 +#: documentation/content/en/articles/committers-guide/_index.adoc:944 +#: documentation/content/en/articles/committers-guide/_index.adoc:955 +#: documentation/content/en/articles/committers-guide/_index.adoc:1173 +#: documentation/content/en/articles/committers-guide/_index.adoc:1267 +#: documentation/content/en/articles/committers-guide/_index.adoc:1352 +#: documentation/content/en/articles/committers-guide/_index.adoc:1364 +#: documentation/content/en/articles/committers-guide/_index.adoc:1376 +#: documentation/content/en/articles/committers-guide/_index.adoc:1402 +#: documentation/content/en/articles/committers-guide/_index.adoc:1414 +#: documentation/content/en/articles/committers-guide/_index.adoc:1421 +#: documentation/content/en/articles/committers-guide/_index.adoc:1463 +#: documentation/content/en/articles/committers-guide/_index.adoc:1497 +#: documentation/content/en/articles/committers-guide/_index.adoc:1504 +#: documentation/content/en/articles/committers-guide/_index.adoc:1513 #: documentation/content/en/articles/committers-guide/_index.adoc:1542 -#: documentation/content/en/articles/committers-guide/_index.adoc:1571 -#: documentation/content/en/articles/committers-guide/_index.adoc:1587 -#: documentation/content/en/articles/committers-guide/_index.adoc:1620 -#: documentation/content/en/articles/committers-guide/_index.adoc:1641 -#: documentation/content/en/articles/committers-guide/_index.adoc:1672 -#: documentation/content/en/articles/committers-guide/_index.adoc:1684 -#: documentation/content/en/articles/committers-guide/_index.adoc:1715 -#: documentation/content/en/articles/committers-guide/_index.adoc:1724 -#: documentation/content/en/articles/committers-guide/_index.adoc:1734 -#: documentation/content/en/articles/committers-guide/_index.adoc:1750 -#: documentation/content/en/articles/committers-guide/_index.adoc:1766 -#: documentation/content/en/articles/committers-guide/_index.adoc:1777 -#: documentation/content/en/articles/committers-guide/_index.adoc:1784 -#: documentation/content/en/articles/committers-guide/_index.adoc:1797 -#: documentation/content/en/articles/committers-guide/_index.adoc:1817 -#: documentation/content/en/articles/committers-guide/_index.adoc:1831 -#: documentation/content/en/articles/committers-guide/_index.adoc:1847 -#: documentation/content/en/articles/committers-guide/_index.adoc:1859 -#: documentation/content/en/articles/committers-guide/_index.adoc:1878 -#: documentation/content/en/articles/committers-guide/_index.adoc:1889 -#: documentation/content/en/articles/committers-guide/_index.adoc:1899 -#: documentation/content/en/articles/committers-guide/_index.adoc:1937 -#: documentation/content/en/articles/committers-guide/_index.adoc:1945 -#: documentation/content/en/articles/committers-guide/_index.adoc:1956 -#: documentation/content/en/articles/committers-guide/_index.adoc:1977 -#: documentation/content/en/articles/committers-guide/_index.adoc:2037 +#: documentation/content/en/articles/committers-guide/_index.adoc:1558 +#: documentation/content/en/articles/committers-guide/_index.adoc:1591 +#: documentation/content/en/articles/committers-guide/_index.adoc:1612 +#: documentation/content/en/articles/committers-guide/_index.adoc:1643 +#: documentation/content/en/articles/committers-guide/_index.adoc:1655 +#: documentation/content/en/articles/committers-guide/_index.adoc:1686 +#: documentation/content/en/articles/committers-guide/_index.adoc:1695 +#: documentation/content/en/articles/committers-guide/_index.adoc:1705 +#: documentation/content/en/articles/committers-guide/_index.adoc:1721 +#: documentation/content/en/articles/committers-guide/_index.adoc:1737 +#: documentation/content/en/articles/committers-guide/_index.adoc:1748 +#: documentation/content/en/articles/committers-guide/_index.adoc:1755 +#: documentation/content/en/articles/committers-guide/_index.adoc:1768 +#: documentation/content/en/articles/committers-guide/_index.adoc:1788 +#: documentation/content/en/articles/committers-guide/_index.adoc:1802 +#: documentation/content/en/articles/committers-guide/_index.adoc:1818 +#: documentation/content/en/articles/committers-guide/_index.adoc:1830 +#: documentation/content/en/articles/committers-guide/_index.adoc:1849 +#: documentation/content/en/articles/committers-guide/_index.adoc:1860 +#: documentation/content/en/articles/committers-guide/_index.adoc:1870 +#: documentation/content/en/articles/committers-guide/_index.adoc:1908 +#: documentation/content/en/articles/committers-guide/_index.adoc:1916 +#: documentation/content/en/articles/committers-guide/_index.adoc:1927 +#: documentation/content/en/articles/committers-guide/_index.adoc:1948 +#: documentation/content/en/articles/committers-guide/_index.adoc:2008 #, no-wrap msgid "[source,shell]\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:933 +#: documentation/content/en/articles/committers-guide/_index.adoc:903 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:936 +#: documentation/content/en/articles/committers-guide/_index.adoc:906 #, 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:939 +#: documentation/content/en/articles/committers-guide/_index.adoc:909 #, no-wrap msgid "" "Once the cherry-pick is finished, push with `git push`.\n" @@ -2107,20 +2045,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:940 +#: documentation/content/en/articles/committers-guide/_index.adoc:910 #, no-wrap msgid "MFC to RELENG branch" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:944 +#: documentation/content/en/articles/committers-guide/_index.adoc:914 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:949 +#: documentation/content/en/articles/committers-guide/_index.adoc:919 #, no-wrap msgid "" "* Merge or direct commit to the appropriate `stable/X` branch first before merging to the `releng/X.Y` branch.\n" @@ -2130,24 +2068,24 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:954 +#: documentation/content/en/articles/committers-guide/_index.adoc:924 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:957 +#: documentation/content/en/articles/committers-guide/_index.adoc:927 #, 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:958 +#: documentation/content/en/articles/committers-guide/_index.adoc:928 #, no-wrap msgid "Multiple commit MFC" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:969 +#: documentation/content/en/articles/committers-guide/_index.adoc:939 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 " @@ -2157,52 +2095,52 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:972 +#: documentation/content/en/articles/committers-guide/_index.adoc:942 #, 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:980 +#: documentation/content/en/articles/committers-guide/_index.adoc:950 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:983 +#: documentation/content/en/articles/committers-guide/_index.adoc:953 #, 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:988 +#: documentation/content/en/articles/committers-guide/_index.adoc:958 msgid "% git checkout stable/X % git branch -d tmp-branch" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:990 +#: documentation/content/en/articles/committers-guide/_index.adoc:960 #, no-wrap msgid "MFC a vendor import" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:995 +#: documentation/content/en/articles/committers-guide/_index.adoc:965 msgid "" "Vendor imports are the only thing in the tree that creates a merge commit in " -"the main line. Cherry picking merge commits into stable/XX presents an " +"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 " -"mainline (though there may be some exceptions)." +"`main` (though there may be some exceptions)." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:999 +#: documentation/content/en/articles/committers-guide/_index.adoc:969 msgid "% git cherry-pick -x -m 1 $HASH" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1002 +#: documentation/content/en/articles/committers-guide/_index.adoc:972 #, no-wrap msgid "" "is typically what you want.\n" @@ -2210,67 +2148,67 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1007 +#: documentation/content/en/articles/committers-guide/_index.adoc:977 #, no-wrap msgid "" -"There are some, hopefully, rare cases where it's possible that the mainline 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" +"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:1010 +#: documentation/content/en/articles/committers-guide/_index.adoc:980 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:1012 +#: documentation/content/en/articles/committers-guide/_index.adoc:982 #, 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:1013 +#: documentation/content/en/articles/committers-guide/_index.adoc:983 #, no-wrap msgid "Redoing a MFC" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1018 +#: documentation/content/en/articles/committers-guide/_index.adoc:988 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:1020 +#: documentation/content/en/articles/committers-guide/_index.adoc:990 msgid "% git reset --hard freebsd/stable/12" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1023 +#: documentation/content/en/articles/committers-guide/_index.adoc:993 #, 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" +"using `git rebase -i` is better.\n" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1024 +#: documentation/content/en/articles/committers-guide/_index.adoc:994 #, no-wrap msgid "Considerations when MFCing" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1027 +#: documentation/content/en/articles/committers-guide/_index.adoc:997 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:1031 +#: documentation/content/en/articles/committers-guide/_index.adoc:1001 #, no-wrap msgid "" "* Clearly mark direct commits distinct from commits that land a change from another branch.\n" @@ -2279,22 +2217,22 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1033 +#: documentation/content/en/articles/committers-guide/_index.adoc:1003 #, 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:1037 +#: documentation/content/en/articles/committers-guide/_index.adoc:1007 #, no-wrap msgid "" -"* Using 'MFC' and 'MFS' tags to mark commits that merged changes from another branch.\n" +"* 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:1041 +#: documentation/content/en/articles/committers-guide/_index.adoc:1011 #, no-wrap msgid "" "With Git, we will need to use different strategies to achieve the same goals.\n" @@ -2303,7 +2241,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1044 +#: documentation/content/en/articles/committers-guide/_index.adoc:1014 #, 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" @@ -2311,62 +2249,62 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1045 +#: documentation/content/en/articles/committers-guide/_index.adoc:1015 #, no-wrap msgid "Finding Eligible Hashes to MFC" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1051 +#: documentation/content/en/articles/committers-guide/_index.adoc:1021 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 head is landed as a " +"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 " +"`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:1052 +#: documentation/content/en/articles/committers-guide/_index.adoc:1022 #, no-wrap msgid "Commit message standards" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1053 +#: documentation/content/en/articles/committers-guide/_index.adoc:1023 #, no-wrap msgid "Marking MFCs" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1056 +#: documentation/content/en/articles/committers-guide/_index.adoc:1026 msgid "The project has adopted the following practice for marking MFCs:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1058 +#: documentation/content/en/articles/committers-guide/_index.adoc:1028 #, 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:1060 +#: documentation/content/en/articles/committers-guide/_index.adoc:1030 #, 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:1061 +#: documentation/content/en/articles/committers-guide/_index.adoc:1031 #, no-wrap msgid "Trim Metadata?" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1065 +#: documentation/content/en/articles/committers-guide/_index.adoc:1035 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 " @@ -2375,15 +2313,15 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1074 +#: documentation/content/en/articles/committers-guide/_index.adoc:1044 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 " +"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 " @@ -2394,7 +2332,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1078 +#: documentation/content/en/articles/committers-guide/_index.adoc:1048 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 " @@ -2404,14 +2342,14 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1081 +#: documentation/content/en/articles/committers-guide/_index.adoc:1051 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:1084 +#: documentation/content/en/articles/committers-guide/_index.adoc:1054 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 " @@ -2421,43 +2359,43 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1086 +#: documentation/content/en/articles/committers-guide/_index.adoc:1056 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:1088 +#: documentation/content/en/articles/committers-guide/_index.adoc:1058 msgid "[[vendor-import-git]]" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:1088 +#: documentation/content/en/articles/committers-guide/_index.adoc:1058 #, no-wrap msgid "Vendor Imports with Git" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1091 +#: documentation/content/en/articles/committers-guide/_index.adoc:1061 msgid "This section describes the vendor import procedure with Git in detail." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1092 +#: documentation/content/en/articles/committers-guide/_index.adoc:1062 #, no-wrap msgid "Branch naming convention" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1095 +#: documentation/content/en/articles/committers-guide/_index.adoc:1065 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:1101 +#: documentation/content/en/articles/committers-guide/_index.adoc:1071 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 " @@ -2466,20 +2404,20 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1104 +#: documentation/content/en/articles/committers-guide/_index.adoc:1074 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:1105 +#: documentation/content/en/articles/committers-guide/_index.adoc:1075 #, no-wrap msgid "Updating an old vendor import" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1111 +#: documentation/content/en/articles/committers-guide/_index.adoc:1081 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 " @@ -2489,25 +2427,25 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1115 +#: documentation/content/en/articles/committers-guide/_index.adoc:1085 msgid "% git worktree add ../mtree vendor/NetBSD/mtree" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1117 +#: documentation/content/en/articles/committers-guide/_index.adoc:1087 #, no-wrap msgid "Update the Sources in the Vendor Branch" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1120 +#: documentation/content/en/articles/committers-guide/_index.adoc:1090 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:1124 +#: documentation/content/en/articles/committers-guide/_index.adoc:1094 msgid "" "This example assumes the NetBSD source is checked out from their GitHub " "mirror in `~/git/NetBSD`. Note that \"upstream\" might have added or " @@ -2516,7 +2454,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1138 +#: documentation/content/en/articles/committers-guide/_index.adoc:1108 #, no-wrap msgid "" "% cd ../mtree\n" @@ -2533,7 +2471,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1142 +#: documentation/content/en/articles/committers-guide/_index.adoc:1112 #, no-wrap msgid "" "Note: I run the `git diff` and `git status` commands to make sure nothing weird was present.\n" @@ -2541,7 +2479,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1147 +#: documentation/content/en/articles/committers-guide/_index.adoc:1117 #, no-wrap msgid "" "It is also important to create an annotated tag using `git tag -a`, otherwise the push will be rejected.\n" @@ -2551,47 +2489,47 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1148 +#: documentation/content/en/articles/committers-guide/_index.adoc:1118 #, no-wrap msgid "Updating the FreeBSD Copy" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1151 +#: documentation/content/en/articles/committers-guide/_index.adoc:1121 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:1155 +#: documentation/content/en/articles/committers-guide/_index.adoc:1125 msgid "% git push --follow-tags freebsd vendor/NetBSD/mtree" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1158 +#: documentation/content/en/articles/committers-guide/_index.adoc:1128 #, 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:1159 +#: documentation/content/en/articles/committers-guide/_index.adoc:1129 #, no-wrap msgid "Updating the FreeBSD source tree" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1163 +#: documentation/content/en/articles/committers-guide/_index.adoc:1133 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:1168 +#: documentation/content/en/articles/committers-guide/_index.adoc:1138 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:1173 +#: documentation/content/en/articles/committers-guide/_index.adoc:1143 #, no-wrap msgid "" "This would generate a subtree merge commit of `contrib/mtree` against the local `vendor/NetBSD/mtree` branch.\n" @@ -2600,13 +2538,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1174 +#: documentation/content/en/articles/committers-guide/_index.adoc:1144 #, no-wrap msgid "Rebasing your change against latest FreeBSD source tree" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1177 +#: documentation/content/en/articles/committers-guide/_index.adoc:1147 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 " @@ -2614,7 +2552,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1180 +#: documentation/content/en/articles/committers-guide/_index.adoc:1150 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 " @@ -2622,39 +2560,42 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1198 +#: documentation/content/en/articles/committers-guide/_index.adoc:1152 msgid "" "The following steps should be taken to easily recreate the merge commit as " -"if `git rebase --merge-commits` worked properly: * cd to the top of the repo " -"* Create a side branch `XXX` with the **contents** of the merged tree. * " -"Update this side branch `XXX` to be merged and up-to-date with FreeBSD's " -"`main` branch. ** In the worst case scenario, you would still have to " -"resolve merge conflicts, if there was any, but this should be really rare. " -"** Resolve conflicts, and collapse multiple commits down to 1 if need be " -"(without conflicts, there's no collapse needed) * checkout main * create a " -"branch `YYY` (allows for easier unwinding if things go wrong) * Re-do the " -"subtree merge * Instead of resolving any conflicts from the subtree merge, " -"checkout the contents of XXX on top of it. ** The trailing '.' is " -"important, as is being at the top level of the repo. ** Rather than " -"switching branches to XXX, it splats the contents of XXX on top of the repo " -"* Commit the results with the prior commit message (the example assumes " -"there's only one merge on the XXX branch). * Make sure the branches are the " -"same. * Do whatever review you need, including having others check it out " -"if you think that's needed. * Push the commit, if you 'lost the race' " -"again, just redo these steps again (see below for a recipe) * Delete the " -"branches once the commit is upstream. They are throw-a-way." +"if `git rebase --merge-commits` worked properly:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1200 +#: documentation/content/en/articles/committers-guide/_index.adoc:1169 +#, 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):" +"* 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:1171 +#, 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:1213 +#: documentation/content/en/articles/committers-guide/_index.adoc:1184 #, no-wrap msgid "" "% cd ../src\t\t\t# CD to top of tree\n" @@ -2670,7 +2611,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1217 +#: documentation/content/en/articles/committers-guide/_index.adoc:1188 #, 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" @@ -2678,20 +2619,20 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1219 +#: documentation/content/en/articles/committers-guide/_index.adoc:1190 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:1221 +#: documentation/content/en/articles/committers-guide/_index.adoc:1192 #, no-wrap msgid "Pushing the changes" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1226 +#: documentation/content/en/articles/committers-guide/_index.adoc:1197 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 " @@ -2702,22 +2643,22 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1228 +#: documentation/content/en/articles/committers-guide/_index.adoc:1199 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:1234 +#: documentation/content/en/articles/committers-guide/_index.adoc:1205 msgid "" -"% git push freebsd YYY:main\t# put the commit on upstream's main branch % " +"% 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:1241 +#: documentation/content/en/articles/committers-guide/_index.adoc:1212 #, no-wrap msgid "" "Note: I used `XXX` and `YYY` to make it obvious they are terrible names and should not leave your machine.\n" @@ -2728,13 +2669,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1242 +#: documentation/content/en/articles/committers-guide/_index.adoc:1213 #, no-wrap msgid "How to redo things if need be" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1246 +#: documentation/content/en/articles/committers-guide/_index.adoc:1217 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 " @@ -2742,7 +2683,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1255 +#: documentation/content/en/articles/committers-guide/_index.adoc:1226 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 % " @@ -2753,19 +2694,19 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1258 +#: documentation/content/en/articles/committers-guide/_index.adoc:1229 #, 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:1259 +#: documentation/content/en/articles/committers-guide/_index.adoc:1230 #, no-wrap msgid "Creating a new vendor branch" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1266 +#: documentation/content/en/articles/committers-guide/_index.adoc:1237 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 " @@ -2776,38 +2717,38 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1267 +#: documentation/content/en/articles/committers-guide/_index.adoc:1238 #, no-wrap msgid "Create the repo" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1276 +#: documentation/content/en/articles/committers-guide/_index.adoc:1247 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:1279 +#: documentation/content/en/articles/committers-guide/_index.adoc:1250 #, 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:1281 +#: documentation/content/en/articles/committers-guide/_index.adoc:1252 #, 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:1282 +#: documentation/content/en/articles/committers-guide/_index.adoc:1253 #, no-wrap msgid "Copy the sources in" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1286 +#: documentation/content/en/articles/committers-guide/_index.adoc:1257 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 " @@ -2815,23 +2756,23 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1291 +#: documentation/content/en/articles/committers-guide/_index.adoc:1262 msgid "% cp -r ~/glorbnitz/* . % git add *" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1294 +#: documentation/content/en/articles/committers-guide/_index.adoc:1265 #, 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:1298 +#: documentation/content/en/articles/committers-guide/_index.adoc:1269 msgid "% git commit -m \"Import GlorbNitz frobnosticator revision 3.1415\"" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1302 +#: documentation/content/en/articles/committers-guide/_index.adoc:1273 #, 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" @@ -2839,25 +2780,25 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1303 +#: documentation/content/en/articles/committers-guide/_index.adoc:1274 #, no-wrap msgid "Now import it into our repository" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1306 +#: documentation/content/en/articles/committers-guide/_index.adoc:1277 msgid "Now you need to import the branch into our repository." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1312 +#: documentation/content/en/articles/committers-guide/_index.adoc:1283 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:1317 +#: documentation/content/en/articles/committers-guide/_index.adoc:1288 #, 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" @@ -2866,20 +2807,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1318 +#: documentation/content/en/articles/committers-guide/_index.adoc:1289 #, no-wrap msgid "Tag and push" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1321 +#: documentation/content/en/articles/committers-guide/_index.adoc:1292 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:1329 +#: documentation/content/en/articles/committers-guide/_index.adoc:1300 msgid "" "% git worktree add ../glorbnitz vendor/glorbnitz % cd ../glorbnitz % git tag " "--annotate vendor/glorbnitz/3.1415 # Make sure the commit is good with \"git " @@ -2887,13 +2828,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1332 +#: documentation/content/en/articles/committers-guide/_index.adoc:1303 #, no-wrap msgid "By 'good' we mean:\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1338 +#: documentation/content/en/articles/committers-guide/_index.adoc:1309 #, no-wrap msgid "" ". All the right files are present\n" @@ -2904,13 +2845,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1339 +#: documentation/content/en/articles/committers-guide/_index.adoc:1310 #, no-wrap msgid "Time to finally merge it into the base tree" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1348 +#: documentation/content/en/articles/committers-guide/_index.adoc:1319 #, no-wrap msgid "" "% cd ../src\n" @@ -2921,23 +2862,23 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1351 +#: documentation/content/en/articles/committers-guide/_index.adoc:1322 #, no-wrap msgid "Here 'good' means:\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1356 +#: documentation/content/en/articles/committers-guide/_index.adoc:1327 #, 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 line and any caveats.\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:1362 +#: documentation/content/en/articles/committers-guide/_index.adoc:1333 #, no-wrap msgid "" "[NOTE]\n" @@ -2948,13 +2889,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1363 +#: documentation/content/en/articles/committers-guide/_index.adoc:1334 #, no-wrap msgid "Keeping current" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1369 +#: documentation/content/en/articles/committers-guide/_index.adoc:1340 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 " @@ -2963,31 +2904,31 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1372 +#: documentation/content/en/articles/committers-guide/_index.adoc:1343 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." +"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:1376 +#: documentation/content/en/articles/committers-guide/_index.adoc:1347 msgid "% git config --global pull.ff only" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1379 +#: documentation/content/en/articles/committers-guide/_index.adoc:1350 #, 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:1385 +#: documentation/content/en/articles/committers-guide/_index.adoc:1356 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:1389 +#: documentation/content/en/articles/committers-guide/_index.adoc:1360 #, 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" @@ -2995,34 +2936,34 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1391 +#: documentation/content/en/articles/committers-guide/_index.adoc:1362 #, no-wrap msgid "The longer form is also recommended.\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1398 +#: documentation/content/en/articles/committers-guide/_index.adoc:1369 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:1403 +#: documentation/content/en/articles/committers-guide/_index.adoc:1374 #, 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" +"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:1407 +#: documentation/content/en/articles/committers-guide/_index.adoc:1378 msgid "% git rebase -i main working" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1414 +#: documentation/content/en/articles/committers-guide/_index.adoc:1385 #, no-wrap msgid "" "This will bring up an interactive screen to change the defaults.\n" @@ -3033,32 +2974,32 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1416 +#: documentation/content/en/articles/committers-guide/_index.adoc:1387 #, no-wrap msgid "[[git-push-upstream]]\n" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1416 +#: documentation/content/en/articles/committers-guide/_index.adoc:1387 #, no-wrap msgid "Time to push changes upstream" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1419 +#: documentation/content/en/articles/committers-guide/_index.adoc:1390 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:1423 +#: documentation/content/en/articles/committers-guide/_index.adoc:1394 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:1427 +#: documentation/content/en/articles/committers-guide/_index.adoc:1398 #, no-wrap msgid "" "Then, verify that user name and email are configured right.\n" @@ -3066,64 +3007,64 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1429 +#: documentation/content/en/articles/committers-guide/_index.adoc:1400 #, no-wrap msgid "Use\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1433 +#: documentation/content/en/articles/committers-guide/_index.adoc:1404 msgid "freefall% gen-gitconfig.sh" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1436 +#: documentation/content/en/articles/committers-guide/_index.adoc:1407 #, 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:1441 +#: documentation/content/en/articles/committers-guide/_index.adoc:1412 #, no-wrap msgid "" -"The below command merges the `working` branch into the upstream main line.\n" +"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" +"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:1445 +#: documentation/content/en/articles/committers-guide/_index.adoc:1416 msgid "% git push freebsd working:main" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1448 +#: documentation/content/en/articles/committers-guide/_index.adoc:1419 #, 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:1455 +#: documentation/content/en/articles/committers-guide/_index.adoc:1426 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:1458 +#: documentation/content/en/articles/committers-guide/_index.adoc:1429 #, no-wrap msgid "[[git-push-upstream-alt]]\n" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1458 +#: documentation/content/en/articles/committers-guide/_index.adoc:1429 #, no-wrap msgid "Time to push changes upstream (alternative)" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1464 +#: documentation/content/en/articles/committers-guide/_index.adoc:1435 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 " @@ -3132,12 +3073,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1468 +#: documentation/content/en/articles/committers-guide/_index.adoc:1439 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:1472 +#: documentation/content/en/articles/committers-guide/_index.adoc:1443 #, no-wrap msgid "" "If you lose the race, then try again with\n" @@ -3145,12 +3086,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1475 +#: documentation/content/en/articles/committers-guide/_index.adoc:1446 msgid "% git pull --rebase % git push freebsd" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1478 +#: documentation/content/en/articles/committers-guide/_index.adoc:1449 #, 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" @@ -3158,13 +3099,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1479 +#: documentation/content/en/articles/committers-guide/_index.adoc:1450 #, no-wrap msgid "Finding the Subversion Revision" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1483 +#: documentation/content/en/articles/committers-guide/_index.adoc:1454 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 " @@ -3172,23 +3113,23 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1487 +#: documentation/content/en/articles/committers-guide/_index.adoc:1458 msgid "% git log" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1490 +#: documentation/content/en/articles/committers-guide/_index.adoc:1461 #, 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:1494 +#: documentation/content/en/articles/committers-guide/_index.adoc:1465 msgid "% git log --grep revision=XXXX" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1498 +#: documentation/content/en/articles/committers-guide/_index.adoc:1469 #, no-wrap msgid "" "to find the specific revision.\n" @@ -3196,26 +3137,26 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1500 +#: documentation/content/en/articles/committers-guide/_index.adoc:1471 #, no-wrap msgid "[[git-faq]]\n" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:1500 +#: documentation/content/en/articles/committers-guide/_index.adoc:1471 #, no-wrap msgid "Git FAQ" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1503 +#: documentation/content/en/articles/committers-guide/_index.adoc:1474 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:1509 +#: documentation/content/en/articles/committers-guide/_index.adoc:1480 msgid "" "[NOTE] ==== We use the common convention of having the origin for the " "FreeBSD repository being 'freebsd' rather than the default 'origin' to allow " @@ -3224,19 +3165,19 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1510 +#: documentation/content/en/articles/committers-guide/_index.adoc:1481 #, no-wrap msgid "Users" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1512 +#: documentation/content/en/articles/committers-guide/_index.adoc:1483 #, 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:1517 +#: documentation/content/en/articles/committers-guide/_index.adoc:1488 #, 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" @@ -3245,7 +3186,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1521 +#: documentation/content/en/articles/committers-guide/_index.adoc:1492 #, no-wrap msgid "" "**A:** You can use Git worktrees.\n" @@ -3254,7 +3195,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1524 +#: documentation/content/en/articles/committers-guide/_index.adoc:1495 #, no-wrap msgid "" "First, you need to clone the FreeBSD repository, shown here cloning into `freebsd-current` to reduce confusion.\n" @@ -3262,25 +3203,25 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1528 +#: documentation/content/en/articles/committers-guide/_index.adoc:1499 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:1531 +#: documentation/content/en/articles/committers-guide/_index.adoc:1502 #, 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:1536 +#: documentation/content/en/articles/committers-guide/_index.adoc:1507 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:1540 +#: documentation/content/en/articles/committers-guide/_index.adoc:1511 #, 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" @@ -3288,7 +3229,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1550 +#: documentation/content/en/articles/committers-guide/_index.adoc:1521 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 " @@ -3296,43 +3237,43 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1553 +#: documentation/content/en/articles/committers-guide/_index.adoc:1524 #, 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:1555 +#: documentation/content/en/articles/committers-guide/_index.adoc:1526 #, 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:1556 +#: documentation/content/en/articles/committers-guide/_index.adoc:1527 #, no-wrap msgid "Developers" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1558 +#: documentation/content/en/articles/committers-guide/_index.adoc:1529 #, no-wrap -msgid "Ooops! I committed to `main` instead of a branch." +msgid "Ooops! I committed to `main`, instead of another branch." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1561 +#: documentation/content/en/articles/committers-guide/_index.adoc:1532 #, no-wrap -msgid "**Q:** From time to time, I goof up and commit to main instead of to a branch. What do I do?\n" +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:1563 +#: documentation/content/en/articles/committers-guide/_index.adoc:1534 #, no-wrap msgid "**A:** First, don't panic.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1567 +#: documentation/content/en/articles/committers-guide/_index.adoc:1538 #, no-wrap msgid "" "Second, don't push.\n" @@ -3341,13 +3282,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1569 +#: documentation/content/en/articles/committers-guide/_index.adoc:1540 #, 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:1575 +#: documentation/content/en/articles/committers-guide/_index.adoc:1546 #, no-wrap msgid "" "% git branch issue # Create the 'issue' branch\n" @@ -3356,13 +3297,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1577 +#: documentation/content/en/articles/committers-guide/_index.adoc:1548 #, no-wrap msgid "Ooops! I committed something to the wrong branch!" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1581 +#: documentation/content/en/articles/committers-guide/_index.adoc:1552 #, 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" @@ -3370,7 +3311,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1585 +#: documentation/content/en/articles/committers-guide/_index.adoc:1556 #, no-wrap msgid "" "**A:** The answer is similar to the previous one, but with cherry picking.\n" @@ -3379,7 +3320,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1593 +#: documentation/content/en/articles/committers-guide/_index.adoc:1564 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# " @@ -3388,7 +3329,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1597 +#: documentation/content/en/articles/committers-guide/_index.adoc:1568 #, 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" @@ -3396,30 +3337,30 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1599 +#: documentation/content/en/articles/committers-guide/_index.adoc:1570 #, 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:1605 +#: documentation/content/en/articles/committers-guide/_index.adoc:1576 #, 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" +"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:1607 +#: documentation/content/en/articles/committers-guide/_index.adoc:1578 #, 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:1613 +#: documentation/content/en/articles/committers-guide/_index.adoc:1584 #, no-wrap msgid "" "**A:** The more general answer would be the same as the previous.\n" @@ -3430,7 +3371,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1618 +#: documentation/content/en/articles/committers-guide/_index.adoc:1589 #, 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" @@ -3440,7 +3381,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1625 +#: documentation/content/en/articles/committers-guide/_index.adoc:1596 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 " @@ -3448,7 +3389,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1629 +#: documentation/content/en/articles/committers-guide/_index.adoc:1600 #, no-wrap msgid "" "The last step is optional.\n" @@ -3456,7 +3397,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1633 +#: documentation/content/en/articles/committers-guide/_index.adoc:1604 #, 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" @@ -3465,13 +3406,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1635 +#: documentation/content/en/articles/committers-guide/_index.adoc:1606 #, 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:1639 +#: documentation/content/en/articles/committers-guide/_index.adoc:1610 #, 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" @@ -3480,7 +3421,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1654 +#: documentation/content/en/articles/committers-guide/_index.adoc:1625 msgid "" "% git reflog 6ff9c25 (HEAD -> wilma) HEAD@{0}: rebase -i (finish): returning " "to refs/heads/wilma 6ff9c25 (HEAD -> wilma) HEAD@{1}: rebase -i (start): " @@ -3493,7 +3434,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1662 +#: documentation/content/en/articles/committers-guide/_index.adoc:1633 #, no-wrap msgid "" "Here we see the changes I've made.\n" @@ -3505,7 +3446,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1670 +#: documentation/content/en/articles/committers-guide/_index.adoc:1641 #, no-wrap msgid "" "Next, 'Encourage contributions' was the last commit I made to `wilma` before I decided to split things up.\n" @@ -3518,28 +3459,28 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1675 +#: documentation/content/en/articles/committers-guide/_index.adoc:1646 msgid "% git checkout -B wilma 869cbd3 % git branch -D fred" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1682 +#: documentation/content/en/articles/committers-guide/_index.adoc:1653 #, 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" +"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:1688 +#: documentation/content/en/articles/committers-guide/_index.adoc:1659 msgid "% git checkout 869cbd3 M\tfaq.md Note: checking out '869cbd3'." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1692 +#: documentation/content/en/articles/committers-guide/_index.adoc:1663 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 " @@ -3547,45 +3488,45 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1695 +#: documentation/content/en/articles/committers-guide/_index.adoc:1666 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:1700 +#: documentation/content/en/articles/committers-guide/_index.adoc:1671 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:1703 +#: documentation/content/en/articles/committers-guide/_index.adoc:1674 #, 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:1704 +#: documentation/content/en/articles/committers-guide/_index.adoc:1675 #, 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:1708 +#: documentation/content/en/articles/committers-guide/_index.adoc:1679 #, no-wrap msgid "" -"**Q:** I was on autopilot and did a `git pull` for my development tree and that created a merge commit on the mainline.\n" +"**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:1710 +#: documentation/content/en/articles/committers-guide/_index.adoc:1681 #, 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:1713 +#: documentation/content/en/articles/committers-guide/_index.adoc:1684 #, no-wrap msgid "" "Right after the pull, you will have the new merge commit checked out.\n" @@ -3593,7 +3534,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1718 +#: documentation/content/en/articles/committers-guide/_index.adoc:1689 #, no-wrap msgid "" "git log --oneline HEAD^1 # Look at the first parent's commits\n" @@ -3601,7 +3542,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1722 +#: documentation/content/en/articles/committers-guide/_index.adoc:1693 #, no-wrap msgid "" "From those logs, you can easily identify which commit is your development work.\n" @@ -3609,18 +3550,18 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1726 +#: documentation/content/en/articles/committers-guide/_index.adoc:1697 msgid "git reset --hard HEAD^2" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1729 +#: documentation/content/en/articles/committers-guide/_index.adoc:1700 #, 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:1732 +#: documentation/content/en/articles/committers-guide/_index.adoc:1703 #, no-wrap msgid "" "**A:** Git keeps track of the remote repository branches in a `freebsd/` namespace.\n" @@ -3628,12 +3569,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1736 +#: documentation/content/en/articles/committers-guide/_index.adoc:1707 msgid "git branch -f main freebsd/main" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1741 +#: documentation/content/en/articles/committers-guide/_index.adoc:1712 #, 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" @@ -3642,13 +3583,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1742 +#: documentation/content/en/articles/committers-guide/_index.adoc:1713 #, no-wrap msgid "Mixing and matching branches" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1746 +#: documentation/content/en/articles/committers-guide/_index.adoc:1717 #, no-wrap msgid "" "**Q:** So I have two branches `worker` and `async` that I'd like to combine into one branch called `feature`\n" @@ -3656,20 +3597,20 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1748 +#: documentation/content/en/articles/committers-guide/_index.adoc:1719 #, no-wrap msgid "**A:** This is a job for cherry pick.\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1754 +#: documentation/content/en/articles/committers-guide/_index.adoc:1725 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:1759 +#: documentation/content/en/articles/committers-guide/_index.adoc:1730 #, no-wrap msgid "" "You now have a new branch called `feature`.\n" @@ -3678,13 +3619,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1761 +#: documentation/content/en/articles/committers-guide/_index.adoc:1732 #, 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:1764 +#: documentation/content/en/articles/committers-guide/_index.adoc:1735 #, no-wrap msgid "" "**A:** This takes a little bit of prep work, but `git rebase` will do the heavy\n" @@ -3692,14 +3633,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1770 +#: documentation/content/en/articles/committers-guide/_index.adoc:1741 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:1775 +#: documentation/content/en/articles/committers-guide/_index.adoc:1746 #, no-wrap msgid "" "Now you have two identical branches.\n" @@ -3708,29 +3649,29 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1779 +#: documentation/content/en/articles/committers-guide/_index.adoc:1750 msgid "% git rebase -i main kernel" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1782 +#: documentation/content/en/articles/committers-guide/_index.adoc:1753 #, 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:1786 +#: documentation/content/en/articles/committers-guide/_index.adoc:1757 msgid "% git rebase -i main userland" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1789 +#: documentation/content/en/articles/committers-guide/_index.adoc:1760 #, 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:1792 +#: documentation/content/en/articles/committers-guide/_index.adoc:1763 #, no-wrap msgid "" "**Q:** Oh great! I followed the above and forgot a commit in the `kernel` branch.\n" @@ -3738,7 +3679,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1795 +#: documentation/content/en/articles/committers-guide/_index.adoc:1766 #, no-wrap msgid "" "**A:** You can use the `driver` branch to find the hash of the commit is missing and\n" @@ -3746,12 +3687,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1801 +#: documentation/content/en/articles/committers-guide/_index.adoc:1772 msgid "% git checkout kernel % git log driver % git cherry-pick $HASH" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1807 +#: documentation/content/en/articles/committers-guide/_index.adoc:1778 #, no-wrap msgid "" "**Q:** OK. I have the same situation as the above, but my commits are all mixed up.\n" @@ -3761,7 +3702,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1810 +#: documentation/content/en/articles/committers-guide/_index.adoc:1781 #, no-wrap msgid "" "**A:** In this situation, you'd be better off to curate the original branch to separate\n" @@ -3769,7 +3710,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1815 +#: documentation/content/en/articles/committers-guide/_index.adoc:1786 #, no-wrap msgid "" "So let's assume that there's just one commit with a clean tree.\n" @@ -3779,18 +3720,18 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1819 +#: documentation/content/en/articles/committers-guide/_index.adoc:1790 msgid "% git reset HEAD^" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1822 +#: documentation/content/en/articles/committers-guide/_index.adoc:1793 #, 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:1826 +#: documentation/content/en/articles/committers-guide/_index.adoc:1797 #, no-wrap msgid "" "Now, if you are lucky, the change needing to be split up falls entirely along file lines.\n" @@ -3799,7 +3740,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1829 +#: documentation/content/en/articles/committers-guide/_index.adoc:1800 #, no-wrap msgid "" "If you are not lucky, you'll need to split apart files.\n" @@ -3807,12 +3748,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1833 +#: documentation/content/en/articles/committers-guide/_index.adoc:1804 msgid "git add -i foo/bar.c" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1839 +#: documentation/content/en/articles/committers-guide/_index.adoc:1810 #, no-wrap msgid "" "will step through the diffs, prompting you, one at time, whether to include or exclude the hunk.\n" @@ -3822,30 +3763,30 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1840 +#: documentation/content/en/articles/committers-guide/_index.adoc:1811 #, no-wrap msgid "Cloning and Mirroring" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1843 +#: documentation/content/en/articles/committers-guide/_index.adoc:1814 #, 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:1845 +#: documentation/content/en/articles/committers-guide/_index.adoc:1816 #, 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:1849 +#: documentation/content/en/articles/committers-guide/_index.adoc:1820 msgid "% git clone --mirror $URL" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1853 +#: documentation/content/en/articles/committers-guide/_index.adoc:1824 #, no-wrap msgid "" "will do the trick.\n" @@ -3853,16 +3794,16 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1857 +#: documentation/content/en/articles/committers-guide/_index.adoc:1828 #, 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" +"There's a number of ways around this with `git worktree`:\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1865 +#: documentation/content/en/articles/committers-guide/_index.adoc:1836 msgid "" "% git clone --mirror https://git.freebsd.org/ports.git ports.git % cd ports." "git % git worktree add ../ports main % git worktree add ../quarterly " @@ -3870,13 +3811,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1868 +#: documentation/content/en/articles/committers-guide/_index.adoc:1839 #, 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:1871 +#: documentation/content/en/articles/committers-guide/_index.adoc:1842 #, 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" @@ -3884,13 +3825,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1873 +#: documentation/content/en/articles/committers-guide/_index.adoc:1844 #, no-wrap msgid "**Q:** So what can I do instead?\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1876 +#: documentation/content/en/articles/committers-guide/_index.adoc:1847 #, no-wrap msgid "" "**A:** Well, you can stuff all of the upstream repository's refs into a private namespace in your local repository.\n" @@ -3898,19 +3839,19 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1880 +#: documentation/content/en/articles/committers-guide/_index.adoc:1851 #, no-wrap msgid " fetch = +refs/heads/*:refs/remotes/freebsd/*\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1883 +#: documentation/content/en/articles/committers-guide/_index.adoc:1854 #, no-wrap msgid "which says just fetch the branch refs.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1887 +#: documentation/content/en/articles/committers-guide/_index.adoc:1858 #, no-wrap msgid "" "However, the FreeBSD repository has a number of other things in it.\n" @@ -3919,76 +3860,76 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1891 +#: documentation/content/en/articles/committers-guide/_index.adoc:1862 msgid "git config --add remote.freebsd.fetch '+refs/*:refs/freebsd/*'" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1895 +#: documentation/content/en/articles/committers-guide/_index.adoc:1866 #, no-wrap msgid "" -"which will put everything in the upstream repository into your local repository's 'refs/freebsd/' namespace.\n" +"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:1897 +#: documentation/content/en/articles/committers-guide/_index.adoc:1868 #, 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:1901 +#: documentation/content/en/articles/committers-guide/_index.adoc:1872 msgid "git log refs/freebsd/vendor/zlib/1.2.10" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1904 +#: documentation/content/en/articles/committers-guide/_index.adoc:1875 #, 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:1905 +#: documentation/content/en/articles/committers-guide/_index.adoc:1876 #, no-wrap msgid "Collaborating with others" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1909 +#: documentation/content/en/articles/committers-guide/_index.adoc:1880 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, in order to share changes in a user-" -"generated branch." +"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:1911 +#: documentation/content/en/articles/committers-guide/_index.adoc:1882 msgid "" "The following instructions show how to set up a user-generated branch, based " -"on the FreeBSD main branch, and push it to GitHub." +"on the FreeBSD `main` branch, and push it to GitHub." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1913 +#: documentation/content/en/articles/committers-guide/_index.adoc:1884 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:1920 +#: documentation/content/en/articles/committers-guide/_index.adoc:1891 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:1923 +#: documentation/content/en/articles/committers-guide/_index.adoc:1894 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/" @@ -3997,14 +3938,14 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1926 +#: documentation/content/en/articles/committers-guide/_index.adoc:1897 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:1933 +#: documentation/content/en/articles/committers-guide/_index.adoc:1904 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:" @@ -4013,18 +3954,18 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1935 +#: documentation/content/en/articles/committers-guide/_index.adoc:1906 #, 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:1939 +#: documentation/content/en/articles/committers-guide/_index.adoc:1910 msgid "% git checkout -b gnn-pr2001-fix" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1943 +#: documentation/content/en/articles/committers-guide/_index.adoc:1914 #, 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" @@ -4032,26 +3973,26 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1949 +#: documentation/content/en/articles/committers-guide/_index.adoc:1920 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:1951 +#: documentation/content/en/articles/committers-guide/_index.adoc:1922 #, 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:1954 +#: documentation/content/en/articles/committers-guide/_index.adoc:1925 #, 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:1970 +#: documentation/content/en/articles/committers-guide/_index.adoc:1941 #, no-wrap msgid "" "% git push --set-upstream github gnn-feature\n" @@ -4070,7 +4011,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1972 +#: documentation/content/en/articles/committers-guide/_index.adoc:1943 #, no-wrap msgid "" "[new branch] gnn-feature -> gnn-feature\n" @@ -4078,13 +4019,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1975 +#: documentation/content/en/articles/committers-guide/_index.adoc:1946 #, 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:1988 +#: documentation/content/en/articles/committers-guide/_index.adoc:1959 #, no-wrap msgid "" "% git push\n" @@ -4100,7 +4041,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1992 +#: documentation/content/en/articles/committers-guide/_index.adoc:1963 #, no-wrap msgid "" "At this point your work is now in your branch on +GitHub+ and you can\n" @@ -4108,19 +4049,19 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1994 +#: documentation/content/en/articles/committers-guide/_index.adoc:1965 #, no-wrap msgid "[[github-pull-land]]\n" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:1994 +#: documentation/content/en/articles/committers-guide/_index.adoc:1965 #, no-wrap msgid "Landing a github pull request" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1999 +#: documentation/content/en/articles/committers-guide/_index.adoc:1970 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 " @@ -4133,7 +4074,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2003 +#: documentation/content/en/articles/committers-guide/_index.adoc:1974 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, " @@ -4141,7 +4082,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2009 +#: documentation/content/en/articles/committers-guide/_index.adoc:1980 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/" @@ -4150,7 +4091,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2029 +#: documentation/content/en/articles/committers-guide/_index.adoc:2000 #, no-wrap msgid "" "Often pull requests are simple: requests that contain only a single commit.\n" @@ -4175,13 +4116,13 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2031 +#: documentation/content/en/articles/committers-guide/_index.adoc:2002 #, 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:2035 +#: documentation/content/en/articles/committers-guide/_index.adoc:2006 #, no-wrap msgid "" "A polite request to the author for a better name and/or email should be made.\n" @@ -4190,7 +4131,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2047 +#: documentation/content/en/articles/committers-guide/_index.adoc:2018 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 " @@ -4200,7 +4141,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2052 +#: documentation/content/en/articles/committers-guide/_index.adoc:2023 #, no-wrap msgid "" "[.procedure]\n" @@ -4209,7 +4150,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2060 +#: documentation/content/en/articles/committers-guide/_index.adoc:2031 #, no-wrap msgid "" ". checkout the pull request `git checkout github/pull/XXX`\n" @@ -4222,7 +4163,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2065 +#: documentation/content/en/articles/committers-guide/_index.adoc:2036 #, no-wrap msgid "" "This will also work when bringing branches developed elsewhere into the local tree for committing.\n" @@ -4232,24 +4173,24 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2067 +#: documentation/content/en/articles/committers-guide/_index.adoc:2038 #, no-wrap msgid "[[vcs-history]]\n" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2067 +#: documentation/content/en/articles/committers-guide/_index.adoc:2038 #, no-wrap msgid "Version Control History" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2070 +#: documentation/content/en/articles/committers-guide/_index.adoc:2041 msgid "The project has moved to <<git-primer,git>>." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2076 +#: documentation/content/en/articles/committers-guide/_index.adoc:2047 msgid "" "The FreeBSD source repository switched from CVS to Subversion on May 31st, " "2008. The first real SVN commit is __r179447__. The source repository " @@ -4259,7 +4200,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2082 +#: documentation/content/en/articles/committers-guide/_index.adoc:2053 msgid "" "The FreeBSD `doc/www` repository switched from CVS to Subversion on May " "19th, 2012. The first real SVN commit is __r38821__. The documentation " @@ -4269,7 +4210,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2088 +#: documentation/content/en/articles/committers-guide/_index.adoc:2059 msgid "" "The FreeBSD `ports` repository switched from CVS to Subversion on July 14th, " "2012. The first real SVN commit is __r300894__. The ports repository " @@ -4279,18 +4220,18 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2090 +#: documentation/content/en/articles/committers-guide/_index.adoc:2061 msgid "[[conventions]]" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2090 +#: documentation/content/en/articles/committers-guide/_index.adoc:2061 #, no-wrap msgid "Setup, Conventions, and Traditions" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2095 +#: documentation/content/en/articles/committers-guide/_index.adoc:2066 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 " @@ -4298,25 +4239,25 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2097 +#: documentation/content/en/articles/committers-guide/_index.adoc:2068 msgid "[[conventions-committers]]" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2097 +#: documentation/content/en/articles/committers-guide/_index.adoc:2068 #, no-wrap msgid "For New Committers" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2100 +#: documentation/content/en/articles/committers-guide/_index.adoc:2071 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:2103 +#: documentation/content/en/articles/committers-guide/_index.adoc:2074 #, no-wrap msgid "" "* Get mentor approval before committing each of these changes!\n" @@ -4324,7 +4265,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2108 +#: documentation/content/en/articles/committers-guide/_index.adoc:2079 #, no-wrap msgid "" "[[commit-steps]]\n" @@ -4334,7 +4275,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2155 +#: documentation/content/en/articles/committers-guide/_index.adoc:2126 #, no-wrap msgid "" ". Add an Author Entity\n" @@ -4386,19 +4327,19 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2157 +#: documentation/content/en/articles/committers-guide/_index.adoc:2128 #, no-wrap msgid "[[conventions-everyone]]\n" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2157 +#: documentation/content/en/articles/committers-guide/_index.adoc:2128 #, no-wrap msgid "For Everyone" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2177 +#: documentation/content/en/articles/committers-guide/_index.adoc:2148 msgid "" "[[conventions-everyone-steps]] [.procedure] ==== . Introduce yourself to the " "other developers, otherwise no one will have any idea who you are or what " @@ -4427,25 +4368,25 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2179 +#: documentation/content/en/articles/committers-guide/_index.adoc:2150 msgid "[[smtp-setup]]" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:2179 +#: documentation/content/en/articles/committers-guide/_index.adoc:2150 #, no-wrap msgid "SMTP Access Setup" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2182 +#: documentation/content/en/articles/committers-guide/_index.adoc:2153 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:2203 +#: documentation/content/en/articles/committers-guide/_index.adoc:2174 msgid "" "[.procedure] ==== . Point your mail client at `smtp.FreeBSD.org:587`. . " "Enable STARTTLS. . Ensure your `From:` address is set to " @@ -4462,30 +4403,30 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2205 +#: documentation/content/en/articles/committers-guide/_index.adoc:2176 msgid "[[smtp-setup-local-mta]]" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:2205 +#: documentation/content/en/articles/committers-guide/_index.adoc:2176 #, 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:2208 +#: documentation/content/en/articles/committers-guide/_index.adoc:2179 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:2213 +#: documentation/content/en/articles/committers-guide/_index.adoc:2184 msgid "[[smtp-setup-local-postfix]] .Using Postfix [example] ====" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2215 +#: documentation/content/en/articles/committers-guide/_index.adoc:2186 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 [." @@ -4493,12 +4434,12 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2217 +#: documentation/content/en/articles/committers-guide/_index.adoc:2188 msgid "[.programlisting]" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2223 +#: documentation/content/en/articles/committers-guide/_index.adoc:2194 msgid "" "sender_dependent_relayhost_maps = hash:/usr/local/etc/postfix/relayhost_maps " "smtp_sasl_auth_enable = yes smtp_sasl_security_options = noanonymous " @@ -4507,67 +4448,67 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2226 +#: documentation/content/en/articles/committers-guide/_index.adoc:2197 #, 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:2228 -#: documentation/content/en/articles/committers-guide/_index.adoc:2235 -#: documentation/content/en/articles/committers-guide/_index.adoc:2242 -#: documentation/content/en/articles/committers-guide/_index.adoc:2250 -#: documentation/content/en/articles/committers-guide/_index.adoc:2265 -#: documentation/content/en/articles/committers-guide/_index.adoc:2275 -#: documentation/content/en/articles/committers-guide/_index.adoc:2289 -#: documentation/content/en/articles/committers-guide/_index.adoc:2319 +#: documentation/content/en/articles/committers-guide/_index.adoc:2199 +#: documentation/content/en/articles/committers-guide/_index.adoc:2206 +#: documentation/content/en/articles/committers-guide/_index.adoc:2213 +#: documentation/content/en/articles/committers-guide/_index.adoc:2221 +#: documentation/content/en/articles/committers-guide/_index.adoc:2236 +#: documentation/content/en/articles/committers-guide/_index.adoc:2246 +#: documentation/content/en/articles/committers-guide/_index.adoc:2260 +#: documentation/content/en/articles/committers-guide/_index.adoc:2290 #, no-wrap msgid "[.programlisting]\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2230 +#: documentation/content/en/articles/committers-guide/_index.adoc:2201 msgid "yourusername@FreeBSD.org [smtp.freebsd.org]:587" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2233 +#: documentation/content/en/articles/committers-guide/_index.adoc:2204 #, 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:2237 +#: documentation/content/en/articles/committers-guide/_index.adoc:2208 #, no-wrap msgid "[smtp.freebsd.org]:587 yourusername:yourpassword\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2240 +#: documentation/content/en/articles/committers-guide/_index.adoc:2211 #, 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:2245 +#: documentation/content/en/articles/committers-guide/_index.adoc:2216 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:2248 +#: documentation/content/en/articles/committers-guide/_index.adoc:2219 #, 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:2252 +#: documentation/content/en/articles/committers-guide/_index.adoc:2223 msgid "yourusername@FreeBSD.org yourlocalusername" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2256 +#: documentation/content/en/articles/committers-guide/_index.adoc:2227 #, no-wrap msgid "" "Where _yourlocalusername_ is the SASL username used to connect to the local instance of Postfix.\n" @@ -4575,7 +4516,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2261 +#: documentation/content/en/articles/committers-guide/_index.adoc:2232 #, no-wrap msgid "" "[[smtp-setup-local-opensmtpd]]\n" @@ -4585,13 +4526,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2263 +#: documentation/content/en/articles/committers-guide/_index.adoc:2234 #, 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:2268 +#: documentation/content/en/articles/committers-guide/_index.adoc:2239 msgid "" "action \"freebsd\" relay host smtp+tls://freebsd@smtp.freebsd.org:587 auth " "<secrets> match from any auth yourlocalusername mail-from " @@ -4599,24 +4540,24 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2271 +#: documentation/content/en/articles/committers-guide/_index.adoc:2242 #, 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:2273 +#: documentation/content/en/articles/committers-guide/_index.adoc:2244 #, 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:2277 +#: documentation/content/en/articles/committers-guide/_index.adoc:2248 msgid "freebsd\tyourusername:yourpassword" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2284 +#: documentation/content/en/articles/committers-guide/_index.adoc:2255 #, no-wrap msgid "" "====\n" @@ -4627,7 +4568,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2287 +#: documentation/content/en/articles/committers-guide/_index.adoc:2258 #, no-wrap msgid "" "To direct a local Exim instance to forward all mail from `_example_@FreeBSD.org`\n" @@ -4635,7 +4576,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2296 +#: documentation/content/en/articles/committers-guide/_index.adoc:2267 #, no-wrap msgid "" "Routers section: (at the top of the list):\n" @@ -4647,7 +4588,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2308 +#: documentation/content/en/articles/committers-guide/_index.adoc:2279 #, no-wrap msgid "" "Transport Section:\n" @@ -4664,7 +4605,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2314 +#: documentation/content/en/articles/committers-guide/_index.adoc:2285 #, no-wrap msgid "" "Authenticators:\n" @@ -4675,36 +4616,36 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2317 +#: documentation/content/en/articles/committers-guide/_index.adoc:2288 #, 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:2321 +#: documentation/content/en/articles/committers-guide/_index.adoc:2292 msgid "example@freebsd.org:smtp.freebsd.org::587" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2324 +#: documentation/content/en/articles/committers-guide/_index.adoc:2295 #, no-wrap msgid "====\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2326 +#: documentation/content/en/articles/committers-guide/_index.adoc:2297 #, no-wrap msgid "[[mentors]]\n" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2326 +#: documentation/content/en/articles/committers-guide/_index.adoc:2297 #, no-wrap msgid "Mentors" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2331 +#: documentation/content/en/articles/committers-guide/_index.adoc:2302 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 " @@ -4714,7 +4655,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2334 +#: documentation/content/en/articles/committers-guide/_index.adoc:2305 msgid "" "For committers: do not commit anything without first getting mentor " "approval. Document that approval with an `Approved by:` line in the commit " @@ -4722,7 +4663,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2338 +#: documentation/content/en/articles/committers-guide/_index.adoc:2309 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 [." @@ -4732,28 +4673,28 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2340 +#: documentation/content/en/articles/committers-guide/_index.adoc:2311 msgid "[[pre-commit-review]]" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2340 +#: documentation/content/en/articles/committers-guide/_index.adoc:2311 #, no-wrap msgid "Pre-Commit Review" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2345 +#: documentation/content/en/articles/committers-guide/_index.adoc:2316 msgid "" "Code review is one way to increase the quality of software. The following " -"guidelines apply to commits to the `head` (-CURRENT) branch of the `src` " +"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:2351 +#: documentation/content/en/articles/committers-guide/_index.adoc:2322 #, no-wrap msgid "" "* All non-trivial changes should be reviewed before they are committed to the repository.\n" @@ -4764,13 +4705,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2353 +#: documentation/content/en/articles/committers-guide/_index.adoc:2324 #, 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:2360 +#: documentation/content/en/articles/committers-guide/_index.adoc:2331 #, 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" @@ -4782,7 +4723,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2365 +#: documentation/content/en/articles/committers-guide/_index.adoc:2336 #, no-wrap msgid "" "Developers should participate in code reviews as both reviewers and reviewees.\n" @@ -4792,7 +4733,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2368 +#: documentation/content/en/articles/committers-guide/_index.adoc:2339 #, no-wrap msgid "" "In some cases, no subject-matter expert may be available.\n" @@ -4800,32 +4741,32 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2370 +#: documentation/content/en/articles/committers-guide/_index.adoc:2341 #, no-wrap msgid "[[commit-log-message]]\n" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2370 +#: documentation/content/en/articles/committers-guide/_index.adoc:2341 #, no-wrap msgid "Commit Log Messages" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2373 +#: documentation/content/en/articles/committers-guide/_index.adoc:2344 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:2374 +#: documentation/content/en/articles/committers-guide/_index.adoc:2345 #, no-wrap msgid "Why are commit messages important?" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2378 +#: documentation/content/en/articles/committers-guide/_index.adoc:2349 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 " @@ -4835,7 +4776,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2381 +#: documentation/content/en/articles/committers-guide/_index.adoc:2352 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 " @@ -4843,7 +4784,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2384 +#: documentation/content/en/articles/committers-guide/_index.adoc:2355 msgid "" "FreeBSD has hundreds of active developers and hundreds of thousands of " "commits spanning decades of history. Over that time the developer community " @@ -4852,12 +4793,12 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2386 +#: documentation/content/en/articles/committers-guide/_index.adoc:2357 msgid "Commit messages serve at least three purposes:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2393 +#: documentation/content/en/articles/committers-guide/_index.adoc:2364 #, no-wrap msgid "" "* Communicating with other developers\n" @@ -4869,7 +4810,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2399 +#: documentation/content/en/articles/committers-guide/_index.adoc:2370 #, no-wrap msgid "" "* Making Changes Discoverable\n" @@ -4880,7 +4821,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2405 +#: documentation/content/en/articles/committers-guide/_index.adoc:2376 #, no-wrap msgid "" "* Providing historical documentation\n" @@ -4891,25 +4832,25 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2407 +#: documentation/content/en/articles/committers-guide/_index.adoc:2378 #, 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:2409 +#: documentation/content/en/articles/committers-guide/_index.adoc:2380 #, 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:2410 +#: documentation/content/en/articles/committers-guide/_index.adoc:2381 #, no-wrap msgid "Start with a subject line" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2414 +#: documentation/content/en/articles/committers-guide/_index.adoc:2385 msgid "" "Commit messages should start with a single-line subject that briefly " "summarizes the change. The subject should, by itself, allow the reader to " @@ -4917,13 +4858,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2415 +#: documentation/content/en/articles/committers-guide/_index.adoc:2386 #, no-wrap msgid "Keep subject lines short" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2420 +#: documentation/content/en/articles/committers-guide/_index.adoc:2391 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 " @@ -4933,86 +4874,86 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2421 +#: documentation/content/en/articles/committers-guide/_index.adoc:2392 #, 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:2424 +#: documentation/content/en/articles/committers-guide/_index.adoc:2395 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:2426 +#: documentation/content/en/articles/committers-guide/_index.adoc:2397 msgid "✓ `foo: Add -k option to keep temporary data`" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2428 +#: documentation/content/en/articles/committers-guide/_index.adoc:2399 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:2429 +#: documentation/content/en/articles/committers-guide/_index.adoc:2400 #, no-wrap msgid "Capitalize the first letter of the subject" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2433 +#: documentation/content/en/articles/committers-guide/_index.adoc:2404 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:2434 +#: documentation/content/en/articles/committers-guide/_index.adoc:2405 #, no-wrap msgid "Do not end the subject line with punctuation" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2438 +#: documentation/content/en/articles/committers-guide/_index.adoc:2409 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:2439 +#: documentation/content/en/articles/committers-guide/_index.adoc:2410 #, 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:2442 +#: documentation/content/en/articles/committers-guide/_index.adoc:2413 msgid "Separate the body from the subject with a blank line." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2444 +#: documentation/content/en/articles/committers-guide/_index.adoc:2415 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:2446 +#: documentation/content/en/articles/committers-guide/_index.adoc:2417 msgid "✓ `ls: Fix typo in usage text`" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2447 +#: documentation/content/en/articles/committers-guide/_index.adoc:2418 #, no-wrap msgid "Limit messages to 72 columns" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2453 +#: documentation/content/en/articles/committers-guide/_index.adoc:2424 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. " @@ -5023,13 +4964,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2454 +#: documentation/content/en/articles/committers-guide/_index.adoc:2425 #, no-wrap msgid "Use the present tense, imperative mood" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2459 +#: documentation/content/en/articles/committers-guide/_index.adoc:2430 msgid "" "This facilitates short subject lines and provides consistency, including " "with automatically generated commit messages (e.g., as generated by git " @@ -5039,7 +4980,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2464 +#: documentation/content/en/articles/committers-guide/_index.adoc:2435 #, no-wrap msgid "" "✓ `foo: Implement the -k (keep) option`\n" @@ -5049,20 +4990,20 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2465 +#: documentation/content/en/articles/committers-guide/_index.adoc:2436 #, no-wrap msgid "Focus on what and why, not how" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2468 +#: documentation/content/en/articles/committers-guide/_index.adoc:2439 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:2472 +#: documentation/content/en/articles/committers-guide/_index.adoc:2443 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 " @@ -5070,20 +5011,20 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2474 +#: documentation/content/en/articles/committers-guide/_index.adoc:2445 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:2475 +#: documentation/content/en/articles/committers-guide/_index.adoc:2446 #, 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:2478 +#: documentation/content/en/articles/committers-guide/_index.adoc:2449 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. " @@ -5092,13 +5033,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2479 +#: documentation/content/en/articles/committers-guide/_index.adoc:2450 #, no-wrap msgid "Write commit messages for your future self" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2483 +#: documentation/content/en/articles/committers-guide/_index.adoc:2454 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 " @@ -5108,13 +5049,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2484 +#: documentation/content/en/articles/committers-guide/_index.adoc:2455 #, no-wrap msgid "Commit messages should stand alone" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2488 +#: documentation/content/en/articles/committers-guide/_index.adoc:2459 msgid "" "You may include references to mailing list postings, benchmark result web " "sites, or code review links. However, the commit message should contain all " @@ -5123,7 +5064,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2492 +#: documentation/content/en/articles/committers-guide/_index.adoc:2463 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 " @@ -5134,32 +5075,32 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2493 +#: documentation/content/en/articles/committers-guide/_index.adoc:2464 #, no-wrap msgid "Include appropriate metadata in a footer" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2496 +#: documentation/content/en/articles/committers-guide/_index.adoc:2467 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:2498 +#: documentation/content/en/articles/committers-guide/_index.adoc:2469 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:2500 +#: documentation/content/en/articles/committers-guide/_index.adoc:2471 msgid "The key words or phrases are:" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2505 +#: documentation/content/en/articles/committers-guide/_index.adoc:2476 #, no-wrap msgid "" "[.informaltable]\n" @@ -5167,25 +5108,25 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2506 +#: documentation/content/en/articles/committers-guide/_index.adoc:2477 #, no-wrap msgid "`PR:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2508 +#: documentation/content/en/articles/committers-guide/_index.adoc:2479 #, 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:2509 +#: documentation/content/en/articles/committers-guide/_index.adoc:2480 #, no-wrap msgid "`Reported by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2513 +#: documentation/content/en/articles/committers-guide/_index.adoc:2484 #, 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" @@ -5194,25 +5135,25 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2514 +#: documentation/content/en/articles/committers-guide/_index.adoc:2485 #, no-wrap msgid "`Submitted by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2516 +#: documentation/content/en/articles/committers-guide/_index.adoc:2487 #, 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:2517 +#: documentation/content/en/articles/committers-guide/_index.adoc:2488 #, no-wrap msgid "`Reviewed by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2532 +#: documentation/content/en/articles/committers-guide/_index.adoc:2503 #, 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" @@ -5231,25 +5172,25 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2533 +#: documentation/content/en/articles/committers-guide/_index.adoc:2504 #, no-wrap msgid "`Tested by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2535 +#: documentation/content/en/articles/committers-guide/_index.adoc:2506 #, 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:2536 +#: documentation/content/en/articles/committers-guide/_index.adoc:2507 #, no-wrap msgid "`Approved by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2561 +#: documentation/content/en/articles/committers-guide/_index.adoc:2532 #, 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" @@ -5277,121 +5218,121 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2562 +#: documentation/content/en/articles/committers-guide/_index.adoc:2533 #, no-wrap msgid "`Obtained from:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2564 +#: documentation/content/en/articles/committers-guide/_index.adoc:2535 #, 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:2565 +#: documentation/content/en/articles/committers-guide/_index.adoc:2536 #, no-wrap msgid "`Fixes:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2567 +#: documentation/content/en/articles/committers-guide/_index.adoc:2538 #, 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:2568 +#: documentation/content/en/articles/committers-guide/_index.adoc:2539 #, no-wrap msgid "`MFC after:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2570 +#: documentation/content/en/articles/committers-guide/_index.adoc:2541 #, 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:2571 +#: documentation/content/en/articles/committers-guide/_index.adoc:2542 #, no-wrap msgid "`MFC to:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2573 +#: documentation/content/en/articles/committers-guide/_index.adoc:2544 #, 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:2574 +#: documentation/content/en/articles/committers-guide/_index.adoc:2545 #, no-wrap msgid "`MFH:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2576 +#: documentation/content/en/articles/committers-guide/_index.adoc:2547 #, 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:2577 +#: documentation/content/en/articles/committers-guide/_index.adoc:2548 #, no-wrap msgid "`Relnotes:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2579 +#: documentation/content/en/articles/committers-guide/_index.adoc:2550 #, 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:2580 +#: documentation/content/en/articles/committers-guide/_index.adoc:2551 #, no-wrap msgid "`Security:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2582 +#: documentation/content/en/articles/committers-guide/_index.adoc:2553 #, 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:2583 +#: documentation/content/en/articles/committers-guide/_index.adoc:2554 #, no-wrap msgid "`Event:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2585 +#: documentation/content/en/articles/committers-guide/_index.adoc:2556 #, 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:2586 +#: documentation/content/en/articles/committers-guide/_index.adoc:2557 #, no-wrap msgid "`Sponsored by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2588 +#: documentation/content/en/articles/committers-guide/_index.adoc:2559 #, 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:2589 +#: documentation/content/en/articles/committers-guide/_index.adoc:2560 #, no-wrap msgid "`Pull Request:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2593 +#: documentation/content/en/articles/committers-guide/_index.adoc:2564 #, 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" @@ -5400,73 +5341,73 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2594 +#: documentation/content/en/articles/committers-guide/_index.adoc:2565 #, no-wrap msgid "`Signed-off-by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2596 +#: documentation/content/en/articles/committers-guide/_index.adoc:2567 #, no-wrap msgid "ID certifies compliance with https://developercertificate.org/" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2597 +#: documentation/content/en/articles/committers-guide/_index.adoc:2568 #, no-wrap msgid "`Differential Revision:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2599 +#: documentation/content/en/articles/committers-guide/_index.adoc:2570 #, 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:2601 +#: documentation/content/en/articles/committers-guide/_index.adoc:2572 #, 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:2607 +#: documentation/content/en/articles/committers-guide/_index.adoc:2578 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:2611 -#: documentation/content/en/articles/committers-guide/_index.adoc:2629 -#: documentation/content/en/articles/committers-guide/_index.adoc:2644 -#: documentation/content/en/articles/committers-guide/_index.adoc:2660 -#: documentation/content/en/articles/committers-guide/_index.adoc:2675 +#: documentation/content/en/articles/committers-guide/_index.adoc:2582 +#: documentation/content/en/articles/committers-guide/_index.adoc:2600 +#: documentation/content/en/articles/committers-guide/_index.adoc:2615 +#: documentation/content/en/articles/committers-guide/_index.adoc:2631 +#: documentation/content/en/articles/committers-guide/_index.adoc:2646 #, no-wrap msgid "...\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2613 +#: documentation/content/en/articles/committers-guide/_index.adoc:2584 #, no-wrap msgid "PR:\t\t12345\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2616 +#: documentation/content/en/articles/committers-guide/_index.adoc:2587 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:2619 +#: documentation/content/en/articles/committers-guide/_index.adoc:2590 #, no-wrap msgid "Commit Log for a Commit Needing Review" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2625 +#: documentation/content/en/articles/committers-guide/_index.adoc:2596 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 " @@ -5474,73 +5415,73 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2631 +#: documentation/content/en/articles/committers-guide/_index.adoc:2602 #, no-wrap msgid "Reviewed by:\t-arch\n" msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2635 +#: documentation/content/en/articles/committers-guide/_index.adoc:2606 #, no-wrap msgid "Commit Log for a Commit Needing Approval" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2640 +#: documentation/content/en/articles/committers-guide/_index.adoc:2611 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:2646 +#: documentation/content/en/articles/committers-guide/_index.adoc:2617 #, no-wrap msgid "Approved by:\tabc (maintainer)\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2649 +#: documentation/content/en/articles/committers-guide/_index.adoc:2620 msgid "Where _abc_ is the account name of the person who approved." msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2651 +#: documentation/content/en/articles/committers-guide/_index.adoc:2622 #, 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:2656 +#: documentation/content/en/articles/committers-guide/_index.adoc:2627 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:2662 +#: documentation/content/en/articles/committers-guide/_index.adoc:2633 #, no-wrap msgid "Obtained from:\tOpenBSD\n" msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2666 +#: documentation/content/en/articles/committers-guide/_index.adoc:2637 #, 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:2671 +#: documentation/content/en/articles/committers-guide/_index.adoc:2642 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:2677 +#: documentation/content/en/articles/committers-guide/_index.adoc:2648 #, no-wrap msgid "MFC after:\t2 weeks\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2680 +#: documentation/content/en/articles/committers-guide/_index.adoc:2651 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`, " @@ -5548,12 +5489,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2683 +#: documentation/content/en/articles/committers-guide/_index.adoc:2654 msgid "It is often necessary to combine these." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2687 +#: documentation/content/en/articles/committers-guide/_index.adoc:2658 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 " @@ -5563,19 +5504,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2689 +#: documentation/content/en/articles/committers-guide/_index.adoc:2660 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:2690 +#: documentation/content/en/articles/committers-guide/_index.adoc:2661 #, no-wrap msgid "Example Combined Commit Log" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2701 +#: documentation/content/en/articles/committers-guide/_index.adoc:2672 #, no-wrap msgid "" "PR:\t\t54321\n" @@ -5586,13 +5527,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2706 +#: documentation/content/en/articles/committers-guide/_index.adoc:2677 #, no-wrap msgid "Preferred License for New Files" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2712 +#: documentation/content/en/articles/committers-guide/_index.adoc:2683 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/" @@ -5602,14 +5543,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2714 +#: documentation/content/en/articles/committers-guide/_index.adoc:2685 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:2745 +#: documentation/content/en/articles/committers-guide/_index.adoc:2716 #, no-wrap msgid "" "/*-\n" @@ -5643,7 +5584,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2751 +#: documentation/content/en/articles/committers-guide/_index.adoc:2722 msgid "" "The FreeBSD project strongly discourages the so-called \"advertising " "clause\" in new code. Due to the large number of contributors to the " @@ -5654,18 +5595,18 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2755 +#: documentation/content/en/articles/committers-guide/_index.adoc:2726 msgid "" "The FreeBSD project discourages completely new licenses and variations on " -"the standard licenses. New licenses require the approval of the {core-" -"email} to reside in the main 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." +"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:2759 +#: documentation/content/en/articles/committers-guide/_index.adoc:2730 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 " @@ -5676,7 +5617,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2762 +#: documentation/content/en/articles/committers-guide/_index.adoc:2733 msgid "" "Developers are reminded that in open source, getting \"open\" right is just " "as important as getting \"source\" right, as improper handling of " @@ -5685,13 +5626,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2764 +#: documentation/content/en/articles/committers-guide/_index.adoc:2735 #, no-wrap msgid "Keeping Track of Licenses Granted to the FreeBSD Project" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2769 +#: documentation/content/en/articles/committers-guide/_index.adoc:2740 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 " @@ -5702,7 +5643,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2774 +#: documentation/content/en/articles/committers-guide/_index.adoc:2745 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 " @@ -5712,13 +5653,13 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2776 +#: documentation/content/en/articles/committers-guide/_index.adoc:2747 msgid "" "Contact details for people or organizations granting the special license." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2777 +#: documentation/content/en/articles/committers-guide/_index.adoc:2748 msgid "" "What files, directories etc. in the repositories are covered by the license " "grant including the revision numbers where any specially licensed material " @@ -5726,7 +5667,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2778 +#: documentation/content/en/articles/committers-guide/_index.adoc:2749 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 " @@ -5734,24 +5675,24 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2779 +#: documentation/content/en/articles/committers-guide/_index.adoc:2750 msgid "The license text." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2780 +#: documentation/content/en/articles/committers-guide/_index.adoc:2751 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:2781 +#: documentation/content/en/articles/committers-guide/_index.adoc:2752 msgid "Any other relevant information." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2784 +#: documentation/content/en/articles/committers-guide/_index.adoc:2755 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 " @@ -5761,7 +5702,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2787 +#: documentation/content/en/articles/committers-guide/_index.adoc:2758 msgid "" "The license archive should contain only details of license grants; this is " "not the place for any discussions around licensing or other subjects. " @@ -5770,13 +5711,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2789 +#: documentation/content/en/articles/committers-guide/_index.adoc:2760 #, no-wrap msgid "SPDX Tags in the tree" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2800 +#: documentation/content/en/articles/committers-guide/_index.adoc:2771 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 " @@ -5795,20 +5736,20 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2802 +#: documentation/content/en/articles/committers-guide/_index.adoc:2773 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:2803 +#: documentation/content/en/articles/committers-guide/_index.adoc:2774 #, no-wrap msgid "Developer Relations" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2809 +#: documentation/content/en/articles/committers-guide/_index.adoc:2780 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 " @@ -5821,7 +5762,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2813 +#: documentation/content/en/articles/committers-guide/_index.adoc:2784 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 " @@ -5832,27 +5773,27 @@ msgid "" msgstr "" #. type: delimited block - 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2817 +#: documentation/content/en/articles/committers-guide/_index.adoc:2788 #, 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:2820 +#: documentation/content/en/articles/committers-guide/_index.adoc:2791 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:2825 +#: documentation/content/en/articles/committers-guide/_index.adoc:2796 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:2831 +#: documentation/content/en/articles/committers-guide/_index.adoc:2802 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 " @@ -5863,7 +5804,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2835 +#: documentation/content/en/articles/committers-guide/_index.adoc:2806 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 " @@ -5873,7 +5814,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2838 +#: documentation/content/en/articles/committers-guide/_index.adoc:2809 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 " @@ -5881,7 +5822,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2844 +#: documentation/content/en/articles/committers-guide/_index.adoc:2815 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 " @@ -5890,7 +5831,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2848 +#: documentation/content/en/articles/committers-guide/_index.adoc:2819 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 " @@ -5898,20 +5839,20 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2850 +#: documentation/content/en/articles/committers-guide/_index.adoc:2821 #, no-wrap msgid "If in Doubt..." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2854 +#: documentation/content/en/articles/committers-guide/_index.adoc:2825 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:2858 +#: documentation/content/en/articles/committers-guide/_index.adoc:2829 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 " @@ -5919,32 +5860,32 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2860 +#: documentation/content/en/articles/committers-guide/_index.adoc:2831 msgid "For project specific or administrative questions ask, in order:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2862 +#: documentation/content/en/articles/committers-guide/_index.adoc:2833 msgid "Your mentor or former mentor." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2863 +#: documentation/content/en/articles/committers-guide/_index.adoc:2834 msgid "An experienced committer on IRC, email, etc." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2864 +#: documentation/content/en/articles/committers-guide/_index.adoc:2835 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:2865 +#: documentation/content/en/articles/committers-guide/_index.adoc:2836 msgid "If still not sure, ask on {developers-name}." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2867 +#: documentation/content/en/articles/committers-guide/_index.adoc:2838 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 " @@ -5952,13 +5893,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2869 +#: documentation/content/en/articles/committers-guide/_index.adoc:2840 #, no-wrap msgid "Bugzilla" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2874 +#: documentation/content/en/articles/committers-guide/_index.adoc:2845 msgid "" "The FreeBSD Project utilizes Bugzilla for tracking bugs and change " "requests. Be sure that if you commit a fix or suggestion found in the PR " @@ -5967,26 +5908,26 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2876 +#: documentation/content/en/articles/committers-guide/_index.adoc:2847 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:2880 +#: documentation/content/en/articles/committers-guide/_index.adoc:2851 msgid "Log in using your old account." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2881 +#: documentation/content/en/articles/committers-guide/_index.adoc:2852 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:2882 +#: documentation/content/en/articles/committers-guide/_index.adoc:2853 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 " @@ -5994,35 +5935,35 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2883 +#: documentation/content/en/articles/committers-guide/_index.adoc:2854 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:2886 +#: documentation/content/en/articles/committers-guide/_index.adoc:2857 msgid "You can find out more about Bugzilla at:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2888 +#: documentation/content/en/articles/committers-guide/_index.adoc:2859 msgid "extref:{pr-guidelines}[FreeBSD Problem Report Handling Guidelines]" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2889 +#: documentation/content/en/articles/committers-guide/_index.adoc:2860 msgid "link:https://www.FreeBSD.org/support/[https://www.FreeBSD.org/support]" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2891 +#: documentation/content/en/articles/committers-guide/_index.adoc:2862 #, no-wrap msgid "Phabricator" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2895 +#: documentation/content/en/articles/committers-guide/_index.adoc:2866 msgid "" "The FreeBSD Project utilizes https://reviews.freebsd.org[Phabricator] for " "code review requests. See the https://wiki.freebsd.org/" @@ -6030,19 +5971,19 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2897 +#: documentation/content/en/articles/committers-guide/_index.adoc:2868 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:2901 +#: documentation/content/en/articles/committers-guide/_index.adoc:2872 msgid "Change your Phabricator account email to your `FreeBSD.org` email." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2902 +#: documentation/content/en/articles/committers-guide/_index.adoc:2873 msgid "" "Open new bug on our bug tracker using your `FreeBSD.org` account, see " "<<bugzilla>> for more information. Choose `Services` as the Product, and " @@ -6052,19 +5993,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2907 +#: documentation/content/en/articles/committers-guide/_index.adoc:2878 msgid "" "Phabricator accounts cannot be merged, please do not open a new account." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2910 +#: documentation/content/en/articles/committers-guide/_index.adoc:2881 #, no-wrap msgid "Who's Who" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2913 +#: documentation/content/en/articles/committers-guide/_index.adoc:2884 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. " @@ -6072,13 +6013,13 @@ msgid "" msgstr "" #. type: Labeled list -#: documentation/content/en/articles/committers-guide/_index.adoc:2914 +#: documentation/content/en/articles/committers-guide/_index.adoc:2885 #, no-wrap msgid "`{doceng}`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2920 +#: documentation/content/en/articles/committers-guide/_index.adoc:2891 msgid "" "doceng is the group responsible for the documentation build infrastructure, " "approving new documentation committers, and ensuring that the FreeBSD " @@ -6092,13 +6033,13 @@ msgid "" msgstr "" #. type: Labeled list -#: documentation/content/en/articles/committers-guide/_index.adoc:2921 +#: documentation/content/en/articles/committers-guide/_index.adoc:2892 #, no-wrap msgid "`{re-members}`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2926 +#: documentation/content/en/articles/committers-guide/_index.adoc:2897 msgid "" "These are the members of the `{re}`. This team is responsible for setting " "release deadlines and controlling the release process. During code freezes, " @@ -6109,20 +6050,20 @@ msgid "" msgstr "" #. type: Labeled list -#: documentation/content/en/articles/committers-guide/_index.adoc:2927 +#: documentation/content/en/articles/committers-guide/_index.adoc:2898 #, no-wrap msgid "`{so}`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2929 +#: documentation/content/en/articles/committers-guide/_index.adoc:2900 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:2934 +#: documentation/content/en/articles/committers-guide/_index.adoc:2905 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 " @@ -6131,7 +6072,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2939 +#: documentation/content/en/articles/committers-guide/_index.adoc:2910 msgid "" "{developers-name}:: All committers are subscribed to -developers. This list " "was created to be a forum for the committers \"community\" issues. Examples " @@ -6139,7 +6080,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2943 +#: documentation/content/en/articles/committers-guide/_index.adoc:2914 msgid "" "The {developers-name} is for the exclusive use of FreeBSD committers. To " "develop FreeBSD, committers must have the ability to openly discuss matters " @@ -6149,7 +6090,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2947 +#: documentation/content/en/articles/committers-guide/_index.adoc:2918 msgid "" "All FreeBSD committers are expected not to not publish or forward messages " "from the {developers-name} outside the list membership without permission of " @@ -6159,7 +6100,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2953 +#: documentation/content/en/articles/committers-guide/_index.adoc:2924 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 " @@ -6172,13 +6113,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2954 +#: documentation/content/en/articles/committers-guide/_index.adoc:2925 #, no-wrap msgid "SSH Quick-Start Guide" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2959 +#: documentation/content/en/articles/committers-guide/_index.adoc:2930 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 " @@ -6189,19 +6130,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2960 +#: documentation/content/en/articles/committers-guide/_index.adoc:2931 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:2964 +#: documentation/content/en/articles/committers-guide/_index.adoc:2935 msgid "Only ECDSA, Ed25519 or RSA keys are supported." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2966 +#: documentation/content/en/articles/committers-guide/_index.adoc:2937 msgid "" "Send your public key ([.filename]#$HOME/.ssh/id_ecdsa.pub#, [." "filename]#$HOME/.ssh/id_ed25519.pub#, or [.filename]#$HOME/.ssh/id_rsa.pub#) " @@ -6210,7 +6151,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2971 +#: documentation/content/en/articles/committers-guide/_index.adoc:2942 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 " @@ -6219,32 +6160,32 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2973 +#: documentation/content/en/articles/committers-guide/_index.adoc:2944 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:2975 +#: documentation/content/en/articles/committers-guide/_index.adoc:2946 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:2977 +#: documentation/content/en/articles/committers-guide/_index.adoc:2948 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:2979 +#: documentation/content/en/articles/committers-guide/_index.adoc:2950 #, no-wrap msgid "Coverity(R) Availability for FreeBSD Committers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2983 +#: documentation/content/en/articles/committers-guide/_index.adoc:2954 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 " @@ -6253,7 +6194,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2986 +#: documentation/content/en/articles/committers-guide/_index.adoc:2957 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/" @@ -6264,7 +6205,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2988 +#: documentation/content/en/articles/committers-guide/_index.adoc:2959 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 " @@ -6272,13 +6213,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2990 +#: documentation/content/en/articles/committers-guide/_index.adoc:2961 #, no-wrap msgid "The FreeBSD Committers' Big List of Rules" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2995 +#: documentation/content/en/articles/committers-guide/_index.adoc:2966 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-" @@ -6289,25 +6230,25 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2997 -#: documentation/content/en/articles/committers-guide/_index.adoc:3027 +#: documentation/content/en/articles/committers-guide/_index.adoc:2968 +#: documentation/content/en/articles/committers-guide/_index.adoc:2998 msgid "Respect other committers." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2998 -#: documentation/content/en/articles/committers-guide/_index.adoc:3043 +#: documentation/content/en/articles/committers-guide/_index.adoc:2969 +#: documentation/content/en/articles/committers-guide/_index.adoc:3014 msgid "Respect other contributors." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2999 -#: documentation/content/en/articles/committers-guide/_index.adoc:3058 +#: documentation/content/en/articles/committers-guide/_index.adoc:2970 +#: documentation/content/en/articles/committers-guide/_index.adoc:3029 msgid "Discuss any significant change _before_ committing." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3000 +#: documentation/content/en/articles/committers-guide/_index.adoc:2971 msgid "" "Respect existing maintainers (if listed in the `MAINTAINER` field in [." "filename]#Makefile# or in [.filename]#MAINTAINER# in the top-level " @@ -6315,8 +6256,8 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3001 -#: documentation/content/en/articles/committers-guide/_index.adoc:3073 +#: documentation/content/en/articles/committers-guide/_index.adoc:2972 +#: documentation/content/en/articles/committers-guide/_index.adoc:3044 msgid "" "Any disputed change must be backed out pending resolution of the dispute if " "requested by a maintainer. Security related changes may override a " @@ -6324,7 +6265,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3002 +#: documentation/content/en/articles/committers-guide/_index.adoc:2973 msgid "" "Changes go to FreeBSD-CURRENT before FreeBSD-STABLE unless specifically " "permitted by the release engineer or unless they are not applicable to " @@ -6336,40 +6277,40 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3003 -#: documentation/content/en/articles/committers-guide/_index.adoc:3088 +#: documentation/content/en/articles/committers-guide/_index.adoc:2974 +#: documentation/content/en/articles/committers-guide/_index.adoc:3059 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:3004 +#: documentation/content/en/articles/committers-guide/_index.adoc:2975 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:3005 -#: documentation/content/en/articles/committers-guide/_index.adoc:3103 +#: documentation/content/en/articles/committers-guide/_index.adoc:2976 +#: documentation/content/en/articles/committers-guide/_index.adoc:3074 msgid "When in doubt on any procedure, ask first!" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3006 -#: documentation/content/en/articles/committers-guide/_index.adoc:3108 +#: documentation/content/en/articles/committers-guide/_index.adoc:2977 +#: documentation/content/en/articles/committers-guide/_index.adoc:3079 msgid "Test your changes before committing them." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3007 -#: documentation/content/en/articles/committers-guide/_index.adoc:3117 +#: documentation/content/en/articles/committers-guide/_index.adoc:2978 +#: documentation/content/en/articles/committers-guide/_index.adoc:3088 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:3018 +#: documentation/content/en/articles/committers-guide/_index.adoc:2989 msgid "" "As noted, breaking some of these rules can be grounds for suspension or, " "upon repeated offense, permanent removal of commit privileges. Individual " @@ -6395,7 +6336,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3022 +#: documentation/content/en/articles/committers-guide/_index.adoc:2993 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 " @@ -6406,13 +6347,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3023 +#: documentation/content/en/articles/committers-guide/_index.adoc:2994 #, no-wrap msgid "Details" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3031 +#: documentation/content/en/articles/committers-guide/_index.adoc:3002 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 " @@ -6424,7 +6365,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3033 +#: documentation/content/en/articles/committers-guide/_index.adoc:3004 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 " @@ -6434,7 +6375,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3039 +#: documentation/content/en/articles/committers-guide/_index.adoc:3010 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 " @@ -6453,7 +6394,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3042 +#: documentation/content/en/articles/committers-guide/_index.adoc:3013 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 " @@ -6461,7 +6402,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3055 +#: documentation/content/en/articles/committers-guide/_index.adoc:3026 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 " @@ -6475,14 +6416,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3057 +#: documentation/content/en/articles/committers-guide/_index.adoc:3028 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:3064 +#: documentation/content/en/articles/committers-guide/_index.adoc:3035 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 " @@ -6498,17 +6439,17 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3066 +#: documentation/content/en/articles/committers-guide/_index.adoc:3037 msgid "When in doubt, ask for review!" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3067 +#: documentation/content/en/articles/committers-guide/_index.adoc:3038 msgid "Respect existing maintainers if listed." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3072 +#: documentation/content/en/articles/committers-guide/_index.adoc:3043 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, " @@ -6524,7 +6465,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3078 +#: documentation/content/en/articles/committers-guide/_index.adoc:3049 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 " @@ -6542,7 +6483,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3079 +#: documentation/content/en/articles/committers-guide/_index.adoc:3050 msgid "" "Changes go to FreeBSD-CURRENT before FreeBSD-STABLE unless specifically " "permitted by the release engineer or unless they are not applicable to " @@ -6553,7 +6494,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3085 +#: documentation/content/en/articles/committers-guide/_index.adoc:3056 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 " @@ -6572,7 +6513,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3087 +#: documentation/content/en/articles/committers-guide/_index.adoc:3058 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 " @@ -6580,7 +6521,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3098 +#: documentation/content/en/articles/committers-guide/_index.adoc:3069 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. " @@ -6605,14 +6546,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3099 +#: documentation/content/en/articles/committers-guide/_index.adoc:3070 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:3102 +#: documentation/content/en/articles/committers-guide/_index.adoc:3073 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 " @@ -6623,7 +6564,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3107 +#: documentation/content/en/articles/committers-guide/_index.adoc:3078 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, " @@ -6635,7 +6576,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3116 +#: documentation/content/en/articles/committers-guide/_index.adoc:3087 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 " @@ -6650,14 +6591,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3119 +#: documentation/content/en/articles/committers-guide/_index.adoc:3090 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:3124 +#: documentation/content/en/articles/committers-guide/_index.adoc:3095 msgid "" "The trees mentioned above are for contributed software usually imported onto " "a vendor branch. Committing something there may cause unnecessary headaches " @@ -6667,7 +6608,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3128 +#: documentation/content/en/articles/committers-guide/_index.adoc:3099 msgid "" "Reasons for modifying upstream software range from wanting strict control " "over a tightly coupled dependency to lack of portability in the canonical " @@ -6679,7 +6620,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3131 +#: documentation/content/en/articles/committers-guide/_index.adoc:3102 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 " @@ -6687,13 +6628,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3132 +#: documentation/content/en/articles/committers-guide/_index.adoc:3103 #, no-wrap msgid "Policy on Multiple Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3136 +#: documentation/content/en/articles/committers-guide/_index.adoc:3107 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 " @@ -6702,7 +6643,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3140 +#: documentation/content/en/articles/committers-guide/_index.adoc:3111 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 " @@ -6712,7 +6653,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3144 +#: documentation/content/en/articles/committers-guide/_index.adoc:3115 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 " @@ -6723,13 +6664,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3146 +#: documentation/content/en/articles/committers-guide/_index.adoc:3117 #, no-wrap msgid "Policy on Multiple Compilers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3160 +#: documentation/content/en/articles/committers-guide/_index.adoc:3131 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 " @@ -6755,7 +6696,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3165 +#: documentation/content/en/articles/committers-guide/_index.adoc:3136 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 " @@ -6764,7 +6705,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3173 +#: documentation/content/en/articles/committers-guide/_index.adoc:3144 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 " @@ -6779,7 +6720,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3177 +#: documentation/content/en/articles/committers-guide/_index.adoc:3148 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 " @@ -6788,7 +6729,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3183 +#: documentation/content/en/articles/committers-guide/_index.adoc:3154 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 " @@ -6801,7 +6742,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3187 +#: documentation/content/en/articles/committers-guide/_index.adoc:3158 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 " @@ -6811,7 +6752,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3193 +#: documentation/content/en/articles/committers-guide/_index.adoc:3164 msgid "" "The FreeBSD project provides headers and libraries that allow other " "compilers to be used to build software not in the base system. These " @@ -6826,7 +6767,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3198 +#: documentation/content/en/articles/committers-guide/_index.adoc:3169 msgid "" "The FreeBSD build system currently accommodates these different " "environments. As new warnings are added to compilers, the project tries to " @@ -6838,13 +6779,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3199 +#: documentation/content/en/articles/committers-guide/_index.adoc:3170 #, no-wrap msgid "Current Compiler Versions" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3204 +#: documentation/content/en/articles/committers-guide/_index.adoc:3175 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. " @@ -6854,13 +6795,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3205 +#: documentation/content/en/articles/committers-guide/_index.adoc:3176 #, no-wrap msgid "Other Suggestions" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3209 +#: documentation/content/en/articles/committers-guide/_index.adoc:3180 msgid "" "When committing documentation changes, use a spell checker before " "committing. For all XML docs, verify that the formatting directives are " @@ -6868,7 +6809,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3211 +#: documentation/content/en/articles/committers-guide/_index.adoc:3182 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 " @@ -6877,7 +6818,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3218 +#: documentation/content/en/articles/committers-guide/_index.adoc:3189 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 " @@ -6890,20 +6831,20 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3219 +#: documentation/content/en/articles/committers-guide/_index.adoc:3190 #, no-wrap msgid "Deprecating Features" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3222 +#: documentation/content/en/articles/committers-guide/_index.adoc:3193 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:3224 +#: documentation/content/en/articles/committers-guide/_index.adoc:3195 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 " @@ -6911,14 +6852,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3225 +#: documentation/content/en/articles/committers-guide/_index.adoc:3196 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:3226 +#: documentation/content/en/articles/committers-guide/_index.adoc:3197 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 " @@ -6926,18 +6867,18 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3227 +#: documentation/content/en/articles/committers-guide/_index.adoc:3198 #, no-wrap msgid "Privacy and Confidentiality" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3230 +#: documentation/content/en/articles/committers-guide/_index.adoc:3201 msgid "Most FreeBSD business is done in public." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3233 +#: documentation/content/en/articles/committers-guide/_index.adoc:3204 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 " @@ -6945,12 +6886,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3234 +#: documentation/content/en/articles/committers-guide/_index.adoc:3205 msgid "Certain sensitive matters must remain private or held under embargo." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3240 +#: documentation/content/en/articles/committers-guide/_index.adoc:3211 msgid "" "There unfortunately cannot be complete transparency. As a FreeBSD developer " "you will have a certain degree of privileged access to information. " @@ -6961,14 +6902,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3241 +#: documentation/content/en/articles/committers-guide/_index.adoc:3212 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:3246 +#: documentation/content/en/articles/committers-guide/_index.adoc:3217 msgid "" "Where there are security problems that affect many different operating " "systems, FreeBSD frequently depends on early access to be able to prepare " @@ -6981,13 +6922,13 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3247 +#: documentation/content/en/articles/committers-guide/_index.adoc:3218 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:3252 +#: documentation/content/en/articles/committers-guide/_index.adoc:3223 msgid "" "Communications to core will initially be treated as confidential. " "Eventually however, most of Core's business will be summarized into the " @@ -6998,14 +6939,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3253 +#: documentation/content/en/articles/committers-guide/_index.adoc:3224 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:3256 +#: documentation/content/en/articles/committers-guide/_index.adoc:3227 msgid "" "Access to certain commercially sensitive data may only be available under a " "Non-Disclosure Agreement. The FreeBSD Foundation legal staff must be " @@ -7013,12 +6954,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3257 +#: documentation/content/en/articles/committers-guide/_index.adoc:3228 msgid "Private communications must not be made public without permission." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3260 +#: documentation/content/en/articles/committers-guide/_index.adoc:3231 msgid "" "Beyond the specific requirements above there is a general expectation not to " "publish private communications between developers without the consent of all " @@ -7028,14 +6969,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3261 +#: documentation/content/en/articles/committers-guide/_index.adoc:3232 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:3264 +#: documentation/content/en/articles/committers-guide/_index.adoc:3235 msgid "" "Similarly to personal communications, certain internal communications " "channels, including FreeBSD Committer only mailing lists and restricted " @@ -7044,12 +6985,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3265 +#: documentation/content/en/articles/committers-guide/_index.adoc:3236 msgid "Core may approve publication." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3267 +#: documentation/content/en/articles/committers-guide/_index.adoc:3238 msgid "" "Where it is impractical to obtain permission due to the number of " "correspondents or where permission to publish is unreasonably withheld, Core " @@ -7058,13 +6999,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3269 +#: documentation/content/en/articles/committers-guide/_index.adoc:3240 #, no-wrap msgid "Support for Multiple Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3276 +#: documentation/content/en/articles/committers-guide/_index.adoc:3247 msgid "" "FreeBSD is a highly portable operating system intended to function on many " "different types of hardware architectures. Maintaining clean separation of " @@ -7080,13 +7021,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3277 +#: documentation/content/en/articles/committers-guide/_index.adoc:3248 #, no-wrap msgid "Statement of General Intent" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3282 +#: documentation/content/en/articles/committers-guide/_index.adoc:3253 msgid "" "The FreeBSD Project targets \"production quality commercial off-the-shelf " "(COTS) workstation, server, and high-end embedded systems\". By retaining a " @@ -7102,7 +7043,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3289 +#: documentation/content/en/articles/committers-guide/_index.adoc:3260 msgid "" "The FreeBSD Project differentiates platform targets into four tiers. Each " "tier includes a list of guarantees consumers may rely on as well as " @@ -7116,13 +7057,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3290 +#: documentation/content/en/articles/committers-guide/_index.adoc:3261 #, no-wrap msgid "Platform Targets" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3297 +#: documentation/content/en/articles/committers-guide/_index.adoc:3268 msgid "" "Support for a hardware platform consists of two components: kernel support " "and userland Application Binary Interfaces (ABIs). Kernel platform support " @@ -7137,7 +7078,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3299 +#: documentation/content/en/articles/committers-guide/_index.adoc:3270 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 " @@ -7146,7 +7087,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3304 +#: documentation/content/en/articles/committers-guide/_index.adoc:3275 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 " @@ -7157,20 +7098,20 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3306 +#: documentation/content/en/articles/committers-guide/_index.adoc:3277 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:3307 +#: documentation/content/en/articles/committers-guide/_index.adoc:3278 #, no-wrap msgid "Tier 1: Fully-Supported Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3312 +#: documentation/content/en/articles/committers-guide/_index.adoc:3283 msgid "" "Tier 1 platforms are the most mature FreeBSD platforms. They are supported " "by the security officer, release engineering, and Ports Management Team. " @@ -7180,42 +7121,42 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3314 +#: documentation/content/en/articles/committers-guide/_index.adoc:3285 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:3316 +#: documentation/content/en/articles/committers-guide/_index.adoc:3287 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:3317 +#: documentation/content/en/articles/committers-guide/_index.adoc:3288 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:3318 +#: documentation/content/en/articles/committers-guide/_index.adoc:3289 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:3319 +#: documentation/content/en/articles/committers-guide/_index.adoc:3290 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:3320 +#: documentation/content/en/articles/committers-guide/_index.adoc:3291 msgid "" "Changes to userland ABIs will generally include compatibility shims to " "ensure correct operation of binaries compiled against any stable branch " @@ -7225,7 +7166,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3321 +#: documentation/content/en/articles/committers-guide/_index.adoc:3292 msgid "" "Changes to certain portions of the kernel ABI will include compatibility " "shims to ensure correct operation of kernel modules compiled against the " @@ -7234,7 +7175,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3322 +#: documentation/content/en/articles/committers-guide/_index.adoc:3293 msgid "" "Official binary packages for third party software will be provided by the " "ports team. For embedded architectures, these packages may be cross-built " @@ -7242,21 +7183,21 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3323 +#: documentation/content/en/articles/committers-guide/_index.adoc:3294 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:3324 +#: documentation/content/en/articles/committers-guide/_index.adoc:3295 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:3325 +#: documentation/content/en/articles/committers-guide/_index.adoc:3296 msgid "" "Features and compatibility shims used by binaries compiled against older " "stable branches may be removed in newer major versions. Such removals will " @@ -7264,19 +7205,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3326 +#: documentation/content/en/articles/committers-guide/_index.adoc:3297 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:3327 +#: documentation/content/en/articles/committers-guide/_index.adoc:3298 msgid "Tier 1 platforms will be included in the source tree." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3328 +#: documentation/content/en/articles/committers-guide/_index.adoc:3299 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 " @@ -7284,14 +7225,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3330 +#: documentation/content/en/articles/committers-guide/_index.adoc:3301 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:3332 +#: documentation/content/en/articles/committers-guide/_index.adoc:3303 msgid "" "Build and test automation support either in the FreeBSD.org cluster or some " "other location easily available for all developers. Embedded platforms may " @@ -7300,41 +7241,41 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3333 -#: documentation/content/en/articles/committers-guide/_index.adoc:3363 +#: documentation/content/en/articles/committers-guide/_index.adoc:3304 +#: documentation/content/en/articles/committers-guide/_index.adoc:3334 msgid "Inclusion in the `make universe` and `make tinderbox` targets." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3334 +#: documentation/content/en/articles/committers-guide/_index.adoc:3305 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:3336 +#: documentation/content/en/articles/committers-guide/_index.adoc:3307 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:3338 +#: documentation/content/en/articles/committers-guide/_index.adoc:3309 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:3339 +#: documentation/content/en/articles/committers-guide/_index.adoc:3310 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:3340 +#: documentation/content/en/articles/committers-guide/_index.adoc:3311 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 " @@ -7343,7 +7284,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3341 +#: documentation/content/en/articles/committers-guide/_index.adoc:3312 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 " @@ -7351,7 +7292,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3342 +#: documentation/content/en/articles/committers-guide/_index.adoc:3313 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 " @@ -7359,13 +7300,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3343 +#: documentation/content/en/articles/committers-guide/_index.adoc:3314 #, no-wrap msgid "Tier 2: Developmental and Niche Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3347 +#: documentation/content/en/articles/committers-guide/_index.adoc:3318 msgid "" "Tier 2 platforms are functional, but less mature FreeBSD platforms. They " "are not supported by the security officer, release engineering, and Ports " @@ -7373,7 +7314,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3351 +#: documentation/content/en/articles/committers-guide/_index.adoc:3322 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 " @@ -7383,14 +7324,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3353 +#: documentation/content/en/articles/committers-guide/_index.adoc:3324 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:3355 +#: documentation/content/en/articles/committers-guide/_index.adoc:3326 msgid "" "The ports infrastructure should include basic support for Tier 2 " "architectures sufficient to support building ports and packages. This " @@ -7399,19 +7340,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3356 +#: documentation/content/en/articles/committers-guide/_index.adoc:3327 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:3357 +#: documentation/content/en/articles/committers-guide/_index.adoc:3328 msgid "Tier 2 platforms will be included in the source tree." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3358 +#: documentation/content/en/articles/committers-guide/_index.adoc:3329 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 " @@ -7419,41 +7360,41 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3359 +#: documentation/content/en/articles/committers-guide/_index.adoc:3330 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:3361 +#: documentation/content/en/articles/committers-guide/_index.adoc:3332 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:3365 +#: documentation/content/en/articles/committers-guide/_index.adoc:3336 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:3367 +#: documentation/content/en/articles/committers-guide/_index.adoc:3338 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:3368 +#: documentation/content/en/articles/committers-guide/_index.adoc:3339 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:3369 +#: documentation/content/en/articles/committers-guide/_index.adoc:3340 msgid "" "While changes are permitted to break the userland ABI, the ABI should not be " "broken gratuitously. Significant userland ABI changes should be restricted " @@ -7461,20 +7402,20 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3370 +#: documentation/content/en/articles/committers-guide/_index.adoc:3341 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:3371 +#: documentation/content/en/articles/committers-guide/_index.adoc:3342 #, no-wrap msgid "Tier 3: Experimental Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3375 +#: documentation/content/en/articles/committers-guide/_index.adoc:3346 msgid "" "Tier 3 platforms have at least partial FreeBSD support. They are _not_ " "supported by the security officer, release engineering, and Ports Management " @@ -7482,7 +7423,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3378 +#: documentation/content/en/articles/committers-guide/_index.adoc:3349 msgid "" "Tier 3 platforms are architectures in the early stages of development, for " "non-mainstream hardware platforms, or which are considered legacy systems " @@ -7491,7 +7432,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3381 +#: documentation/content/en/articles/committers-guide/_index.adoc:3352 msgid "" "The FreeBSD Project provides no guarantees to consumers of Tier 3 platforms " "and is not committed to maintaining resources to support development. Tier " @@ -7500,20 +7441,20 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3382 +#: documentation/content/en/articles/committers-guide/_index.adoc:3353 #, no-wrap msgid "Unsupported Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3386 +#: documentation/content/en/articles/committers-guide/_index.adoc:3357 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:3389 +#: documentation/content/en/articles/committers-guide/_index.adoc:3360 msgid "" "After a platform transitions to unsupported, all support for the platform is " "removed from the source, ports and documentation trees. Note that ports " @@ -7522,13 +7463,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3390 +#: documentation/content/en/articles/committers-guide/_index.adoc:3361 #, no-wrap msgid "Policy on Changing the Tier of an Architecture" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3394 +#: documentation/content/en/articles/committers-guide/_index.adoc:3365 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 " @@ -7538,25 +7479,25 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3396 +#: documentation/content/en/articles/committers-guide/_index.adoc:3367 #, no-wrap msgid "Ports Specific FAQ" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3399 +#: documentation/content/en/articles/committers-guide/_index.adoc:3370 #, no-wrap msgid "Adding a New Port" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3402 +#: documentation/content/en/articles/committers-guide/_index.adoc:3373 #, no-wrap msgid "How do I add a new port?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3406 +#: documentation/content/en/articles/committers-guide/_index.adoc:3377 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 " @@ -7566,20 +7507,20 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3410 +#: documentation/content/en/articles/committers-guide/_index.adoc:3381 #, no-wrap msgid "\tSUBDIR += newport\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3413 +#: documentation/content/en/articles/committers-guide/_index.adoc:3384 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:3418 +#: documentation/content/en/articles/committers-guide/_index.adoc:3389 #, no-wrap msgid "" "% git add category/Makefile category/newport\n" @@ -7588,7 +7529,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3422 +#: documentation/content/en/articles/committers-guide/_index.adoc:3393 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 " @@ -7596,19 +7537,19 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3425 +#: documentation/content/en/articles/committers-guide/_index.adoc:3396 #, 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:3428 +#: documentation/content/en/articles/committers-guide/_index.adoc:3399 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:3431 +#: documentation/content/en/articles/committers-guide/_index.adoc:3402 msgid "" "The extref:{porters-handbook}testing[Porters Handbook's Testing Chapter] " "contains more detailed instructions. See the extref:{porters-handbook}" @@ -7617,14 +7558,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3433 +#: documentation/content/en/articles/committers-guide/_index.adoc:3404 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:3435 +#: documentation/content/en/articles/committers-guide/_index.adoc:3406 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 " @@ -7632,14 +7573,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3438 +#: documentation/content/en/articles/committers-guide/_index.adoc:3409 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:3442 +#: documentation/content/en/articles/committers-guide/_index.adoc:3413 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 " @@ -7647,7 +7588,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3452 +#: documentation/content/en/articles/committers-guide/_index.adoc:3423 #, no-wrap msgid "" "# make install\n" @@ -7660,85 +7601,85 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3455 +#: documentation/content/en/articles/committers-guide/_index.adoc:3426 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:3458 +#: documentation/content/en/articles/committers-guide/_index.adoc:3429 #, no-wrap msgid "Removing an Existing Port" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3461 +#: documentation/content/en/articles/committers-guide/_index.adoc:3432 #, no-wrap msgid "How do I remove an existing port?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3464 +#: documentation/content/en/articles/committers-guide/_index.adoc:3435 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:3466 +#: documentation/content/en/articles/committers-guide/_index.adoc:3437 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:3467 +#: documentation/content/en/articles/committers-guide/_index.adoc:3438 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:3468 +#: documentation/content/en/articles/committers-guide/_index.adoc:3439 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:3472 +#: documentation/content/en/articles/committers-guide/_index.adoc:3443 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:3475 +#: documentation/content/en/articles/committers-guide/_index.adoc:3446 msgid "Then, remove the port:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3479 +#: documentation/content/en/articles/committers-guide/_index.adoc:3450 msgid "Remove the port's files and directory with `git rm`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3480 +#: documentation/content/en/articles/committers-guide/_index.adoc:3451 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:3481 -#: documentation/content/en/articles/committers-guide/_index.adoc:3496 +#: documentation/content/en/articles/committers-guide/_index.adoc:3452 +#: documentation/content/en/articles/committers-guide/_index.adoc:3467 msgid "Add an entry to [.filename]#ports/MOVED#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3482 +#: documentation/content/en/articles/committers-guide/_index.adoc:3453 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:3487 +#: documentation/content/en/articles/committers-guide/_index.adoc:3458 msgid "" "Alternatively, you can use the rmport script, from [.filename]#ports/Tools/" "scripts#. This script was written by {vd}. When sending questions about " @@ -7747,13 +7688,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3489 +#: documentation/content/en/articles/committers-guide/_index.adoc:3460 #, 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:3494 +#: documentation/content/en/articles/committers-guide/_index.adoc:3465 msgid "" "Perform a thorough check of the ports collection for any dependencies on the " "old port location/name, and update them. Running `grep` on [." @@ -7763,14 +7704,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3495 +#: documentation/content/en/articles/committers-guide/_index.adoc:3466 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:3497 +#: documentation/content/en/articles/committers-guide/_index.adoc:3468 msgid "" "Search for entries in xml files inside [.filename]#ports/security/vuxml# and " "adjust them accordingly. In particular, check for previous packages with the " @@ -7778,51 +7719,51 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3498 +#: documentation/content/en/articles/committers-guide/_index.adoc:3469 msgid "Move the port with `git mv`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3499 -#: documentation/content/en/articles/committers-guide/_index.adoc:3510 +#: documentation/content/en/articles/committers-guide/_index.adoc:3470 +#: documentation/content/en/articles/committers-guide/_index.adoc:3481 msgid "Commit the changes." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3502 +#: documentation/content/en/articles/committers-guide/_index.adoc:3473 #, 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:3507 +#: documentation/content/en/articles/committers-guide/_index.adoc:3478 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:3508 +#: documentation/content/en/articles/committers-guide/_index.adoc:3479 msgid "Add the new port to the [.filename]#new-cat/Makefile#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3509 +#: documentation/content/en/articles/committers-guide/_index.adoc:3480 msgid "Change stuff in [.filename]#new-cat/new-port#." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3513 +#: documentation/content/en/articles/committers-guide/_index.adoc:3484 #, no-wrap msgid "Ports Freeze" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3516 +#: documentation/content/en/articles/committers-guide/_index.adoc:3487 #, no-wrap msgid "What is a “ports freeze”?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3523 +#: documentation/content/en/articles/committers-guide/_index.adoc:3494 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 " @@ -7833,39 +7774,39 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3525 +#: documentation/content/en/articles/committers-guide/_index.adoc:3496 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:3527 +#: documentation/content/en/articles/committers-guide/_index.adoc:3498 #, no-wrap msgid "Quarterly Branches" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3530 +#: documentation/content/en/articles/committers-guide/_index.adoc:3501 #, 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:3533 +#: documentation/content/en/articles/committers-guide/_index.adoc:3504 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:3535 +#: documentation/content/en/articles/committers-guide/_index.adoc:3506 #, 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:3538 +#: documentation/content/en/articles/committers-guide/_index.adoc:3509 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 " @@ -7873,7 +7814,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3544 +#: documentation/content/en/articles/committers-guide/_index.adoc:3515 #, no-wrap msgid "" "% git checkout 2021Q2\n" @@ -7883,27 +7824,27 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3548 +#: documentation/content/en/articles/committers-guide/_index.adoc:3519 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 " +"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:3550 +#: documentation/content/en/articles/committers-guide/_index.adoc:3521 #, no-wrap msgid "Creating a New Category" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3553 +#: documentation/content/en/articles/committers-guide/_index.adoc:3524 #, no-wrap msgid "What is the procedure for creating a new category?" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3558 +#: documentation/content/en/articles/committers-guide/_index.adoc:3529 msgid "" "Please see extref:{porters-handbook}[Proposing a New Category, proposing-" "categories] in the Porter's Handbook. Once that procedure has been followed " @@ -7912,42 +7853,42 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3562 +#: documentation/content/en/articles/committers-guide/_index.adoc:3533 msgid "Perform any needed moves. (This only applies to physical categories.)" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3563 +#: documentation/content/en/articles/committers-guide/_index.adoc:3534 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:3564 +#: documentation/content/en/articles/committers-guide/_index.adoc:3535 msgid "Assign the PR back to you." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3567 +#: documentation/content/en/articles/committers-guide/_index.adoc:3538 #, 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:3572 +#: documentation/content/en/articles/committers-guide/_index.adoc:3543 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:3574 +#: documentation/content/en/articles/committers-guide/_index.adoc:3545 msgid "To do this, you will need to:" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3578 +#: documentation/content/en/articles/committers-guide/_index.adoc:3549 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 " @@ -7955,7 +7896,7 @@ msgid "" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3579 +#: documentation/content/en/articles/committers-guide/_index.adoc:3550 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 " @@ -7964,14 +7905,14 @@ msgid "" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3580 +#: documentation/content/en/articles/committers-guide/_index.adoc:3551 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:3583 +#: documentation/content/en/articles/committers-guide/_index.adoc:3554 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 " @@ -7981,7 +7922,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3585 +#: documentation/content/en/articles/committers-guide/_index.adoc:3556 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 " @@ -7991,7 +7932,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3586 +#: documentation/content/en/articles/committers-guide/_index.adoc:3557 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 " @@ -8003,7 +7944,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3587 +#: documentation/content/en/articles/committers-guide/_index.adoc:3558 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 [." @@ -8011,25 +7952,25 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3588 +#: documentation/content/en/articles/committers-guide/_index.adoc:3559 msgid "Add appropriate entries to [.filename]#ports/MOVED#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3589 +#: documentation/content/en/articles/committers-guide/_index.adoc:3560 msgid "Update the documentation by modifying:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3590 -#: documentation/content/en/articles/committers-guide/_index.adoc:3599 +#: documentation/content/en/articles/committers-guide/_index.adoc:3561 +#: documentation/content/en/articles/committers-guide/_index.adoc:3570 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:3592 +#: documentation/content/en/articles/committers-guide/_index.adoc:3563 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 " @@ -8037,38 +7978,38 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3594 +#: documentation/content/en/articles/committers-guide/_index.adoc:3565 #, 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:3597 +#: documentation/content/en/articles/committers-guide/_index.adoc:3568 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:3601 -#: documentation/content/en/articles/committers-guide/_index.adoc:3695 +#: documentation/content/en/articles/committers-guide/_index.adoc:3572 +#: documentation/content/en/articles/committers-guide/_index.adoc:3666 #, no-wrap msgid "Miscellaneous Questions" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3604 +#: documentation/content/en/articles/committers-guide/_index.adoc:3575 #, 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:3607 +#: documentation/content/en/articles/committers-guide/_index.adoc:3578 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:3609 +#: documentation/content/en/articles/committers-guide/_index.adoc:3580 msgid "" "Most infrastructure changes to a port (that is, modernizing, but not " "changing the functionality). For example, the blanket covers converting to " @@ -8077,19 +8018,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3610 +#: documentation/content/en/articles/committers-guide/_index.adoc:3581 msgid "Trivial and _tested_ build and runtime fixes." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3611 +#: documentation/content/en/articles/committers-guide/_index.adoc:3582 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:3616 +#: documentation/content/en/articles/committers-guide/_index.adoc:3587 msgid "" "Exceptions to this are anything maintained by the {portmgr}, or the " "{security-officer}. No unauthorized commits may ever be made to ports " @@ -8097,20 +8038,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3619 +#: documentation/content/en/articles/committers-guide/_index.adoc:3590 #, 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:3623 +#: documentation/content/en/articles/committers-guide/_index.adoc:3594 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:3625 +#: documentation/content/en/articles/committers-guide/_index.adoc:3596 msgid "" "Reports for all the package builds (official, experimental, and non-" "regression) are aggregated at link:pkg-status.FreeBSD.org[pkg-status.FreeBSD." @@ -8118,26 +8059,26 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3627 +#: documentation/content/en/articles/committers-guide/_index.adoc:3598 #, 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:3630 +#: documentation/content/en/articles/committers-guide/_index.adoc:3601 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:3632 +#: documentation/content/en/articles/committers-guide/_index.adoc:3603 #, 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:3636 +#: documentation/content/en/articles/committers-guide/_index.adoc:3607 msgid "" "Any file directly under [.filename]#ports/#, or any file under a " "subdirectory that starts with an uppercase letter ([.filename]#Mk/#, [." @@ -8147,13 +8088,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3638 +#: documentation/content/en/articles/committers-guide/_index.adoc:3609 #, 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:3642 +#: documentation/content/en/articles/committers-guide/_index.adoc:3613 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 " @@ -8166,20 +8107,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3644 +#: documentation/content/en/articles/committers-guide/_index.adoc:3615 #, 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:3648 +#: documentation/content/en/articles/committers-guide/_index.adoc:3619 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:3650 +#: documentation/content/en/articles/committers-guide/_index.adoc:3621 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 " @@ -8187,22 +8128,22 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3654 +#: documentation/content/en/articles/committers-guide/_index.adoc:3625 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:3655 +#: documentation/content/en/articles/committers-guide/_index.adoc:3626 msgid "Select the product your patch is about." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3656 +#: documentation/content/en/articles/committers-guide/_index.adoc:3627 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:3657 +#: documentation/content/en/articles/committers-guide/_index.adoc:3628 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 " @@ -8210,56 +8151,56 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3658 +#: documentation/content/en/articles/committers-guide/_index.adoc:3629 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:3659 +#: documentation/content/en/articles/committers-guide/_index.adoc:3630 msgid "Submit. Wait for the build to run." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3660 +#: documentation/content/en/articles/committers-guide/_index.adoc:3631 msgid "{portmgr} will reply with a possible fallout." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3661 +#: documentation/content/en/articles/committers-guide/_index.adoc:3632 msgid "Depending on the fallout:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3662 +#: documentation/content/en/articles/committers-guide/_index.adoc:3633 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:3663 +#: documentation/content/en/articles/committers-guide/_index.adoc:3634 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:3664 +#: documentation/content/en/articles/committers-guide/_index.adoc:3635 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:3667 +#: documentation/content/en/articles/committers-guide/_index.adoc:3638 #, no-wrap msgid "Issues Specific to Developers Who Are Not Committers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3672 +#: documentation/content/en/articles/committers-guide/_index.adoc:3643 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 " @@ -8268,17 +8209,17 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3674 +#: documentation/content/en/articles/committers-guide/_index.adoc:3645 msgid "<<admin>>" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3675 +#: documentation/content/en/articles/committers-guide/_index.adoc:3646 msgid "<<conventions-everyone>>" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3679 +#: documentation/content/en/articles/committers-guide/_index.adoc:3650 msgid "" "Get your mentor to add you to the \"Additional Contributors\" ([." "filename]#doc/shared/contrib-additional.adoc#), if you are not already " @@ -8286,47 +8227,47 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3681 +#: documentation/content/en/articles/committers-guide/_index.adoc:3652 msgid "<<developer.relations>>" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3682 +#: documentation/content/en/articles/committers-guide/_index.adoc:3653 msgid "<<ssh.guide>>" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3683 +#: documentation/content/en/articles/committers-guide/_index.adoc:3654 msgid "<<rules>>" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3685 +#: documentation/content/en/articles/committers-guide/_index.adoc:3656 #, no-wrap msgid "Information About Google Analytics" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3688 +#: documentation/content/en/articles/committers-guide/_index.adoc:3659 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:3692 +#: documentation/content/en/articles/committers-guide/_index.adoc:3663 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:3697 +#: documentation/content/en/articles/committers-guide/_index.adoc:3668 #, 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:3701 +#: documentation/content/en/articles/committers-guide/_index.adoc:3672 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 " @@ -8335,45 +8276,45 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3702 +#: documentation/content/en/articles/committers-guide/_index.adoc:3673 #, no-wrap msgid "Where are the mailing list archives stored?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3705 +#: documentation/content/en/articles/committers-guide/_index.adoc:3676 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:3706 +#: documentation/content/en/articles/committers-guide/_index.adoc:3677 #, 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:3709 +#: documentation/content/en/articles/committers-guide/_index.adoc:3680 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:3711 +#: documentation/content/en/articles/committers-guide/_index.adoc:3682 #, no-wrap msgid "Benefits and Perks for FreeBSD Committers" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3714 +#: documentation/content/en/articles/committers-guide/_index.adoc:3685 #, no-wrap msgid "Recognition" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3718 +#: documentation/content/en/articles/committers-guide/_index.adoc:3689 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 " @@ -8381,56 +8322,56 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3720 +#: documentation/content/en/articles/committers-guide/_index.adoc:3691 #, no-wrap msgid "FreeBSD Mall" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3723 +#: documentation/content/en/articles/committers-guide/_index.adoc:3694 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:3725 +#: documentation/content/en/articles/committers-guide/_index.adoc:3696 #, no-wrap msgid "`Gandi.net`" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3728 +#: documentation/content/en/articles/committers-guide/_index.adoc:3699 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:3732 +#: documentation/content/en/articles/committers-guide/_index.adoc:3703 msgid "" -"Gandi offers an E-rate discount to all FreeBSD developers. In order 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." +"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:3734 +#: documentation/content/en/articles/committers-guide/_index.adoc:3705 #, no-wrap msgid "`rsync.net`" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3737 +#: documentation/content/en/articles/committers-guide/_index.adoc:3708 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:3739 +#: documentation/content/en/articles/committers-guide/_index.adoc:3710 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." @@ -8438,13 +8379,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3741 +#: documentation/content/en/articles/committers-guide/_index.adoc:3712 #, no-wrap msgid "`JetBrains`" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3744 +#: documentation/content/en/articles/committers-guide/_index.adoc:3715 msgid "" "https://www.jetbrains.com[JetBrains] is a software development company which " "makes tools for software developers and project managers. The company offers " @@ -8453,7 +8394,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3746 +#: documentation/content/en/articles/committers-guide/_index.adoc:3717 msgid "" "JetBrains offers 100 free yearly licenses for all https://www.jetbrains.com/" "products[JetBrains IDE products]. Simply sign up at https://account." @@ -8464,7 +8405,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3750 +#: documentation/content/en/articles/committers-guide/_index.adoc:3721 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 " |