diff options
Diffstat (limited to 'documentation/content/en/articles/committers-guide')
| -rw-r--r-- | documentation/content/en/articles/committers-guide/_index.adoc | 1 | ||||
| -rw-r--r-- | documentation/content/en/articles/committers-guide/_index.po | 1567 |
2 files changed, 810 insertions, 758 deletions
diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index d52aab2ee5..1adfc46e2b 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -199,7 +199,6 @@ The Kerberos password also serves as the LDAP web password, since LDAP is proxyi Some of the services which require this include: * https://bugs.freebsd.org/bugzilla[Bugzilla] -* https://ci.freebsd.org[Jenkins] To create a new Kerberos account in the FreeBSD cluster, or to reset a Kerberos password for an existing account using a random password generator: diff --git a/documentation/content/en/articles/committers-guide/_index.po b/documentation/content/en/articles/committers-guide/_index.po index 1dee22ffb3..9585f882ca 100644 --- a/documentation/content/en/articles/committers-guide/_index.po +++ b/documentation/content/en/articles/committers-guide/_index.po @@ -7,7 +7,7 @@ msgid "" msgstr "" "Project-Id-Version: FreeBSD Documentation VERSION\n" -"POT-Creation-Date: 2025-05-01 19:56-0300\n" +"POT-Creation-Date: 2025-06-29 21:20+0100\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n" "Language-Team: LANGUAGE <LL@li.org>\n" @@ -513,7 +513,7 @@ msgstr "" #. type: Table #: documentation/content/en/articles/committers-guide/_index.adoc:247 #, no-wrap -msgid "core@" +msgid "srcmgr@" msgstr "" #. type: Table @@ -614,7 +614,7 @@ msgstr "" #: documentation/content/en/articles/committers-guide/_index.adoc:271 msgid "" "Committers can acquire an additional bit by the usual process of finding a " -"mentor who will propose them to core, doceng, or portmgr, as appropriate. " +"mentor who will propose them to srcmgr, doceng, or portmgr, as appropriate. " "When approved, they will be added to 'access' and the normal mentoring " "period will ensue, which will involve a continuing of \"Approved by\" for " "some period." @@ -1320,7 +1320,7 @@ msgstr "" #. type: Plain text #: documentation/content/en/articles/committers-guide/_index.adoc:580 -#: documentation/content/en/articles/committers-guide/_index.adoc:1737 +#: documentation/content/en/articles/committers-guide/_index.adoc:1744 #, no-wrap msgid " git checkout -b <new-branch-name>\n" msgstr "" @@ -2036,30 +2036,31 @@ msgstr "" #: documentation/content/en/articles/committers-guide/_index.adoc:1582 #: documentation/content/en/articles/committers-guide/_index.adoc:1611 #: documentation/content/en/articles/committers-guide/_index.adoc:1627 -#: documentation/content/en/articles/committers-guide/_index.adoc:1660 -#: documentation/content/en/articles/committers-guide/_index.adoc:1681 -#: documentation/content/en/articles/committers-guide/_index.adoc:1712 -#: documentation/content/en/articles/committers-guide/_index.adoc:1724 -#: documentation/content/en/articles/committers-guide/_index.adoc:1755 +#: documentation/content/en/articles/committers-guide/_index.adoc:1638 +#: documentation/content/en/articles/committers-guide/_index.adoc:1667 +#: documentation/content/en/articles/committers-guide/_index.adoc:1688 +#: documentation/content/en/articles/committers-guide/_index.adoc:1719 +#: documentation/content/en/articles/committers-guide/_index.adoc:1731 #: documentation/content/en/articles/committers-guide/_index.adoc:1764 -#: documentation/content/en/articles/committers-guide/_index.adoc:1774 -#: documentation/content/en/articles/committers-guide/_index.adoc:1790 -#: documentation/content/en/articles/committers-guide/_index.adoc:1806 +#: documentation/content/en/articles/committers-guide/_index.adoc:1773 +#: documentation/content/en/articles/committers-guide/_index.adoc:1785 +#: documentation/content/en/articles/committers-guide/_index.adoc:1801 #: documentation/content/en/articles/committers-guide/_index.adoc:1817 -#: documentation/content/en/articles/committers-guide/_index.adoc:1824 -#: documentation/content/en/articles/committers-guide/_index.adoc:1837 -#: documentation/content/en/articles/committers-guide/_index.adoc:1857 -#: documentation/content/en/articles/committers-guide/_index.adoc:1871 -#: documentation/content/en/articles/committers-guide/_index.adoc:1887 -#: documentation/content/en/articles/committers-guide/_index.adoc:1899 +#: documentation/content/en/articles/committers-guide/_index.adoc:1828 +#: documentation/content/en/articles/committers-guide/_index.adoc:1835 +#: documentation/content/en/articles/committers-guide/_index.adoc:1848 +#: documentation/content/en/articles/committers-guide/_index.adoc:1868 +#: documentation/content/en/articles/committers-guide/_index.adoc:1882 +#: documentation/content/en/articles/committers-guide/_index.adoc:1906 #: documentation/content/en/articles/committers-guide/_index.adoc:1918 -#: documentation/content/en/articles/committers-guide/_index.adoc:1929 -#: documentation/content/en/articles/committers-guide/_index.adoc:1939 -#: documentation/content/en/articles/committers-guide/_index.adoc:1979 -#: documentation/content/en/articles/committers-guide/_index.adoc:1987 +#: documentation/content/en/articles/committers-guide/_index.adoc:1937 +#: documentation/content/en/articles/committers-guide/_index.adoc:1948 +#: documentation/content/en/articles/committers-guide/_index.adoc:1958 #: documentation/content/en/articles/committers-guide/_index.adoc:1998 -#: documentation/content/en/articles/committers-guide/_index.adoc:2019 -#: documentation/content/en/articles/committers-guide/_index.adoc:2080 +#: documentation/content/en/articles/committers-guide/_index.adoc:2006 +#: documentation/content/en/articles/committers-guide/_index.adoc:2017 +#: documentation/content/en/articles/committers-guide/_index.adoc:2038 +#: documentation/content/en/articles/committers-guide/_index.adoc:2099 #, no-wrap msgid "[source,shell]\n" msgstr "" @@ -3403,9 +3404,9 @@ msgstr "" #: documentation/content/en/articles/committers-guide/_index.adoc:1615 #, no-wrap msgid "" -"% git branch issue # Create the 'issue' branch\n" -"% git reset --hard freebsd/main # Reset 'main' back to the official tip\n" -"% git checkout issue # Back to where you were\n" +"% git checkout -b issue # Create the 'issue' branch\n" +"% git checkout -B main freebsd/main # Reset main to upstream\n" +"% git checkout issue # Back to where you were\n" msgstr "" #. type: Title ===== @@ -3441,21 +3442,29 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1637 +#: documentation/content/en/articles/committers-guide/_index.adoc:1636 +#, no-wrap +msgid "If it is not the last commit, you can cherry-pick that one change from wilma onto fred, then use `git rebase -i` to remove the change from wilma.\n" +msgstr "" + +#. type: Plain text +#: documentation/content/en/articles/committers-guide/_index.adoc:1643 #, no-wrap msgid "" -"Git experts would first rewind the wilma branch by 1 commit, switch over to fred and then use `git reflog` to see what that 1 deleted commit was and\n" -"cherry-pick it over.\n" +"# We're on branch wilma\n" +"% git checkout fred\t\t\t# move to fred branch\n" +"% git cherry-pick HASH_OF_CHANGE\t# copy the misplaced commit\n" +"% git rebase -i main wilma\t\t# drop the cherry-picked change\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1639 +#: documentation/content/en/articles/committers-guide/_index.adoc:1646 #, 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:1645 +#: documentation/content/en/articles/committers-guide/_index.adoc:1652 #, 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" @@ -3466,13 +3475,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1647 +#: documentation/content/en/articles/committers-guide/_index.adoc:1654 #, 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:1653 +#: documentation/content/en/articles/committers-guide/_index.adoc:1660 #, no-wrap msgid "" "**A:** The more general answer would be the same as the previous.\n" @@ -3483,7 +3492,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1658 +#: documentation/content/en/articles/committers-guide/_index.adoc:1665 #, no-wrap msgid "" "The other way to do this would be to checkout `wilma` and then create the branch `fred` to point to the same point in the tree.\n" @@ -3493,7 +3502,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1665 +#: documentation/content/en/articles/committers-guide/_index.adoc:1672 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 " @@ -3501,7 +3510,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1669 +#: documentation/content/en/articles/committers-guide/_index.adoc:1676 #, no-wrap msgid "" "The last step is optional.\n" @@ -3509,7 +3518,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1673 +#: documentation/content/en/articles/committers-guide/_index.adoc:1680 #, 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" @@ -3518,13 +3527,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1675 +#: documentation/content/en/articles/committers-guide/_index.adoc:1682 #, no-wrap msgid "**A:** All is not lost. You can figure out it, so long as it hasn't been too long, or too many commits (hundreds).\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1679 +#: documentation/content/en/articles/committers-guide/_index.adoc:1686 #, no-wrap msgid "" "So I created a wilma branch and committed a couple of things to it, then decided I wanted to split it into fred and wilma.\n" @@ -3533,7 +3542,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1694 +#: documentation/content/en/articles/committers-guide/_index.adoc:1701 msgid "" "% git reflog 6ff9c25 (HEAD -> wilma) HEAD@{0}: rebase -i (finish): returning " "to refs/heads/wilma 6ff9c25 (HEAD -> wilma) HEAD@{1}: rebase -i (start): " @@ -3546,7 +3555,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1702 +#: documentation/content/en/articles/committers-guide/_index.adoc:1709 #, no-wrap msgid "" "Here we see the changes I've made.\n" @@ -3558,7 +3567,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1710 +#: documentation/content/en/articles/committers-guide/_index.adoc:1717 #, no-wrap msgid "" "Next, 'Encourage contributions' was the last commit I made to `wilma` before I decided to split things up.\n" @@ -3571,12 +3580,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1715 +#: documentation/content/en/articles/committers-guide/_index.adoc:1722 msgid "% git checkout -B wilma 869cbd3 % git branch -D fred" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1722 +#: documentation/content/en/articles/committers-guide/_index.adoc:1729 #, no-wrap msgid "" "and you are ready to try again.\n" @@ -3587,12 +3596,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1728 +#: documentation/content/en/articles/committers-guide/_index.adoc:1735 msgid "% git checkout 869cbd3 M\tfaq.md Note: checking out '869cbd3'." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1732 +#: documentation/content/en/articles/committers-guide/_index.adoc:1739 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 " @@ -3600,31 +3609,31 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1735 +#: documentation/content/en/articles/committers-guide/_index.adoc:1742 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:1740 +#: documentation/content/en/articles/committers-guide/_index.adoc:1747 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:1743 +#: documentation/content/en/articles/committers-guide/_index.adoc:1750 #, no-wrap msgid "this produces the same effect, but I have to read a lot more and severed heads aren't an image I like to contemplate.\n" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1744 +#: documentation/content/en/articles/committers-guide/_index.adoc:1751 #, 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:1748 +#: documentation/content/en/articles/committers-guide/_index.adoc:1755 #, no-wrap msgid "" "**Q:** I was on autopilot and did a `git pull` for my development tree and that created a merge commit on `main`.\n" @@ -3632,13 +3641,19 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1750 +#: documentation/content/en/articles/committers-guide/_index.adoc:1757 #, 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:1753 +#: documentation/content/en/articles/committers-guide/_index.adoc:1759 +#, no-wrap +msgid "Many developers use `git pull --rebase` to avoid this situation.\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1762 #, no-wrap msgid "" "Right after the pull, you will have the new merge commit checked out.\n" @@ -3646,7 +3661,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1758 +#: documentation/content/en/articles/committers-guide/_index.adoc:1767 #, no-wrap msgid "" "git log --oneline HEAD^1 # Look at the first parent's commits\n" @@ -3654,7 +3669,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1762 +#: documentation/content/en/articles/committers-guide/_index.adoc:1771 #, no-wrap msgid "" "From those logs, you can easily identify which commit is your development work.\n" @@ -3662,18 +3677,24 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1766 -msgid "git reset --hard HEAD^2" +#: documentation/content/en/articles/committers-guide/_index.adoc:1775 +msgid "git reset --hard HEAD^1" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1778 +#, no-wrap +msgid "In addition, a `git pull --rebase` at this stage will rebase your changes to 'main' to the latest 'freebsd/main'.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1769 +#: documentation/content/en/articles/committers-guide/_index.adoc:1780 #, 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:1772 +#: documentation/content/en/articles/committers-guide/_index.adoc:1783 #, no-wrap msgid "" "**A:** Git keeps track of the remote repository branches in a `freebsd/` namespace.\n" @@ -3681,12 +3702,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1776 +#: documentation/content/en/articles/committers-guide/_index.adoc:1787 msgid "git branch -f main freebsd/main" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1781 +#: documentation/content/en/articles/committers-guide/_index.adoc:1792 #, 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" @@ -3695,13 +3716,13 @@ msgid "" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:1782 +#: documentation/content/en/articles/committers-guide/_index.adoc:1793 #, no-wrap msgid "Mixing and matching branches" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1786 +#: documentation/content/en/articles/committers-guide/_index.adoc:1797 #, no-wrap msgid "" "**Q:** So I have two branches `worker` and `async` that I'd like to combine into one branch called `feature`\n" @@ -3709,20 +3730,20 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1788 +#: documentation/content/en/articles/committers-guide/_index.adoc:1799 #, no-wrap msgid "**A:** This is a job for cherry pick.\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1794 +#: documentation/content/en/articles/committers-guide/_index.adoc:1805 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:1799 +#: documentation/content/en/articles/committers-guide/_index.adoc:1810 #, no-wrap msgid "" "You now have a new branch called `feature`.\n" @@ -3731,13 +3752,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1801 +#: documentation/content/en/articles/committers-guide/_index.adoc:1812 #, 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:1804 +#: documentation/content/en/articles/committers-guide/_index.adoc:1815 #, no-wrap msgid "" "**A:** This takes a little bit of prep work, but `git rebase` will do the heavy\n" @@ -3745,14 +3766,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1810 +#: documentation/content/en/articles/committers-guide/_index.adoc:1821 msgid "" "% git checkout driver\t\t# Checkout the driver % git checkout -b kernel\t# " "Create kernel branch % git checkout -b userland\t# Create userland branch" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1815 +#: documentation/content/en/articles/committers-guide/_index.adoc:1826 #, no-wrap msgid "" "Now you have two identical branches.\n" @@ -3761,29 +3782,29 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1819 +#: documentation/content/en/articles/committers-guide/_index.adoc:1830 msgid "% git rebase -i main kernel" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1822 +#: documentation/content/en/articles/committers-guide/_index.adoc:1833 #, no-wrap msgid "and just include the changes you want (with a 'p' or 'pick' line) and just delete the commits you don't (this sounds scary, but if worse comes to worse, you can throw this all away and start over with the `driver` branch since you've not yet moved it).\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1826 +#: documentation/content/en/articles/committers-guide/_index.adoc:1837 msgid "% git rebase -i main userland" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1829 +#: documentation/content/en/articles/committers-guide/_index.adoc:1840 #, 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:1832 +#: documentation/content/en/articles/committers-guide/_index.adoc:1843 #, no-wrap msgid "" "**Q:** Oh great! I followed the above and forgot a commit in the `kernel` branch.\n" @@ -3791,7 +3812,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1835 +#: documentation/content/en/articles/committers-guide/_index.adoc:1846 #, no-wrap msgid "" "**A:** You can use the `driver` branch to find the hash of the commit is missing and\n" @@ -3799,12 +3820,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1841 +#: documentation/content/en/articles/committers-guide/_index.adoc:1852 msgid "% git checkout kernel % git log driver % git cherry-pick $HASH" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1847 +#: documentation/content/en/articles/committers-guide/_index.adoc:1858 #, no-wrap msgid "" "**Q:** OK. I have the same situation as the above, but my commits are all mixed up.\n" @@ -3814,7 +3835,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1850 +#: documentation/content/en/articles/committers-guide/_index.adoc:1861 #, no-wrap msgid "" "**A:** In this situation, you'd be better off to curate the original branch to separate\n" @@ -3822,7 +3843,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1855 +#: documentation/content/en/articles/committers-guide/_index.adoc:1866 #, no-wrap msgid "" "So let's assume that there's just one commit with a clean tree.\n" @@ -3832,18 +3853,18 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1859 +#: documentation/content/en/articles/committers-guide/_index.adoc:1870 msgid "% git reset HEAD^" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1862 +#: documentation/content/en/articles/committers-guide/_index.adoc:1873 #, no-wrap msgid "Note: Do not, repeat do not, add `--hard` here since that also removes the changes from your tree.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1866 +#: documentation/content/en/articles/committers-guide/_index.adoc:1877 #, no-wrap msgid "" "Now, if you are lucky, the change needing to be split up falls entirely along file lines.\n" @@ -3852,7 +3873,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1869 +#: documentation/content/en/articles/committers-guide/_index.adoc:1880 #, no-wrap msgid "" "If you are not lucky, you'll need to split apart files.\n" @@ -3860,12 +3881,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1873 +#: documentation/content/en/articles/committers-guide/_index.adoc:1884 msgid "git add -i foo/bar.c" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1879 +#: documentation/content/en/articles/committers-guide/_index.adoc:1890 #, no-wrap msgid "" "will step through the diffs, prompting you, one at time, whether to include or exclude the hunk.\n" @@ -3874,31 +3895,52 @@ msgid "" "and use the `git rebase -i` to fold the related commits together).\n" msgstr "" +#. type: Title ===== +#: documentation/content/en/articles/committers-guide/_index.adoc:1891 +#, no-wrap +msgid "Joining the FreeBSD GitHub oranization." +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1894 +#, no-wrap +msgid "**Q:** How do I join the FreeBSD GitHub organization?\n" +msgstr "" + +#. type: delimited block . 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:1898 +#, no-wrap +msgid "" +"**A:** Please see https://wiki.freebsd.org/GitHub#Joining_the_Organisation[our GitHub Wiki Info] page for details.\n" +"Briefly, all FreeBSD committers may join.\n" +"Those who are not committers who request joining will be considered on a case by case basis.\n" +msgstr "" + #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:1880 +#: documentation/content/en/articles/committers-guide/_index.adoc:1899 #, no-wrap msgid "Cloning and Mirroring" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1883 +#: documentation/content/en/articles/committers-guide/_index.adoc:1902 #, 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:1885 +#: documentation/content/en/articles/committers-guide/_index.adoc:1904 #, no-wrap msgid "**A:** If all you want to do is mirror, then\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1889 +#: documentation/content/en/articles/committers-guide/_index.adoc:1908 msgid "% git clone --mirror $URL" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1893 +#: documentation/content/en/articles/committers-guide/_index.adoc:1912 #, no-wrap msgid "" "will do the trick.\n" @@ -3906,7 +3948,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1897 +#: documentation/content/en/articles/committers-guide/_index.adoc:1916 #, no-wrap msgid "" "First, this is a 'bare repository' which has the repository database, but no checked out worktree.\n" @@ -3915,7 +3957,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1905 +#: documentation/content/en/articles/committers-guide/_index.adoc:1924 msgid "" "% git clone --mirror https://git.freebsd.org/ports.git ports.git % cd " "ports.git % git worktree add ../ports main % git worktree add ../quarterly " @@ -3923,13 +3965,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1908 +#: documentation/content/en/articles/committers-guide/_index.adoc:1927 #, no-wrap msgid "But if you aren't using your mirror for further local clones, then it's a poor match.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1911 +#: documentation/content/en/articles/committers-guide/_index.adoc:1930 #, no-wrap msgid "" "The second disadvantage is that Git normally rewrites the refs (branch name, tags, etc) from upstream so that your local refs can evolve independently of upstream.\n" @@ -3937,13 +3979,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1913 +#: documentation/content/en/articles/committers-guide/_index.adoc:1932 #, no-wrap msgid "**Q:** So what can I do instead?\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1916 +#: documentation/content/en/articles/committers-guide/_index.adoc:1935 #, no-wrap msgid "" "**A:** Well, you can stuff all of the upstream repository's refs into a private namespace in your local repository.\n" @@ -3951,19 +3993,19 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1920 +#: documentation/content/en/articles/committers-guide/_index.adoc:1939 #, no-wrap msgid " fetch = +refs/heads/*:refs/remotes/freebsd/*\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1923 +#: documentation/content/en/articles/committers-guide/_index.adoc:1942 #, no-wrap msgid "which says just fetch the branch refs.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1927 +#: documentation/content/en/articles/committers-guide/_index.adoc:1946 #, no-wrap msgid "" "However, the FreeBSD repository has a number of other things in it.\n" @@ -3972,12 +4014,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1931 +#: documentation/content/en/articles/committers-guide/_index.adoc:1950 msgid "git config --add remote.freebsd.fetch '+refs/*:refs/freebsd/*'" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1935 +#: documentation/content/en/articles/committers-guide/_index.adoc:1954 #, no-wrap msgid "" "which will put everything in the upstream repository into your local repository's `refs/freebsd/` namespace.\n" @@ -3985,30 +4027,30 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1937 +#: documentation/content/en/articles/committers-guide/_index.adoc:1956 #, no-wrap msgid "You'll need to refer to these 'refs' with their full name because they aren't in and of Git's regular namespaces.\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1941 +#: documentation/content/en/articles/committers-guide/_index.adoc:1960 msgid "git log refs/freebsd/vendor/zlib/1.2.10" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1944 +#: documentation/content/en/articles/committers-guide/_index.adoc:1963 #, no-wrap msgid "would look at the log for the vendor branch for zlib starting at 1.2.10.\n" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:1945 +#: documentation/content/en/articles/committers-guide/_index.adoc:1964 #, no-wrap msgid "Collaborating with others" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1949 +#: documentation/content/en/articles/committers-guide/_index.adoc:1968 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 " @@ -4020,14 +4062,14 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1951 +#: documentation/content/en/articles/committers-guide/_index.adoc:1970 msgid "" "The following instructions show how to set up a user-generated branch, based " "on the FreeBSD `main` branch, and push it to GitHub." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1954 +#: documentation/content/en/articles/committers-guide/_index.adoc:1973 msgid "" "Before you begin, make sure that your local Git repo is up to date and has " "the correct origins set crossref:committers-guide[keeping_current,as shown " @@ -4035,14 +4077,14 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1961 +#: documentation/content/en/articles/committers-guide/_index.adoc:1980 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:1964 +#: documentation/content/en/articles/committers-guide/_index.adoc:1983 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/" @@ -4051,14 +4093,14 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1967 +#: documentation/content/en/articles/committers-guide/_index.adoc:1986 msgid "" "Now add a remote on your local system that points to your fork: " "[source,shell]" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1974 +#: documentation/content/en/articles/committers-guide/_index.adoc:1993 msgid "" "% git remote add github git@github.com:gvnn3/freebsd-src.git % git remote -v " "github\tgit@github.com:gvnn3/freebsd-src.git (fetch) " @@ -4068,7 +4110,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1977 +#: documentation/content/en/articles/committers-guide/_index.adoc:1996 #, no-wrap msgid "" "With this in place you can create a branch\n" @@ -4076,12 +4118,12 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1981 +#: documentation/content/en/articles/committers-guide/_index.adoc:2000 msgid "% git checkout -b gnn-pr2001-fix" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:1985 +#: documentation/content/en/articles/committers-guide/_index.adoc:2004 #, no-wrap msgid "" "Make whatever modifications you wish in your branch. Build, test, and once you're ready to collaborate with others it's time to push your changes into your hosted branch.\n" @@ -4089,26 +4131,26 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:1991 +#: documentation/content/en/articles/committers-guide/_index.adoc:2010 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:1993 +#: documentation/content/en/articles/committers-guide/_index.adoc:2012 #, 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:1996 +#: documentation/content/en/articles/committers-guide/_index.adoc:2015 #, 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:2012 +#: documentation/content/en/articles/committers-guide/_index.adoc:2031 #, no-wrap msgid "" "% git push --set-upstream github gnn-feature\n" @@ -4127,7 +4169,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2014 +#: documentation/content/en/articles/committers-guide/_index.adoc:2033 #, no-wrap msgid "" "[new branch] gnn-feature -> gnn-feature\n" @@ -4135,13 +4177,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2017 +#: documentation/content/en/articles/committers-guide/_index.adoc:2036 #, no-wrap msgid "Subsequent changes to the same branch will push correctly by default:\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2030 +#: documentation/content/en/articles/committers-guide/_index.adoc:2049 #, no-wrap msgid "" "% git push\n" @@ -4157,7 +4199,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2034 +#: documentation/content/en/articles/committers-guide/_index.adoc:2053 #, no-wrap msgid "" "At this point your work is now in your branch on +GitHub+ and you can\n" @@ -4165,19 +4207,19 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2036 +#: documentation/content/en/articles/committers-guide/_index.adoc:2055 #, no-wrap msgid "[[github-pull-land]]\n" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2036 +#: documentation/content/en/articles/committers-guide/_index.adoc:2055 #, no-wrap msgid "Landing a github pull request" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2041 +#: documentation/content/en/articles/committers-guide/_index.adoc:2060 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 " @@ -4190,7 +4232,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2046 +#: documentation/content/en/articles/committers-guide/_index.adoc:2065 msgid "" "Before beginning, make sure that the local Git repo is up to date and has " "the correct origins set crossref:committers-guide[keeping_current,as shown " @@ -4198,7 +4240,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2052 +#: documentation/content/en/articles/committers-guide/_index.adoc:2071 msgid "" "% git remote -v freebsd https://git.freebsd.org/src.git (fetch) freebsd " "ssh://git@gitrepo.freebsd.org/src.git (push) github https://github.com/" @@ -4207,7 +4249,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2072 +#: documentation/content/en/articles/committers-guide/_index.adoc:2091 #, no-wrap msgid "" "Often pull requests are simple: requests that contain only a single commit.\n" @@ -4232,13 +4274,13 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2074 +#: documentation/content/en/articles/committers-guide/_index.adoc:2093 #, 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:2078 +#: documentation/content/en/articles/committers-guide/_index.adoc:2097 #, no-wrap msgid "" "A polite request to the author for a better name and/or email should be made.\n" @@ -4247,7 +4289,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2090 +#: documentation/content/en/articles/committers-guide/_index.adoc:2109 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 " @@ -4257,7 +4299,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2095 +#: documentation/content/en/articles/committers-guide/_index.adoc:2114 #, no-wrap msgid "" "[.procedure]\n" @@ -4266,7 +4308,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2103 +#: documentation/content/en/articles/committers-guide/_index.adoc:2122 #, no-wrap msgid "" ". checkout the pull request `git checkout github/pull/XXX`\n" @@ -4279,7 +4321,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2108 +#: documentation/content/en/articles/committers-guide/_index.adoc:2127 #, no-wrap msgid "" "This will also work when bringing branches developed elsewhere into the local tree for committing.\n" @@ -4289,24 +4331,24 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2110 +#: documentation/content/en/articles/committers-guide/_index.adoc:2129 #, no-wrap msgid "[[vcs-history]]\n" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2110 +#: documentation/content/en/articles/committers-guide/_index.adoc:2129 #, no-wrap msgid "Version Control History" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2113 +#: documentation/content/en/articles/committers-guide/_index.adoc:2132 msgid "The project has moved to crossref:committers-guide[git-primer,git]." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2119 +#: documentation/content/en/articles/committers-guide/_index.adoc:2138 msgid "" "The FreeBSD source repository switched from CVS to Subversion on May 31st, " "2008. The first real SVN commit is __r179447__. The source repository " @@ -4316,7 +4358,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2125 +#: documentation/content/en/articles/committers-guide/_index.adoc:2144 msgid "" "The FreeBSD `doc/www` repository switched from CVS to Subversion on May " "19th, 2012. The first real SVN commit is __r38821__. The documentation " @@ -4326,7 +4368,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2131 +#: documentation/content/en/articles/committers-guide/_index.adoc:2150 msgid "" "The FreeBSD `ports` repository switched from CVS to Subversion on July 14th, " "2012. The first real SVN commit is __r300894__. The ports repository " @@ -4336,18 +4378,18 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2133 +#: documentation/content/en/articles/committers-guide/_index.adoc:2152 msgid "[[conventions]]" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2133 +#: documentation/content/en/articles/committers-guide/_index.adoc:2152 #, no-wrap msgid "Setup, Conventions, and Traditions" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2138 +#: documentation/content/en/articles/committers-guide/_index.adoc:2157 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 " @@ -4355,25 +4397,25 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2140 +#: documentation/content/en/articles/committers-guide/_index.adoc:2159 msgid "[[conventions-committers]]" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2140 +#: documentation/content/en/articles/committers-guide/_index.adoc:2159 #, no-wrap msgid "For New Committers" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2143 +#: documentation/content/en/articles/committers-guide/_index.adoc:2162 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:2146 +#: documentation/content/en/articles/committers-guide/_index.adoc:2165 #, no-wrap msgid "" "* Get mentor approval before committing each of these changes!\n" @@ -4381,7 +4423,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2151 +#: documentation/content/en/articles/committers-guide/_index.adoc:2170 #, no-wrap msgid "" "[[commit-steps]]\n" @@ -4391,7 +4433,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2198 +#: documentation/content/en/articles/committers-guide/_index.adoc:2217 #, no-wrap msgid "" ". Add an Author Entity\n" @@ -4443,19 +4485,19 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2200 +#: documentation/content/en/articles/committers-guide/_index.adoc:2219 #, no-wrap msgid "[[conventions-everyone]]\n" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2200 +#: documentation/content/en/articles/committers-guide/_index.adoc:2219 #, no-wrap msgid "For Everyone" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2220 +#: documentation/content/en/articles/committers-guide/_index.adoc:2239 msgid "" "[[conventions-everyone-steps]] [.procedure] ==== . Introduce yourself to the " "other developers, otherwise no one will have any idea who you are or what " @@ -4485,25 +4527,25 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2222 +#: documentation/content/en/articles/committers-guide/_index.adoc:2241 msgid "[[smtp-setup]]" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:2222 +#: documentation/content/en/articles/committers-guide/_index.adoc:2241 #, no-wrap msgid "SMTP Access Setup" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2225 +#: documentation/content/en/articles/committers-guide/_index.adoc:2244 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:2247 +#: documentation/content/en/articles/committers-guide/_index.adoc:2266 #, no-wrap msgid "" "[.procedure]\n" @@ -4530,31 +4572,31 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2249 +#: documentation/content/en/articles/committers-guide/_index.adoc:2268 #, no-wrap msgid "[[smtp-setup-local-mta]]\n" msgstr "" #. type: Title ===== -#: documentation/content/en/articles/committers-guide/_index.adoc:2249 +#: documentation/content/en/articles/committers-guide/_index.adoc:2268 #, 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:2252 +#: documentation/content/en/articles/committers-guide/_index.adoc:2271 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:2257 +#: documentation/content/en/articles/committers-guide/_index.adoc:2276 msgid "[[smtp-setup-local-postfix]] .Using Postfix [example] ====" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2259 +#: documentation/content/en/articles/committers-guide/_index.adoc:2278 msgid "" "To tell a local Postfix instance that anything from " "`_yourusername_@FreeBSD.org` should be forwarded to the FreeBSD.org servers, " @@ -4562,12 +4604,12 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2261 +#: documentation/content/en/articles/committers-guide/_index.adoc:2280 msgid "[.programlisting]" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2267 +#: documentation/content/en/articles/committers-guide/_index.adoc:2286 msgid "" "sender_dependent_relayhost_maps = hash:/usr/local/etc/postfix/relayhost_maps " "smtp_sasl_auth_enable = yes smtp_sasl_security_options = noanonymous " @@ -4576,67 +4618,67 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2270 +#: documentation/content/en/articles/committers-guide/_index.adoc:2289 #, no-wrap msgid "Create [.filename]#/usr/local/etc/postfix/relayhost_maps# with the following content:\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2272 -#: documentation/content/en/articles/committers-guide/_index.adoc:2279 -#: documentation/content/en/articles/committers-guide/_index.adoc:2286 -#: documentation/content/en/articles/committers-guide/_index.adoc:2294 -#: documentation/content/en/articles/committers-guide/_index.adoc:2309 -#: documentation/content/en/articles/committers-guide/_index.adoc:2319 -#: documentation/content/en/articles/committers-guide/_index.adoc:2333 -#: documentation/content/en/articles/committers-guide/_index.adoc:2364 +#: documentation/content/en/articles/committers-guide/_index.adoc:2291 +#: documentation/content/en/articles/committers-guide/_index.adoc:2298 +#: documentation/content/en/articles/committers-guide/_index.adoc:2305 +#: documentation/content/en/articles/committers-guide/_index.adoc:2313 +#: documentation/content/en/articles/committers-guide/_index.adoc:2328 +#: documentation/content/en/articles/committers-guide/_index.adoc:2338 +#: documentation/content/en/articles/committers-guide/_index.adoc:2352 +#: documentation/content/en/articles/committers-guide/_index.adoc:2383 #, no-wrap msgid "[.programlisting]\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2274 +#: documentation/content/en/articles/committers-guide/_index.adoc:2293 msgid "yourusername@FreeBSD.org [smtp.freebsd.org]:587" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2277 +#: documentation/content/en/articles/committers-guide/_index.adoc:2296 #, 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:2281 +#: documentation/content/en/articles/committers-guide/_index.adoc:2300 #, no-wrap msgid "[smtp.freebsd.org]:587 yourusername:yourpassword\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2284 +#: documentation/content/en/articles/committers-guide/_index.adoc:2303 #, 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:2289 +#: documentation/content/en/articles/committers-guide/_index.adoc:2308 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:2292 +#: documentation/content/en/articles/committers-guide/_index.adoc:2311 #, 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:2296 +#: documentation/content/en/articles/committers-guide/_index.adoc:2315 msgid "yourusername@FreeBSD.org yourlocalusername" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2300 +#: documentation/content/en/articles/committers-guide/_index.adoc:2319 #, no-wrap msgid "" "Where _yourlocalusername_ is the SASL username used to connect to the local instance of Postfix.\n" @@ -4644,7 +4686,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2305 +#: documentation/content/en/articles/committers-guide/_index.adoc:2324 #, no-wrap msgid "" "[[smtp-setup-local-opensmtpd]]\n" @@ -4654,13 +4696,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2307 +#: documentation/content/en/articles/committers-guide/_index.adoc:2326 #, 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:2312 +#: documentation/content/en/articles/committers-guide/_index.adoc:2331 msgid "" "action \"freebsd\" relay host smtp+tls://freebsd@smtp.freebsd.org:587 auth " "<secrets> match from any auth yourlocalusername mail-from " @@ -4668,24 +4710,24 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2315 +#: documentation/content/en/articles/committers-guide/_index.adoc:2334 #, no-wrap msgid "Where _yourlocalusername_ is the SASL username used to connect to the local instance of OpenSMTPD.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2317 +#: documentation/content/en/articles/committers-guide/_index.adoc:2336 #, 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:2321 +#: documentation/content/en/articles/committers-guide/_index.adoc:2340 msgid "freebsd\tyourusername:yourpassword" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2328 +#: documentation/content/en/articles/committers-guide/_index.adoc:2347 #, no-wrap msgid "" "====\n" @@ -4696,7 +4738,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2331 +#: documentation/content/en/articles/committers-guide/_index.adoc:2350 #, no-wrap msgid "" "To direct a local Exim instance to forward all mail from `_example_@FreeBSD.org`\n" @@ -4704,7 +4746,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2340 +#: documentation/content/en/articles/committers-guide/_index.adoc:2359 #, no-wrap msgid "" "Routers section: (at the top of the list):\n" @@ -4716,7 +4758,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2352 +#: documentation/content/en/articles/committers-guide/_index.adoc:2371 #, no-wrap msgid "" "Transport Section:\n" @@ -4733,7 +4775,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2359 +#: documentation/content/en/articles/committers-guide/_index.adoc:2378 #, no-wrap msgid "" "Authenticators:\n" @@ -4745,36 +4787,36 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2362 +#: documentation/content/en/articles/committers-guide/_index.adoc:2381 #, no-wrap msgid "Create [.filename]#/usr/local/etc/exim/freebsd_send# with the following content:\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2366 +#: documentation/content/en/articles/committers-guide/_index.adoc:2385 msgid "example@freebsd.org:smtp.freebsd.org::587" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2369 +#: documentation/content/en/articles/committers-guide/_index.adoc:2388 #, no-wrap msgid "====\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2371 +#: documentation/content/en/articles/committers-guide/_index.adoc:2390 #, no-wrap msgid "[[mentors]]\n" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2371 +#: documentation/content/en/articles/committers-guide/_index.adoc:2390 #, no-wrap msgid "Mentors" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2376 +#: documentation/content/en/articles/committers-guide/_index.adoc:2395 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 " @@ -4784,7 +4826,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2379 +#: documentation/content/en/articles/committers-guide/_index.adoc:2398 msgid "" "For committers: do not commit anything without first getting mentor " "approval. Document that approval with an `Approved by:` line in the commit " @@ -4792,7 +4834,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2384 +#: documentation/content/en/articles/committers-guide/_index.adoc:2403 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 " @@ -4802,18 +4844,18 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2386 +#: documentation/content/en/articles/committers-guide/_index.adoc:2405 msgid "[[pre-commit-review]]" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2386 +#: documentation/content/en/articles/committers-guide/_index.adoc:2405 #, no-wrap msgid "Pre-Commit Review" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2391 +#: documentation/content/en/articles/committers-guide/_index.adoc:2410 msgid "" "Code review is one way to increase the quality of software. The following " "guidelines apply to commits to the `main` (-CURRENT) branch of the `src` " @@ -4823,7 +4865,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2397 +#: documentation/content/en/articles/committers-guide/_index.adoc:2416 #, no-wrap msgid "" "* All non-trivial changes should be reviewed before they are committed to the repository.\n" @@ -4834,13 +4876,13 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2399 +#: documentation/content/en/articles/committers-guide/_index.adoc:2418 #, no-wrap msgid "Sometimes code reviews will take longer than you would hope for, especially for larger features. Accepted ways to speed up review times for your patches are:\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2406 +#: documentation/content/en/articles/committers-guide/_index.adoc:2425 #, no-wrap msgid "" "* Review other people's patches. If you help out, everybody will be more willing to do the same for you; goodwill is our currency.\n" @@ -4852,7 +4894,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2411 +#: documentation/content/en/articles/committers-guide/_index.adoc:2430 #, no-wrap msgid "" "Developers should participate in code reviews as both reviewers and reviewees.\n" @@ -4862,7 +4904,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2414 +#: documentation/content/en/articles/committers-guide/_index.adoc:2433 #, no-wrap msgid "" "In some cases, no subject-matter expert may be available.\n" @@ -4870,32 +4912,32 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2416 +#: documentation/content/en/articles/committers-guide/_index.adoc:2435 #, no-wrap msgid "[[commit-log-message]]\n" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2416 +#: documentation/content/en/articles/committers-guide/_index.adoc:2435 #, no-wrap msgid "Commit Log Messages" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2419 +#: documentation/content/en/articles/committers-guide/_index.adoc:2438 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:2420 +#: documentation/content/en/articles/committers-guide/_index.adoc:2439 #, no-wrap msgid "Why are commit messages important?" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2424 +#: documentation/content/en/articles/committers-guide/_index.adoc:2443 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 " @@ -4905,7 +4947,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2427 +#: documentation/content/en/articles/committers-guide/_index.adoc:2446 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 " @@ -4913,7 +4955,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2430 +#: documentation/content/en/articles/committers-guide/_index.adoc:2449 msgid "" "FreeBSD has hundreds of active developers and hundreds of thousands of " "commits spanning decades of history. Over that time the developer community " @@ -4922,12 +4964,12 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2432 +#: documentation/content/en/articles/committers-guide/_index.adoc:2451 msgid "Commit messages serve at least three purposes:" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2439 +#: documentation/content/en/articles/committers-guide/_index.adoc:2458 #, no-wrap msgid "" "* Communicating with other developers\n" @@ -4939,7 +4981,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2445 +#: documentation/content/en/articles/committers-guide/_index.adoc:2464 #, no-wrap msgid "" "* Making Changes Discoverable\n" @@ -4950,7 +4992,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2451 +#: documentation/content/en/articles/committers-guide/_index.adoc:2470 #, no-wrap msgid "" "* Providing historical documentation\n" @@ -4961,25 +5003,25 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2453 +#: documentation/content/en/articles/committers-guide/_index.adoc:2472 #, no-wrap msgid "The `git blame` command annotates each line of a source file with the change (hash and subject line) that brought it in.\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2455 +#: documentation/content/en/articles/committers-guide/_index.adoc:2474 #, no-wrap msgid "Having established the importance, here are elements of a good FreeBSD commit message:\n" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2456 +#: documentation/content/en/articles/committers-guide/_index.adoc:2475 #, no-wrap msgid "Start with a subject line" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2460 +#: documentation/content/en/articles/committers-guide/_index.adoc:2479 msgid "" "Commit messages should start with a single-line subject that briefly " "summarizes the change. The subject should, by itself, allow the reader to " @@ -4987,13 +5029,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2461 +#: documentation/content/en/articles/committers-guide/_index.adoc:2480 #, no-wrap msgid "Keep subject lines short" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2466 +#: documentation/content/en/articles/committers-guide/_index.adoc:2485 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 " @@ -5003,86 +5045,86 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2467 +#: documentation/content/en/articles/committers-guide/_index.adoc:2486 #, 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:2470 +#: documentation/content/en/articles/committers-guide/_index.adoc:2489 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:2472 +#: documentation/content/en/articles/committers-guide/_index.adoc:2491 msgid "✓ `foo: Add -k option to keep temporary data`" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2474 +#: documentation/content/en/articles/committers-guide/_index.adoc:2493 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:2475 +#: documentation/content/en/articles/committers-guide/_index.adoc:2494 #, no-wrap msgid "Capitalize the first letter of the subject" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2479 +#: documentation/content/en/articles/committers-guide/_index.adoc:2498 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:2480 +#: documentation/content/en/articles/committers-guide/_index.adoc:2499 #, no-wrap msgid "Do not end the subject line with punctuation" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2484 +#: documentation/content/en/articles/committers-guide/_index.adoc:2503 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:2485 +#: documentation/content/en/articles/committers-guide/_index.adoc:2504 #, 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:2488 +#: documentation/content/en/articles/committers-guide/_index.adoc:2507 msgid "Separate the body from the subject with a blank line." msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2490 +#: documentation/content/en/articles/committers-guide/_index.adoc:2509 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:2492 +#: documentation/content/en/articles/committers-guide/_index.adoc:2511 msgid "✓ `ls: Fix typo in usage text`" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2493 +#: documentation/content/en/articles/committers-guide/_index.adoc:2512 #, no-wrap msgid "Limit messages to 72 columns" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2499 +#: documentation/content/en/articles/committers-guide/_index.adoc:2518 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. " @@ -5093,13 +5135,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2500 +#: documentation/content/en/articles/committers-guide/_index.adoc:2519 #, no-wrap msgid "Use the present tense, imperative mood" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2505 +#: documentation/content/en/articles/committers-guide/_index.adoc:2524 msgid "" "This facilitates short subject lines and provides consistency, including " "with automatically generated commit messages (e.g., as generated by git " @@ -5109,7 +5151,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2510 +#: documentation/content/en/articles/committers-guide/_index.adoc:2529 #, no-wrap msgid "" "✓ `foo: Implement the -k (keep) option`\n" @@ -5119,20 +5161,20 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2511 +#: documentation/content/en/articles/committers-guide/_index.adoc:2530 #, no-wrap msgid "Focus on what and why, not how" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2514 +#: documentation/content/en/articles/committers-guide/_index.adoc:2533 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:2518 +#: documentation/content/en/articles/committers-guide/_index.adoc:2537 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 " @@ -5140,20 +5182,20 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2520 +#: documentation/content/en/articles/committers-guide/_index.adoc:2539 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:2521 +#: documentation/content/en/articles/committers-guide/_index.adoc:2540 #, 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:2524 +#: documentation/content/en/articles/committers-guide/_index.adoc:2543 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. " @@ -5162,13 +5204,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2525 +#: documentation/content/en/articles/committers-guide/_index.adoc:2544 #, no-wrap msgid "Write commit messages for your future self" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2529 +#: documentation/content/en/articles/committers-guide/_index.adoc:2548 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 " @@ -5178,13 +5220,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2530 +#: documentation/content/en/articles/committers-guide/_index.adoc:2549 #, no-wrap msgid "Commit messages should stand alone" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2534 +#: documentation/content/en/articles/committers-guide/_index.adoc:2553 msgid "" "You may include references to mailing list postings, benchmark result web " "sites, or code review links. However, the commit message should contain all " @@ -5193,7 +5235,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2538 +#: documentation/content/en/articles/committers-guide/_index.adoc:2557 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 " @@ -5204,27 +5246,27 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:2539 +#: documentation/content/en/articles/committers-guide/_index.adoc:2558 #, no-wrap msgid "Include appropriate metadata in a footer" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2542 +#: documentation/content/en/articles/committers-guide/_index.adoc:2561 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:2544 +#: documentation/content/en/articles/committers-guide/_index.adoc:2563 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:2546 +#: documentation/content/en/articles/committers-guide/_index.adoc:2565 msgid "" "For key words where multiple values make sense (e.g., `PR:` with a comma-" "separated list of PRs), it is permitted to use the same keyword multiple " @@ -5232,12 +5274,12 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2548 +#: documentation/content/en/articles/committers-guide/_index.adoc:2567 msgid "The key words or phrases are:" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2553 +#: documentation/content/en/articles/committers-guide/_index.adoc:2572 #, no-wrap msgid "" "[.informaltable]\n" @@ -5245,25 +5287,25 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2554 +#: documentation/content/en/articles/committers-guide/_index.adoc:2573 #, no-wrap msgid "`PR:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2556 +#: documentation/content/en/articles/committers-guide/_index.adoc:2575 #, 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:2557 +#: documentation/content/en/articles/committers-guide/_index.adoc:2576 #, no-wrap msgid "`Reported by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2561 +#: documentation/content/en/articles/committers-guide/_index.adoc:2580 #, 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" @@ -5272,7 +5314,7 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2563 +#: documentation/content/en/articles/committers-guide/_index.adoc:2582 #, no-wrap msgid "" "`Submitted by:` +\n" @@ -5280,19 +5322,19 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2565 +#: documentation/content/en/articles/committers-guide/_index.adoc:2584 #, 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:2566 +#: documentation/content/en/articles/committers-guide/_index.adoc:2585 #, no-wrap msgid "`Reviewed by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2581 +#: documentation/content/en/articles/committers-guide/_index.adoc:2600 #, 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" @@ -5311,25 +5353,25 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2582 +#: documentation/content/en/articles/committers-guide/_index.adoc:2601 #, no-wrap msgid "`Tested by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2584 +#: documentation/content/en/articles/committers-guide/_index.adoc:2603 #, 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:2585 +#: documentation/content/en/articles/committers-guide/_index.adoc:2604 #, no-wrap msgid "`Discussed with:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2588 +#: documentation/content/en/articles/committers-guide/_index.adoc:2607 #, no-wrap msgid "" "The name and e-mail address of the person or people that contributed to the patch by providing meaningful feedback; for developers, just the username on the FreeBSD cluster.\n" @@ -5337,13 +5379,13 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2589 +#: documentation/content/en/articles/committers-guide/_index.adoc:2608 #, no-wrap msgid "`Approved by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2615 +#: documentation/content/en/articles/committers-guide/_index.adoc:2634 #, 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" @@ -5372,121 +5414,123 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2616 +#: documentation/content/en/articles/committers-guide/_index.adoc:2635 #, no-wrap msgid "`Obtained from:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2618 +#: documentation/content/en/articles/committers-guide/_index.adoc:2637 #, 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:2619 +#: documentation/content/en/articles/committers-guide/_index.adoc:2638 #, no-wrap msgid "`Fixes:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2621 +#: documentation/content/en/articles/committers-guide/_index.adoc:2641 #, no-wrap -msgid "The Git short hash and the title line of a commit that is fixed by this change as returned by `git log -n 1 --pretty=format:'%h (\"%s\")' GIT-COMMIT-HASH`." +msgid "" +"The Git short hash and the title line of a commit that is fixed by this change as returned by `git log -n 1 --pretty=format:'%h (\"%s\")' GIT-COMMIT-HASH`.\n" +"We include the commit title so that the referenced commit can be located even in the case that a future VCS migration invalidates hash references." msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2622 +#: documentation/content/en/articles/committers-guide/_index.adoc:2642 #, no-wrap msgid "`MFC after:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2624 +#: documentation/content/en/articles/committers-guide/_index.adoc:2644 #, 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:2625 +#: documentation/content/en/articles/committers-guide/_index.adoc:2645 #, no-wrap msgid "`MFC to:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2627 +#: documentation/content/en/articles/committers-guide/_index.adoc:2647 #, 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:2628 +#: documentation/content/en/articles/committers-guide/_index.adoc:2648 #, no-wrap msgid "`MFH:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2630 +#: documentation/content/en/articles/committers-guide/_index.adoc:2650 #, 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:2631 +#: documentation/content/en/articles/committers-guide/_index.adoc:2651 #, no-wrap msgid "`Relnotes:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2633 +#: documentation/content/en/articles/committers-guide/_index.adoc:2653 #, 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:2634 +#: documentation/content/en/articles/committers-guide/_index.adoc:2654 #, no-wrap msgid "`Security:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2636 +#: documentation/content/en/articles/committers-guide/_index.adoc:2656 #, 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:2637 +#: documentation/content/en/articles/committers-guide/_index.adoc:2657 #, no-wrap msgid "`Event:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2639 +#: documentation/content/en/articles/committers-guide/_index.adoc:2659 #, 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:2640 +#: documentation/content/en/articles/committers-guide/_index.adoc:2660 #, no-wrap msgid "`Sponsored by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2642 +#: documentation/content/en/articles/committers-guide/_index.adoc:2662 #, 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:2643 +#: documentation/content/en/articles/committers-guide/_index.adoc:2663 #, no-wrap msgid "`Pull Request:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2647 +#: documentation/content/en/articles/committers-guide/_index.adoc:2667 #, 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" @@ -5495,13 +5539,13 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2648 +#: documentation/content/en/articles/committers-guide/_index.adoc:2668 #, no-wrap msgid "`Co-authored-by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2651 +#: documentation/content/en/articles/committers-guide/_index.adoc:2671 #, no-wrap msgid "" "The name and email address of an additional author of the commit.\n" @@ -5509,73 +5553,73 @@ msgid "" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2652 +#: documentation/content/en/articles/committers-guide/_index.adoc:2672 #, no-wrap msgid "`Signed-off-by:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2654 +#: documentation/content/en/articles/committers-guide/_index.adoc:2674 #, no-wrap msgid "ID certifies compliance with https://developercertificate.org/" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2655 +#: documentation/content/en/articles/committers-guide/_index.adoc:2675 #, no-wrap msgid "`Differential Revision:`" msgstr "" #. type: Table -#: documentation/content/en/articles/committers-guide/_index.adoc:2657 +#: documentation/content/en/articles/committers-guide/_index.adoc:2677 #, 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:2659 +#: documentation/content/en/articles/committers-guide/_index.adoc:2679 #, 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:2665 +#: documentation/content/en/articles/committers-guide/_index.adoc:2685 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:2669 -#: documentation/content/en/articles/committers-guide/_index.adoc:2687 -#: documentation/content/en/articles/committers-guide/_index.adoc:2702 -#: documentation/content/en/articles/committers-guide/_index.adoc:2718 -#: documentation/content/en/articles/committers-guide/_index.adoc:2733 +#: documentation/content/en/articles/committers-guide/_index.adoc:2689 +#: documentation/content/en/articles/committers-guide/_index.adoc:2707 +#: documentation/content/en/articles/committers-guide/_index.adoc:2722 +#: documentation/content/en/articles/committers-guide/_index.adoc:2738 +#: documentation/content/en/articles/committers-guide/_index.adoc:2753 #, no-wrap msgid "...\n" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2671 +#: documentation/content/en/articles/committers-guide/_index.adoc:2691 #, no-wrap msgid "PR:\t\t12345\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2674 +#: documentation/content/en/articles/committers-guide/_index.adoc:2694 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:2677 +#: documentation/content/en/articles/committers-guide/_index.adoc:2697 #, no-wrap msgid "Commit Log for a Commit Needing Review" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2683 +#: documentation/content/en/articles/committers-guide/_index.adoc:2703 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 " @@ -5583,73 +5627,73 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2689 +#: documentation/content/en/articles/committers-guide/_index.adoc:2709 #, no-wrap msgid "Reviewed by:\t-arch\n" msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2693 +#: documentation/content/en/articles/committers-guide/_index.adoc:2713 #, no-wrap msgid "Commit Log for a Commit Needing Approval" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2698 +#: documentation/content/en/articles/committers-guide/_index.adoc:2718 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:2704 +#: documentation/content/en/articles/committers-guide/_index.adoc:2724 #, no-wrap msgid "Approved by:\tabc (maintainer)\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2707 +#: documentation/content/en/articles/committers-guide/_index.adoc:2727 msgid "Where _abc_ is the account name of the person who approved." msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2709 +#: documentation/content/en/articles/committers-guide/_index.adoc:2729 #, 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:2714 +#: documentation/content/en/articles/committers-guide/_index.adoc:2734 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:2720 +#: documentation/content/en/articles/committers-guide/_index.adoc:2740 #, no-wrap msgid "Obtained from:\tOpenBSD\n" msgstr "" #. type: Block title -#: documentation/content/en/articles/committers-guide/_index.adoc:2724 +#: documentation/content/en/articles/committers-guide/_index.adoc:2744 #, 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:2729 +#: documentation/content/en/articles/committers-guide/_index.adoc:2749 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:2735 +#: documentation/content/en/articles/committers-guide/_index.adoc:2755 #, no-wrap msgid "MFC after:\t2 weeks\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2738 +#: documentation/content/en/articles/committers-guide/_index.adoc:2758 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`, " @@ -5657,12 +5701,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2741 +#: documentation/content/en/articles/committers-guide/_index.adoc:2761 msgid "It is often necessary to combine these." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2745 +#: documentation/content/en/articles/committers-guide/_index.adoc:2765 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 " @@ -5672,19 +5716,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2747 +#: documentation/content/en/articles/committers-guide/_index.adoc:2767 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:2748 +#: documentation/content/en/articles/committers-guide/_index.adoc:2768 #, no-wrap msgid "Example Combined Commit Log" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2759 +#: documentation/content/en/articles/committers-guide/_index.adoc:2779 #, no-wrap msgid "" "PR:\t\t54321\n" @@ -5695,13 +5739,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2764 +#: documentation/content/en/articles/committers-guide/_index.adoc:2784 #, no-wrap msgid "Preferred License for New Files" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2770 +#: documentation/content/en/articles/committers-guide/_index.adoc:2790 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/" @@ -5711,14 +5755,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2772 +#: documentation/content/en/articles/committers-guide/_index.adoc:2792 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:2803 +#: documentation/content/en/articles/committers-guide/_index.adoc:2823 #, no-wrap msgid "" "/*\n" @@ -5752,7 +5796,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2809 +#: documentation/content/en/articles/committers-guide/_index.adoc:2829 msgid "" "The FreeBSD project strongly discourages the so-called \"advertising " "clause\" in new code. Due to the large number of contributors to the " @@ -5763,7 +5807,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2813 +#: documentation/content/en/articles/committers-guide/_index.adoc:2833 msgid "" "The FreeBSD project discourages completely new licenses and variations on " "the standard licenses. New licenses require the approval of {core-email} to " @@ -5774,7 +5818,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2817 +#: documentation/content/en/articles/committers-guide/_index.adoc:2837 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 " @@ -5785,7 +5829,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2820 +#: documentation/content/en/articles/committers-guide/_index.adoc:2840 msgid "" "Developers are reminded that in open source, getting \"open\" right is just " "as important as getting \"source\" right, as improper handling of " @@ -5794,13 +5838,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2822 +#: documentation/content/en/articles/committers-guide/_index.adoc:2842 #, no-wrap msgid "Keeping Track of Licenses Granted to the FreeBSD Project" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2827 +#: documentation/content/en/articles/committers-guide/_index.adoc:2847 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 " @@ -5811,7 +5855,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2832 +#: documentation/content/en/articles/committers-guide/_index.adoc:2852 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 " @@ -5821,13 +5865,13 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2834 +#: documentation/content/en/articles/committers-guide/_index.adoc:2854 msgid "" "Contact details for people or organizations granting the special license." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2835 +#: documentation/content/en/articles/committers-guide/_index.adoc:2855 msgid "" "What files, directories etc. in the repositories are covered by the license " "grant including the revision numbers where any specially licensed material " @@ -5835,7 +5879,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2836 +#: documentation/content/en/articles/committers-guide/_index.adoc:2856 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 " @@ -5843,24 +5887,24 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2837 +#: documentation/content/en/articles/committers-guide/_index.adoc:2857 msgid "The license text." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2838 +#: documentation/content/en/articles/committers-guide/_index.adoc:2858 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:2839 +#: documentation/content/en/articles/committers-guide/_index.adoc:2859 msgid "Any other relevant information." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2842 +#: documentation/content/en/articles/committers-guide/_index.adoc:2862 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 " @@ -5870,7 +5914,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2845 +#: documentation/content/en/articles/committers-guide/_index.adoc:2865 msgid "" "The license archive should contain only details of license grants; this is " "not the place for any discussions around licensing or other subjects. " @@ -5879,13 +5923,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2847 +#: documentation/content/en/articles/committers-guide/_index.adoc:2867 #, no-wrap msgid "SPDX Tags in the tree" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2858 +#: documentation/content/en/articles/committers-guide/_index.adoc:2878 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 " @@ -5904,20 +5948,20 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2860 +#: documentation/content/en/articles/committers-guide/_index.adoc:2880 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:2861 +#: documentation/content/en/articles/committers-guide/_index.adoc:2881 #, no-wrap msgid "Developer Relations" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2867 +#: documentation/content/en/articles/committers-guide/_index.adoc:2887 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 " @@ -5930,7 +5974,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2871 +#: documentation/content/en/articles/committers-guide/_index.adoc:2891 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 " @@ -5941,27 +5985,27 @@ msgid "" msgstr "" #. type: delimited block - 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2875 +#: documentation/content/en/articles/committers-guide/_index.adoc:2895 #, 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:2878 +#: documentation/content/en/articles/committers-guide/_index.adoc:2898 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:2883 +#: documentation/content/en/articles/committers-guide/_index.adoc:2903 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:2889 +#: documentation/content/en/articles/committers-guide/_index.adoc:2909 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 " @@ -5972,7 +6016,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2893 +#: documentation/content/en/articles/committers-guide/_index.adoc:2913 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 " @@ -5982,7 +6026,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2896 +#: documentation/content/en/articles/committers-guide/_index.adoc:2916 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 " @@ -5990,7 +6034,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2902 +#: documentation/content/en/articles/committers-guide/_index.adoc:2922 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 " @@ -5999,7 +6043,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2906 +#: documentation/content/en/articles/committers-guide/_index.adoc:2926 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 " @@ -6007,20 +6051,20 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2908 +#: documentation/content/en/articles/committers-guide/_index.adoc:2928 #, no-wrap msgid "If in Doubt..." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2912 +#: documentation/content/en/articles/committers-guide/_index.adoc:2932 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:2916 +#: documentation/content/en/articles/committers-guide/_index.adoc:2936 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 " @@ -6028,32 +6072,32 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2918 +#: documentation/content/en/articles/committers-guide/_index.adoc:2938 msgid "For project specific or administrative questions ask, in order:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2920 +#: documentation/content/en/articles/committers-guide/_index.adoc:2940 msgid "Your mentor or former mentor." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2921 +#: documentation/content/en/articles/committers-guide/_index.adoc:2941 msgid "An experienced committer on IRC, email, etc." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2922 +#: documentation/content/en/articles/committers-guide/_index.adoc:2942 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:2923 +#: documentation/content/en/articles/committers-guide/_index.adoc:2943 msgid "If still not sure, ask on {developers-name}." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2925 +#: documentation/content/en/articles/committers-guide/_index.adoc:2945 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 " @@ -6061,13 +6105,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2927 +#: documentation/content/en/articles/committers-guide/_index.adoc:2947 #, no-wrap msgid "Bugzilla" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2932 +#: documentation/content/en/articles/committers-guide/_index.adoc:2952 msgid "" "The FreeBSD Project utilizes Bugzilla for tracking bugs and change " "requests. If you commit a fix or suggestion found in the PR database, be " @@ -6076,26 +6120,26 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2934 +#: documentation/content/en/articles/committers-guide/_index.adoc:2954 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:2938 +#: documentation/content/en/articles/committers-guide/_index.adoc:2958 msgid "Log in using your old account." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2939 +#: documentation/content/en/articles/committers-guide/_index.adoc:2959 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:2941 +#: documentation/content/en/articles/committers-guide/_index.adoc:2961 msgid "" "Log in using `FreeBSD.org` account and post comment to newly opened bug to " "confirm ownership. See crossref:committers-guide[kerberos-ldap, Kerberos and " @@ -6104,35 +6148,35 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2942 +#: documentation/content/en/articles/committers-guide/_index.adoc:2962 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:2945 +#: documentation/content/en/articles/committers-guide/_index.adoc:2965 msgid "You can find out more about Bugzilla at:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2947 +#: documentation/content/en/articles/committers-guide/_index.adoc:2967 msgid "extref:{pr-guidelines}[FreeBSD Problem Report Handling Guidelines]" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2948 +#: documentation/content/en/articles/committers-guide/_index.adoc:2968 msgid "link:https://www.FreeBSD.org/support/[https://www.FreeBSD.org/support]" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2950 +#: documentation/content/en/articles/committers-guide/_index.adoc:2970 #, no-wrap msgid "Phabricator" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2954 +#: documentation/content/en/articles/committers-guide/_index.adoc:2974 msgid "" "The FreeBSD Project utilizes https://reviews.freebsd.org[Phabricator] for " "code review requests. See the https://wiki.freebsd.org/" @@ -6140,19 +6184,19 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2956 +#: documentation/content/en/articles/committers-guide/_index.adoc:2976 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:2960 +#: documentation/content/en/articles/committers-guide/_index.adoc:2980 msgid "Change your Phabricator account email to your `FreeBSD.org` email." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2962 +#: documentation/content/en/articles/committers-guide/_index.adoc:2982 msgid "" "Open new bug on our bug tracker using your `FreeBSD.org` account, see " "crossref:committers-guide[bugzilla, Bugzilla] for more information. Choose " @@ -6163,19 +6207,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:2967 +#: documentation/content/en/articles/committers-guide/_index.adoc:2987 msgid "" "Phabricator accounts cannot be merged, please do not open a new account." msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:2970 +#: documentation/content/en/articles/committers-guide/_index.adoc:2990 #, no-wrap msgid "Who's Who" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2973 +#: documentation/content/en/articles/committers-guide/_index.adoc:2993 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. " @@ -6183,13 +6227,13 @@ msgid "" msgstr "" #. type: Labeled list -#: documentation/content/en/articles/committers-guide/_index.adoc:2974 +#: documentation/content/en/articles/committers-guide/_index.adoc:2994 #, no-wrap msgid "`{doceng}`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2980 +#: documentation/content/en/articles/committers-guide/_index.adoc:3000 msgid "" "doceng is the group responsible for the documentation build infrastructure, " "approving new documentation committers, and ensuring that the FreeBSD " @@ -6203,13 +6247,13 @@ msgid "" msgstr "" #. type: Labeled list -#: documentation/content/en/articles/committers-guide/_index.adoc:2981 +#: documentation/content/en/articles/committers-guide/_index.adoc:3001 #, no-wrap msgid "`{re-members}`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2986 +#: documentation/content/en/articles/committers-guide/_index.adoc:3006 msgid "" "These are the members of the `{re}`. This team is responsible for setting " "release deadlines and controlling the release process. During code freezes, " @@ -6220,20 +6264,20 @@ msgid "" msgstr "" #. type: Labeled list -#: documentation/content/en/articles/committers-guide/_index.adoc:2987 +#: documentation/content/en/articles/committers-guide/_index.adoc:3007 #, no-wrap msgid "`{so}`" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2989 +#: documentation/content/en/articles/committers-guide/_index.adoc:3009 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:2994 +#: documentation/content/en/articles/committers-guide/_index.adoc:3014 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 " @@ -6242,7 +6286,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:2999 +#: documentation/content/en/articles/committers-guide/_index.adoc:3019 msgid "" "{developers-name}:: All committers are subscribed to -developers. This list " "was created to be a forum for the committers \"community\" issues. Examples " @@ -6250,7 +6294,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3003 +#: documentation/content/en/articles/committers-guide/_index.adoc:3023 msgid "" "The {developers-name} is for the exclusive use of FreeBSD committers. To " "develop FreeBSD, committers must have the ability to openly discuss matters " @@ -6260,7 +6304,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3007 +#: documentation/content/en/articles/committers-guide/_index.adoc:3027 msgid "" "All FreeBSD committers are expected not to not publish or forward messages " "from the {developers-name} outside the list membership without permission of " @@ -6270,7 +6314,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3013 +#: documentation/content/en/articles/committers-guide/_index.adoc:3033 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 " @@ -6283,13 +6327,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3014 +#: documentation/content/en/articles/committers-guide/_index.adoc:3034 #, no-wrap msgid "SSH Quick-Start Guide" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3019 +#: documentation/content/en/articles/committers-guide/_index.adoc:3039 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 " @@ -6300,19 +6344,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3020 +#: documentation/content/en/articles/committers-guide/_index.adoc:3040 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:3024 +#: documentation/content/en/articles/committers-guide/_index.adoc:3044 msgid "Only ECDSA, Ed25519 or RSA keys are supported." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3026 +#: documentation/content/en/articles/committers-guide/_index.adoc:3046 msgid "" "Send your public key ([.filename]#$HOME/.ssh/id_ecdsa.pub#, " "[.filename]#$HOME/.ssh/id_ed25519.pub#, or [.filename]#$HOME/.ssh/" @@ -6321,7 +6365,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3031 +#: documentation/content/en/articles/committers-guide/_index.adoc:3051 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 " @@ -6330,32 +6374,32 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3033 +#: documentation/content/en/articles/committers-guide/_index.adoc:3053 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:3035 +#: documentation/content/en/articles/committers-guide/_index.adoc:3055 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:3037 +#: documentation/content/en/articles/committers-guide/_index.adoc:3057 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:3039 +#: documentation/content/en/articles/committers-guide/_index.adoc:3059 #, no-wrap msgid "Coverity(R) Availability for FreeBSD Committers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3043 +#: documentation/content/en/articles/committers-guide/_index.adoc:3063 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 " @@ -6364,7 +6408,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3046 +#: documentation/content/en/articles/committers-guide/_index.adoc:3066 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/" @@ -6375,7 +6419,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3048 +#: documentation/content/en/articles/committers-guide/_index.adoc:3068 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 " @@ -6383,13 +6427,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3050 +#: documentation/content/en/articles/committers-guide/_index.adoc:3070 #, no-wrap msgid "The FreeBSD Committers' Big List of Rules" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3055 +#: documentation/content/en/articles/committers-guide/_index.adoc:3075 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-" @@ -6400,25 +6444,25 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3057 -#: documentation/content/en/articles/committers-guide/_index.adoc:3087 +#: documentation/content/en/articles/committers-guide/_index.adoc:3077 +#: documentation/content/en/articles/committers-guide/_index.adoc:3107 msgid "Respect other committers." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3058 -#: documentation/content/en/articles/committers-guide/_index.adoc:3103 +#: documentation/content/en/articles/committers-guide/_index.adoc:3078 +#: documentation/content/en/articles/committers-guide/_index.adoc:3123 msgid "Respect other contributors." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3059 -#: documentation/content/en/articles/committers-guide/_index.adoc:3118 +#: documentation/content/en/articles/committers-guide/_index.adoc:3079 +#: documentation/content/en/articles/committers-guide/_index.adoc:3138 msgid "Discuss any significant change _before_ committing." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3060 +#: documentation/content/en/articles/committers-guide/_index.adoc:3080 msgid "" "Respect existing maintainers (if listed in the `MAINTAINER` field in " "[.filename]#Makefile# or in [.filename]#MAINTAINER# in the top-level " @@ -6426,8 +6470,8 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3061 -#: documentation/content/en/articles/committers-guide/_index.adoc:3133 +#: documentation/content/en/articles/committers-guide/_index.adoc:3081 +#: documentation/content/en/articles/committers-guide/_index.adoc:3153 msgid "" "Any disputed change must be backed out pending resolution of the dispute if " "requested by a maintainer. Security related changes may override a " @@ -6435,7 +6479,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3062 +#: documentation/content/en/articles/committers-guide/_index.adoc:3082 msgid "" "Changes go to FreeBSD-CURRENT before FreeBSD-STABLE unless specifically " "permitted by the release engineer or unless they are not applicable to " @@ -6447,40 +6491,40 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3063 -#: documentation/content/en/articles/committers-guide/_index.adoc:3148 +#: documentation/content/en/articles/committers-guide/_index.adoc:3083 +#: documentation/content/en/articles/committers-guide/_index.adoc:3168 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:3064 +#: documentation/content/en/articles/committers-guide/_index.adoc:3084 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:3065 -#: documentation/content/en/articles/committers-guide/_index.adoc:3163 +#: documentation/content/en/articles/committers-guide/_index.adoc:3085 +#: documentation/content/en/articles/committers-guide/_index.adoc:3183 msgid "When in doubt on any procedure, ask first!" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3066 -#: documentation/content/en/articles/committers-guide/_index.adoc:3168 +#: documentation/content/en/articles/committers-guide/_index.adoc:3086 +#: documentation/content/en/articles/committers-guide/_index.adoc:3188 msgid "Test your changes before committing them." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3067 -#: documentation/content/en/articles/committers-guide/_index.adoc:3178 +#: documentation/content/en/articles/committers-guide/_index.adoc:3087 +#: documentation/content/en/articles/committers-guide/_index.adoc:3198 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:3078 +#: documentation/content/en/articles/committers-guide/_index.adoc:3098 msgid "" "As noted, breaking some of these rules can be grounds for suspension or, " "upon repeated offense, permanent removal of commit privileges. Individual " @@ -6506,7 +6550,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3082 +#: documentation/content/en/articles/committers-guide/_index.adoc:3102 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 " @@ -6517,13 +6561,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3083 +#: documentation/content/en/articles/committers-guide/_index.adoc:3103 #, no-wrap msgid "Details" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3091 +#: documentation/content/en/articles/committers-guide/_index.adoc:3111 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 " @@ -6535,7 +6579,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3093 +#: documentation/content/en/articles/committers-guide/_index.adoc:3113 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 " @@ -6545,7 +6589,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3099 +#: documentation/content/en/articles/committers-guide/_index.adoc:3119 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 " @@ -6564,7 +6608,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3102 +#: documentation/content/en/articles/committers-guide/_index.adoc:3122 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 " @@ -6572,7 +6616,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3115 +#: documentation/content/en/articles/committers-guide/_index.adoc:3135 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 " @@ -6586,14 +6630,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3117 +#: documentation/content/en/articles/committers-guide/_index.adoc:3137 msgid "" "Consider the points raised under crossref:committers-guide[respect,Respect " "other committers] and apply them also to contributors." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3124 +#: documentation/content/en/articles/committers-guide/_index.adoc:3144 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 " @@ -6609,17 +6653,17 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3126 +#: documentation/content/en/articles/committers-guide/_index.adoc:3146 msgid "When in doubt, ask for review!" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3127 +#: documentation/content/en/articles/committers-guide/_index.adoc:3147 msgid "Respect existing maintainers if listed." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3132 +#: documentation/content/en/articles/committers-guide/_index.adoc:3152 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, " @@ -6635,7 +6679,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3138 +#: documentation/content/en/articles/committers-guide/_index.adoc:3158 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 " @@ -6653,7 +6697,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3139 +#: documentation/content/en/articles/committers-guide/_index.adoc:3159 msgid "" "Changes go to FreeBSD-CURRENT before FreeBSD-STABLE unless specifically " "permitted by the release engineer or unless they are not applicable to " @@ -6664,7 +6708,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3145 +#: documentation/content/en/articles/committers-guide/_index.adoc:3165 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 " @@ -6683,7 +6727,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3147 +#: documentation/content/en/articles/committers-guide/_index.adoc:3167 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 " @@ -6691,7 +6735,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3158 +#: documentation/content/en/articles/committers-guide/_index.adoc:3178 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. " @@ -6716,14 +6760,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3159 +#: documentation/content/en/articles/committers-guide/_index.adoc:3179 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:3162 +#: documentation/content/en/articles/committers-guide/_index.adoc:3182 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 " @@ -6734,7 +6778,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3167 +#: documentation/content/en/articles/committers-guide/_index.adoc:3187 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, " @@ -6746,30 +6790,30 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3177 +#: documentation/content/en/articles/committers-guide/_index.adoc:3197 msgid "" "If your changes are to the kernel, make sure you can still compile both " "GENERIC and LINT. If your changes are anywhere else, make sure you can " -"still make world. If your changes are to a branch, make sure your testing " -"occurs with a machine which is running that code. If you have a change " -"which also may break another architecture, be sure and test on all supported " -"architectures. Please ensure your change works for crossref:committers-" -"guide[compilers,supported toolchains]. Please refer to the https://" -"www.FreeBSD.org/internal/[FreeBSD Internal Page] for a list of available " -"resources. As other architectures are added to the FreeBSD supported " -"platforms list, the appropriate shared testing resources will be made " -"available." +"still compile userspace via `make buildworld`. If your changes are to a " +"branch, make sure your testing occurs with a machine which is running that " +"code. If you have a change which also may break another architecture, be " +"sure and test on all supported architectures. Please ensure your change " +"works for crossref:committers-guide[compilers,supported toolchains]. Please " +"refer to the https://www.FreeBSD.org/internal/[FreeBSD Internal Page] for a " +"list of available resources. As other architectures are added to the " +"FreeBSD supported platforms list, the appropriate shared testing resources " +"will be made available." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3180 +#: documentation/content/en/articles/committers-guide/_index.adoc:3200 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:3185 +#: documentation/content/en/articles/committers-guide/_index.adoc:3205 msgid "" "The trees mentioned above are for contributed software usually imported onto " "a vendor branch. Committing something there may cause unnecessary headaches " @@ -6779,7 +6823,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3189 +#: documentation/content/en/articles/committers-guide/_index.adoc:3209 msgid "" "Reasons for modifying upstream software range from wanting strict control " "over a tightly coupled dependency to lack of portability in the canonical " @@ -6791,7 +6835,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3192 +#: documentation/content/en/articles/committers-guide/_index.adoc:3212 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 " @@ -6799,32 +6843,27 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3193 +#: documentation/content/en/articles/committers-guide/_index.adoc:3213 #, no-wrap msgid "Policy on Multiple Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3197 +#: documentation/content/en/articles/committers-guide/_index.adoc:3216 msgid "" -"FreeBSD has added several new architecture ports during recent release " -"cycles and is truly no longer an i386(TM) centric operating system. In an " -"effort to make it easier to keep FreeBSD portable across the platforms we " -"support, core has developed this mandate:" +"In an effort to make it easier to keep FreeBSD portable across the platforms " +"we support, core has developed this mandate:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3201 +#: documentation/content/en/articles/committers-guide/_index.adoc:3219 msgid "" -"Our 32-bit reference platform is i386, and our 64-bit reference platform is " -"amd64. Major design work (including major API and ABI changes) must prove " -"itself on at least one 32-bit and at least one 64-bit platform, preferably " -"the primary reference platforms, before it may be committed to the source " -"tree." +"Major design work (including major API and ABI changes) must prove itself on " +"at least one Tier 1 platform before it may be committed to the source tree." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3205 +#: documentation/content/en/articles/committers-guide/_index.adoc:3223 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 " @@ -6835,72 +6874,79 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3207 +#: documentation/content/en/articles/committers-guide/_index.adoc:3225 #, no-wrap msgid "Policy on Multiple Compilers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3221 +#: documentation/content/en/articles/committers-guide/_index.adoc:3239 msgid "" -"FreeBSD builds with both Clang and GCC. The project does this in a careful " -"and controlled way to maximize benefits from this extra work, while keeping " -"the extra work to a minimum. Supporting both Clang and GCC improves the " -"flexibility our users have. These compilers have different strengths and " -"weaknesses, and supporting both allows users to pick the best one for their " -"needs. Clang and GCC support similar dialects of C and C++, necessitating a " -"relatively small amount of conditional code. The project gains increased " -"code coverage and improves the code quality by using features from both " -"compilers. The project is able to build in more user environments and " -"leverage more CI environments by supporting this range, increasing " -"convenience for users and giving them more tools to test with. By carefully " -"constraining the range of versions supported to modern versions of these " -"compilers, the project avoids unduly increasing the testing matrix. Older " -"and obscure compilers, as well as older dialects of the languages, have " -"extremely limited support that allow user programs to build with them, but " -"without constraining the base system to being built with them. The exact " -"balance continues to evolve to ensure the benefits of extra work remain " -"greater than the burdens it imposes. The project used to support really old " -"Intel compilers or old GCC versions, but we traded supporting those obsolete " -"compilers for a carefully selected range of modern compilers. This section " -"documents where we use different compilers, and the expectations around that." +"The FreeBSD base system builds with both Clang and GCC. The project does " +"this in a careful and controlled way to maximize benefits from this extra " +"work, while keeping the extra work to a minimum. Supporting both Clang and " +"GCC improves the flexibility our users have. These compilers have different " +"strengths and weaknesses, and supporting both allows users to pick the best " +"one for their needs. Clang and GCC support similar dialects of C and C++, " +"necessitating a relatively small amount of conditional code. The project " +"gains increased code coverage and improves the code quality by using " +"features from both compilers. The project is able to build in more user " +"environments and leverage more CI environments by supporting this range, " +"increasing convenience for users and giving them more tools to test with. " +"By carefully constraining the range of versions supported to modern versions " +"of these compilers, the project avoids unduly increasing the testing " +"matrix. Older and obscure compilers, as well as older dialects of the " +"languages, have extremely limited support that allow user programs to build " +"with them, but without constraining the base system to being built with " +"them. The exact balance continues to evolve to ensure the benefits of extra " +"work remain greater than the burdens it imposes. The project used to " +"support really old Intel compilers or old GCC versions, but we traded " +"supporting those obsolete compilers for a carefully selected range of modern " +"compilers. This section documents where we use different compilers, and the " +"expectations around that." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3226 +#: documentation/content/en/articles/committers-guide/_index.adoc:3244 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 " +"The FreeBSD base system includes an in-tree Clang compiler. Due to being in " +"the tree, this compiler is the most supported compiler. All changes must " "compile with it, prior to commit. Complete testing, as appropriate for the " "change, should be done with this compiler." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3234 +#: documentation/content/en/articles/committers-guide/_index.adoc:3259 msgid "" -"At any moment in time, the FreeBSD project also supports one or more out-of-" -"tree compilers. At present, this is GCC 12.x. Ideally, committers should " -"test compile with this compiler, especially for large or risky changes. " -"This compiler is available as the `${TARGET_ARCH}-gcc${VERSION}` package, " -"such as package:devel/freebsd-gcc12@aarch64[aarch64-gcc12] or package:devel/" -"freebsd-gcc12@riscv64[riscv64-gcc12]. The project runs automated CI jobs to " -"build everything with these compilers. Committers are expected to fix the " -"jobs they break with their changes. Committers may test build with, for " -"example `CROSS_TOOLCHAIN=aarch64-gcc12` or `CROSS_TOOLCHAIN=llvm15` where " -"necessary." +"The FreeBSD base system also supports various versions of Clang and GCC as " +"out-of-tree compilers. For large or risky changes, committers should do a " +"test build with a supported version of GCC. Out of tree compilers are " +"available as packages. GCC compilers are available as `${TARGET_ARCH}-gcc$" +"{VERSION}` packages, such as package:devel/freebsd-gcc14@aarch64[aarch64-" +"gcc14]. Clang compilers are available as `llvm${VERSION}` packages, such as " +"package:devel/llvm18[llvm18]. The project runs automated CI jobs to build " +"everything with these compilers. Committers are expected to fix the jobs " +"they break with their changes. Committers may test builds of userspace or " +"individual kernels by setting `CROSS_TOOLCHAIN` to the package name, for " +"example `CROSS_TOOLCHAIN=aarch64-gcc14` or `CROSS_TOOLCHAIN=llvm18`. For " +"universe or tinderbox builds, `USE_GCC_TOOLCHAINS=gcc${VERSION}` builds all " +"architectures using the appropriate GCC compiler packages. For universe or " +"tinderbox builds using an out-of-tree Clang, pass `CROSS_TOOLCHAIN=llvm$" +"{VERSION}`. Note that while all architectures in the base system can be " +"compiled by Clang, only a few architectures can be fully built by GCC." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3238 +#: documentation/content/en/articles/committers-guide/_index.adoc:3263 msgid "" "The FreeBSD project also has some CI pipelines on github. For pull requests " -"on github and some branches pushed to the github forks, a number of cross " -"compilation jobs run. These test FreeBSD building using a version of Clang " -"that sometimes lags the in-tree compiler by a major version for a time." +"on github and some branches pushed to github forks, a number of cross " +"compilation jobs run. These test FreeBSD building using versions of Clang " +"that lag the in-tree compiler by one or more major versions." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3244 +#: documentation/content/en/articles/committers-guide/_index.adoc:3269 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 " @@ -6913,7 +6959,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3248 +#: documentation/content/en/articles/committers-guide/_index.adoc:3273 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 " @@ -6923,7 +6969,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3254 +#: documentation/content/en/articles/committers-guide/_index.adoc:3279 msgid "" "The FreeBSD project provides headers and libraries that allow other " "compilers to be used to build software not in the base system. These " @@ -6938,7 +6984,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3259 +#: documentation/content/en/articles/committers-guide/_index.adoc:3284 msgid "" "The FreeBSD build system currently accommodates these different " "environments. As new warnings are added to compilers, the project tries to " @@ -6950,29 +6996,36 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3260 +#: documentation/content/en/articles/committers-guide/_index.adoc:3285 #, no-wrap msgid "Current Compiler Versions" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3265 +#: documentation/content/en/articles/committers-guide/_index.adoc:3288 +msgid "" +"The versions of supported compilers for a given branch such as `main` or " +"`stable/X` varies over time. The authoritative source for supported " +"compiler versions are automated CI jobs tested in GitHub's cross-build " +"actions and Jenkins." +msgstr "" + +#. type: delimited block = 4 +#: documentation/content/en/articles/committers-guide/_index.adoc:3292 msgid "" -"The in-tree compiler is currently Clang 15.x. Currently, GCC 12 and Clang " -"12, 13, 14 and 15 are tested in the github and project's CI jenkins jobs. " -"Work is underway to get the tree ready for Clang 16. The oldest project " -"supported branch has Clang 12, so the bootstrap portions of the build must " -"work for Clang major versions 12 to 15." +"For `main`, the in-tree compiler is currently Clang 19. Currently, GCC 12, " +"13, and 14 are tested for amd64 via CI jobs in Jenkins. Clang 14 and 18 are " +"tested for aarch64 and arm64 in GitHub's cross-build actions." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3266 +#: documentation/content/en/articles/committers-guide/_index.adoc:3293 #, no-wrap msgid "Other Suggestions" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3270 +#: documentation/content/en/articles/committers-guide/_index.adoc:3297 msgid "" "When committing documentation changes, use a spell checker before " "committing. For all XML docs, verify that the formatting directives are " @@ -6980,7 +7033,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3272 +#: documentation/content/en/articles/committers-guide/_index.adoc:3299 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 " @@ -6989,7 +7042,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3279 +#: documentation/content/en/articles/committers-guide/_index.adoc:3306 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 " @@ -7002,20 +7055,20 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3280 +#: documentation/content/en/articles/committers-guide/_index.adoc:3307 #, no-wrap msgid "Deprecating Features" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3283 +#: documentation/content/en/articles/committers-guide/_index.adoc:3310 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:3285 +#: documentation/content/en/articles/committers-guide/_index.adoc:3312 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 " @@ -7023,14 +7076,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3286 +#: documentation/content/en/articles/committers-guide/_index.adoc:3313 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:3287 +#: documentation/content/en/articles/committers-guide/_index.adoc:3314 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 " @@ -7038,18 +7091,18 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3288 +#: documentation/content/en/articles/committers-guide/_index.adoc:3315 #, no-wrap msgid "Privacy and Confidentiality" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3291 +#: documentation/content/en/articles/committers-guide/_index.adoc:3318 msgid "Most FreeBSD business is done in public." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3294 +#: documentation/content/en/articles/committers-guide/_index.adoc:3321 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 " @@ -7057,12 +7110,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3295 +#: documentation/content/en/articles/committers-guide/_index.adoc:3322 msgid "Certain sensitive matters must remain private or held under embargo." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3301 +#: documentation/content/en/articles/committers-guide/_index.adoc:3328 msgid "" "There unfortunately cannot be complete transparency. As a FreeBSD developer " "you will have a certain degree of privileged access to information. " @@ -7073,14 +7126,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3302 +#: documentation/content/en/articles/committers-guide/_index.adoc:3329 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:3307 +#: documentation/content/en/articles/committers-guide/_index.adoc:3334 msgid "" "Where there are security problems that affect many different operating " "systems, FreeBSD frequently depends on early access to be able to prepare " @@ -7093,13 +7146,13 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3308 +#: documentation/content/en/articles/committers-guide/_index.adoc:3335 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:3313 +#: documentation/content/en/articles/committers-guide/_index.adoc:3340 msgid "" "Communications to core will initially be treated as confidential. " "Eventually however, most of Core's business will be summarized into the " @@ -7110,14 +7163,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3314 +#: documentation/content/en/articles/committers-guide/_index.adoc:3341 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:3317 +#: documentation/content/en/articles/committers-guide/_index.adoc:3344 msgid "" "Access to certain commercially sensitive data may only be available under a " "Non-Disclosure Agreement. The FreeBSD Foundation legal staff must be " @@ -7125,12 +7178,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3318 +#: documentation/content/en/articles/committers-guide/_index.adoc:3345 msgid "Private communications must not be made public without permission." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3321 +#: documentation/content/en/articles/committers-guide/_index.adoc:3348 msgid "" "Beyond the specific requirements above there is a general expectation not to " "publish private communications between developers without the consent of all " @@ -7140,14 +7193,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3322 +#: documentation/content/en/articles/committers-guide/_index.adoc:3349 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:3325 +#: documentation/content/en/articles/committers-guide/_index.adoc:3352 msgid "" "Similarly to personal communications, certain internal communications " "channels, including FreeBSD Committer only mailing lists and restricted " @@ -7156,12 +7209,12 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3326 +#: documentation/content/en/articles/committers-guide/_index.adoc:3353 msgid "Core may approve publication." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3328 +#: documentation/content/en/articles/committers-guide/_index.adoc:3355 msgid "" "Where it is impractical to obtain permission due to the number of " "correspondents or where permission to publish is unreasonably withheld, Core " @@ -7170,13 +7223,13 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3330 +#: documentation/content/en/articles/committers-guide/_index.adoc:3357 #, no-wrap msgid "Support for Multiple Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3337 +#: documentation/content/en/articles/committers-guide/_index.adoc:3364 msgid "" "FreeBSD is a highly portable operating system intended to function on many " "different types of hardware architectures. Maintaining clean separation of " @@ -7192,13 +7245,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3338 +#: documentation/content/en/articles/committers-guide/_index.adoc:3365 #, no-wrap msgid "Statement of General Intent" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3343 +#: documentation/content/en/articles/committers-guide/_index.adoc:3370 msgid "" "The FreeBSD Project targets \"production quality commercial off-the-shelf " "(COTS) workstation, server, and high-end embedded systems\". By retaining a " @@ -7214,7 +7267,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3350 +#: documentation/content/en/articles/committers-guide/_index.adoc:3377 msgid "" "The FreeBSD Project differentiates platform targets into four tiers. Each " "tier includes a list of guarantees consumers may rely on as well as " @@ -7228,13 +7281,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3351 +#: documentation/content/en/articles/committers-guide/_index.adoc:3378 #, no-wrap msgid "Platform Targets" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3358 +#: documentation/content/en/articles/committers-guide/_index.adoc:3385 msgid "" "Support for a hardware platform consists of two components: kernel support " "and userland Application Binary Interfaces (ABIs). Kernel platform support " @@ -7249,7 +7302,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3360 +#: documentation/content/en/articles/committers-guide/_index.adoc:3387 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 " @@ -7258,7 +7311,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3365 +#: documentation/content/en/articles/committers-guide/_index.adoc:3392 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 " @@ -7269,20 +7322,20 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3367 +#: documentation/content/en/articles/committers-guide/_index.adoc:3394 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:3368 +#: documentation/content/en/articles/committers-guide/_index.adoc:3395 #, no-wrap msgid "Tier 1: Fully-Supported Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3373 +#: documentation/content/en/articles/committers-guide/_index.adoc:3400 msgid "" "Tier 1 platforms are the most mature FreeBSD platforms. They are supported " "by the security officer, release engineering, and Ports Management Team. " @@ -7292,42 +7345,42 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3375 +#: documentation/content/en/articles/committers-guide/_index.adoc:3402 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:3377 +#: documentation/content/en/articles/committers-guide/_index.adoc:3404 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:3378 +#: documentation/content/en/articles/committers-guide/_index.adoc:3405 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:3379 +#: documentation/content/en/articles/committers-guide/_index.adoc:3406 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:3380 +#: documentation/content/en/articles/committers-guide/_index.adoc:3407 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:3381 +#: documentation/content/en/articles/committers-guide/_index.adoc:3408 msgid "" "Changes to userland ABIs will generally include compatibility shims to " "ensure correct operation of binaries compiled against any stable branch " @@ -7337,7 +7390,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3382 +#: documentation/content/en/articles/committers-guide/_index.adoc:3409 msgid "" "Changes to certain portions of the kernel ABI will include compatibility " "shims to ensure correct operation of kernel modules compiled against the " @@ -7346,7 +7399,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3383 +#: documentation/content/en/articles/committers-guide/_index.adoc:3410 msgid "" "Official binary packages for third party software will be provided by the " "ports team. For embedded architectures, these packages may be cross-built " @@ -7354,21 +7407,21 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3384 +#: documentation/content/en/articles/committers-guide/_index.adoc:3411 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:3385 +#: documentation/content/en/articles/committers-guide/_index.adoc:3412 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:3386 +#: documentation/content/en/articles/committers-guide/_index.adoc:3413 msgid "" "Features and compatibility shims used by binaries compiled against older " "stable branches may be removed in newer major versions. Such removals will " @@ -7376,19 +7429,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3387 +#: documentation/content/en/articles/committers-guide/_index.adoc:3414 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:3388 +#: documentation/content/en/articles/committers-guide/_index.adoc:3415 msgid "Tier 1 platforms will be included in the source tree." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3389 +#: documentation/content/en/articles/committers-guide/_index.adoc:3416 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 " @@ -7396,14 +7449,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3391 +#: documentation/content/en/articles/committers-guide/_index.adoc:3418 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:3393 +#: documentation/content/en/articles/committers-guide/_index.adoc:3420 msgid "" "Build and test automation support either in the FreeBSD.org cluster or some " "other location easily available for all developers. Embedded platforms may " @@ -7412,41 +7465,41 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3394 -#: documentation/content/en/articles/committers-guide/_index.adoc:3424 +#: documentation/content/en/articles/committers-guide/_index.adoc:3421 +#: documentation/content/en/articles/committers-guide/_index.adoc:3451 msgid "Inclusion in the `make universe` and `make tinderbox` targets." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3395 +#: documentation/content/en/articles/committers-guide/_index.adoc:3422 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:3397 +#: documentation/content/en/articles/committers-guide/_index.adoc:3424 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:3399 +#: documentation/content/en/articles/committers-guide/_index.adoc:3426 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:3400 +#: documentation/content/en/articles/committers-guide/_index.adoc:3427 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:3401 +#: documentation/content/en/articles/committers-guide/_index.adoc:3428 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 " @@ -7455,7 +7508,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3402 +#: documentation/content/en/articles/committers-guide/_index.adoc:3429 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 " @@ -7463,7 +7516,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3403 +#: documentation/content/en/articles/committers-guide/_index.adoc:3430 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 " @@ -7471,13 +7524,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3404 +#: documentation/content/en/articles/committers-guide/_index.adoc:3431 #, no-wrap msgid "Tier 2: Developmental and Niche Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3408 +#: documentation/content/en/articles/committers-guide/_index.adoc:3435 msgid "" "Tier 2 platforms are functional, but less mature FreeBSD platforms. They " "are not supported by the security officer, release engineering, and Ports " @@ -7485,7 +7538,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3412 +#: documentation/content/en/articles/committers-guide/_index.adoc:3439 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 " @@ -7495,14 +7548,14 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3414 +#: documentation/content/en/articles/committers-guide/_index.adoc:3441 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:3416 +#: documentation/content/en/articles/committers-guide/_index.adoc:3443 msgid "" "The ports infrastructure should include basic support for Tier 2 " "architectures sufficient to support building ports and packages. This " @@ -7511,19 +7564,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3417 +#: documentation/content/en/articles/committers-guide/_index.adoc:3444 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:3418 +#: documentation/content/en/articles/committers-guide/_index.adoc:3445 msgid "Tier 2 platforms will be included in the source tree." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3419 +#: documentation/content/en/articles/committers-guide/_index.adoc:3446 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 " @@ -7531,41 +7584,41 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3420 +#: documentation/content/en/articles/committers-guide/_index.adoc:3447 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:3422 +#: documentation/content/en/articles/committers-guide/_index.adoc:3449 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:3426 +#: documentation/content/en/articles/committers-guide/_index.adoc:3453 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:3428 +#: documentation/content/en/articles/committers-guide/_index.adoc:3455 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:3429 +#: documentation/content/en/articles/committers-guide/_index.adoc:3456 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:3430 +#: documentation/content/en/articles/committers-guide/_index.adoc:3457 msgid "" "While changes are permitted to break the userland ABI, the ABI should not be " "broken gratuitously. Significant userland ABI changes should be restricted " @@ -7573,20 +7626,20 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3431 +#: documentation/content/en/articles/committers-guide/_index.adoc:3458 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:3432 +#: documentation/content/en/articles/committers-guide/_index.adoc:3459 #, no-wrap msgid "Tier 3: Experimental Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3436 +#: documentation/content/en/articles/committers-guide/_index.adoc:3463 msgid "" "Tier 3 platforms have at least partial FreeBSD support. They are _not_ " "supported by the security officer, release engineering, and Ports Management " @@ -7594,7 +7647,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3439 +#: documentation/content/en/articles/committers-guide/_index.adoc:3466 msgid "" "Tier 3 platforms are architectures in the early stages of development, for " "non-mainstream hardware platforms, or which are considered legacy systems " @@ -7603,7 +7656,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3442 +#: documentation/content/en/articles/committers-guide/_index.adoc:3469 msgid "" "The FreeBSD Project provides no guarantees to consumers of Tier 3 platforms " "and is not committed to maintaining resources to support development. Tier " @@ -7612,20 +7665,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3443 +#: documentation/content/en/articles/committers-guide/_index.adoc:3470 #, no-wrap msgid "Unsupported Architectures" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3447 +#: documentation/content/en/articles/committers-guide/_index.adoc:3474 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:3450 +#: documentation/content/en/articles/committers-guide/_index.adoc:3477 msgid "" "After a platform transitions to unsupported, all support for the platform is " "removed from the source, ports and documentation trees. Note that ports " @@ -7634,13 +7687,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3451 +#: documentation/content/en/articles/committers-guide/_index.adoc:3478 #, no-wrap msgid "Policy on Changing the Tier of an Architecture" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3455 +#: documentation/content/en/articles/committers-guide/_index.adoc:3482 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 " @@ -7650,25 +7703,25 @@ msgid "" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3457 +#: documentation/content/en/articles/committers-guide/_index.adoc:3484 #, no-wrap msgid "Ports Specific FAQ" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3460 +#: documentation/content/en/articles/committers-guide/_index.adoc:3487 #, no-wrap msgid "Adding a New Port" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3463 +#: documentation/content/en/articles/committers-guide/_index.adoc:3490 #, no-wrap msgid "How do I add a new port?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3468 +#: documentation/content/en/articles/committers-guide/_index.adoc:3495 msgid "" "Adding a port to the tree is relatively simple. Once the port is ready to be " "added, as explained later crossref:committers-guide[ports-qa-add-new-" @@ -7678,20 +7731,20 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3472 +#: documentation/content/en/articles/committers-guide/_index.adoc:3499 #, no-wrap msgid "\tSUBDIR += newport\n" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3475 +#: documentation/content/en/articles/committers-guide/_index.adoc:3502 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:3480 +#: documentation/content/en/articles/committers-guide/_index.adoc:3507 #, no-wrap msgid "" "% git add category/Makefile category/newport\n" @@ -7700,7 +7753,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3484 +#: documentation/content/en/articles/committers-guide/_index.adoc:3511 msgid "" "Don't forget to crossref:committers-guide[port-commit-message-formats,setup " "git hooks for the ports tree as explained here]; a specific hook has been " @@ -7708,19 +7761,19 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3487 +#: documentation/content/en/articles/committers-guide/_index.adoc:3514 #, 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:3490 +#: documentation/content/en/articles/committers-guide/_index.adoc:3517 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:3493 +#: documentation/content/en/articles/committers-guide/_index.adoc:3520 msgid "" "The extref:{porters-handbook}testing[Porters Handbook's Testing Chapter] " "contains more detailed instructions. See the extref:{porters-handbook}" @@ -7729,14 +7782,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3495 +#: documentation/content/en/articles/committers-guide/_index.adoc:3522 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:3497 +#: documentation/content/en/articles/committers-guide/_index.adoc:3524 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 " @@ -7744,14 +7797,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3500 +#: documentation/content/en/articles/committers-guide/_index.adoc:3527 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:3504 +#: documentation/content/en/articles/committers-guide/_index.adoc:3531 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 " @@ -7759,7 +7812,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3514 +#: documentation/content/en/articles/committers-guide/_index.adoc:3541 #, no-wrap msgid "" "# make install\n" @@ -7772,85 +7825,85 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3517 +#: documentation/content/en/articles/committers-guide/_index.adoc:3544 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:3520 +#: documentation/content/en/articles/committers-guide/_index.adoc:3547 #, no-wrap msgid "Removing an Existing Port" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3523 +#: documentation/content/en/articles/committers-guide/_index.adoc:3550 #, no-wrap msgid "How do I remove an existing port?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3526 +#: documentation/content/en/articles/committers-guide/_index.adoc:3553 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:3528 +#: documentation/content/en/articles/committers-guide/_index.adoc:3555 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:3529 +#: documentation/content/en/articles/committers-guide/_index.adoc:3556 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:3530 +#: documentation/content/en/articles/committers-guide/_index.adoc:3557 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:3534 +#: documentation/content/en/articles/committers-guide/_index.adoc:3561 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:3537 +#: documentation/content/en/articles/committers-guide/_index.adoc:3564 msgid "Then, remove the port:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3541 +#: documentation/content/en/articles/committers-guide/_index.adoc:3568 msgid "Remove the port's files and directory with `git rm`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3542 +#: documentation/content/en/articles/committers-guide/_index.adoc:3569 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:3543 -#: documentation/content/en/articles/committers-guide/_index.adoc:3558 +#: documentation/content/en/articles/committers-guide/_index.adoc:3570 +#: documentation/content/en/articles/committers-guide/_index.adoc:3585 msgid "Add an entry to [.filename]#ports/MOVED#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3544 +#: documentation/content/en/articles/committers-guide/_index.adoc:3571 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:3549 +#: documentation/content/en/articles/committers-guide/_index.adoc:3576 msgid "" "Alternatively, you can use the rmport script, from [.filename]#ports/Tools/" "scripts#. This script was written by {vd}. When sending questions about " @@ -7859,13 +7912,13 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3551 +#: documentation/content/en/articles/committers-guide/_index.adoc:3578 #, 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:3556 +#: documentation/content/en/articles/committers-guide/_index.adoc:3583 msgid "" "Perform a thorough check of the ports collection for any dependencies on the " "old port location/name, and update them. Running `grep` on " @@ -7875,14 +7928,14 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3557 +#: documentation/content/en/articles/committers-guide/_index.adoc:3584 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:3559 +#: documentation/content/en/articles/committers-guide/_index.adoc:3586 msgid "" "Search for entries in xml files inside [.filename]#ports/security/vuxml# and " "adjust them accordingly. In particular, check for previous packages with the " @@ -7890,51 +7943,51 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3560 +#: documentation/content/en/articles/committers-guide/_index.adoc:3587 msgid "Move the port with `git mv`." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3561 -#: documentation/content/en/articles/committers-guide/_index.adoc:3572 +#: documentation/content/en/articles/committers-guide/_index.adoc:3588 +#: documentation/content/en/articles/committers-guide/_index.adoc:3599 msgid "Commit the changes." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3564 +#: documentation/content/en/articles/committers-guide/_index.adoc:3591 #, 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:3569 +#: documentation/content/en/articles/committers-guide/_index.adoc:3596 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:3570 +#: documentation/content/en/articles/committers-guide/_index.adoc:3597 msgid "Add the new port to the [.filename]#new-cat/Makefile#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3571 +#: documentation/content/en/articles/committers-guide/_index.adoc:3598 msgid "Change stuff in [.filename]#new-cat/new-port#." msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3575 +#: documentation/content/en/articles/committers-guide/_index.adoc:3602 #, no-wrap msgid "Ports Freeze" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3578 +#: documentation/content/en/articles/committers-guide/_index.adoc:3605 #, no-wrap msgid "What is a “ports freeze”?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3585 +#: documentation/content/en/articles/committers-guide/_index.adoc:3612 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 " @@ -7945,7 +7998,7 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3588 +#: documentation/content/en/articles/committers-guide/_index.adoc:3615 msgid "" "For more information on how to merge commits to the quarterly branch, see " "crossref:committers-guide[ports-qa-misc-request-mfh, What is the procedure " @@ -7953,32 +8006,32 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3590 +#: documentation/content/en/articles/committers-guide/_index.adoc:3617 #, no-wrap msgid "Quarterly Branches" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3593 +#: documentation/content/en/articles/committers-guide/_index.adoc:3620 #, 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:3596 +#: documentation/content/en/articles/committers-guide/_index.adoc:3623 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:3598 +#: documentation/content/en/articles/committers-guide/_index.adoc:3625 #, 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:3601 +#: documentation/content/en/articles/committers-guide/_index.adoc:3628 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 " @@ -7986,7 +8039,7 @@ msgid "" msgstr "" #. type: delimited block . 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3607 +#: documentation/content/en/articles/committers-guide/_index.adoc:3634 #, no-wrap msgid "" "% git checkout 2021Q2\n" @@ -7996,7 +8049,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3611 +#: documentation/content/en/articles/committers-guide/_index.adoc:3638 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` " @@ -8004,19 +8057,19 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3613 +#: documentation/content/en/articles/committers-guide/_index.adoc:3640 #, no-wrap msgid "Creating a New Category" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3616 +#: documentation/content/en/articles/committers-guide/_index.adoc:3643 #, no-wrap msgid "What is the procedure for creating a new category?" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3621 +#: documentation/content/en/articles/committers-guide/_index.adoc:3648 msgid "" "Please see extref:{porters-handbook}[Proposing a New Category, proposing-" "categories] in the Porter's Handbook. Once that procedure has been followed " @@ -8025,42 +8078,42 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3625 +#: documentation/content/en/articles/committers-guide/_index.adoc:3652 msgid "Perform any needed moves. (This only applies to physical categories.)" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3626 +#: documentation/content/en/articles/committers-guide/_index.adoc:3653 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:3627 +#: documentation/content/en/articles/committers-guide/_index.adoc:3654 msgid "Assign the PR back to you." msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3630 +#: documentation/content/en/articles/committers-guide/_index.adoc:3657 #, 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:3635 +#: documentation/content/en/articles/committers-guide/_index.adoc:3662 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:3637 +#: documentation/content/en/articles/committers-guide/_index.adoc:3664 msgid "To do this, you will need to:" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3641 +#: documentation/content/en/articles/committers-guide/_index.adoc:3668 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 " @@ -8068,7 +8121,7 @@ msgid "" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3642 +#: documentation/content/en/articles/committers-guide/_index.adoc:3669 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 " @@ -8077,14 +8130,14 @@ msgid "" msgstr "" #. type: delimited block = 6 -#: documentation/content/en/articles/committers-guide/_index.adoc:3643 +#: documentation/content/en/articles/committers-guide/_index.adoc:3670 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:3646 +#: documentation/content/en/articles/committers-guide/_index.adoc:3673 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 " @@ -8094,7 +8147,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3648 +#: documentation/content/en/articles/committers-guide/_index.adoc:3675 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 " @@ -8104,7 +8157,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3649 +#: documentation/content/en/articles/committers-guide/_index.adoc:3676 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 " @@ -8116,7 +8169,7 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3650 +#: documentation/content/en/articles/committers-guide/_index.adoc:3677 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 " @@ -8124,25 +8177,25 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3651 +#: documentation/content/en/articles/committers-guide/_index.adoc:3678 msgid "Add appropriate entries to [.filename]#ports/MOVED#." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3652 +#: documentation/content/en/articles/committers-guide/_index.adoc:3679 msgid "Update the documentation by modifying:" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3653 -#: documentation/content/en/articles/committers-guide/_index.adoc:3662 +#: documentation/content/en/articles/committers-guide/_index.adoc:3680 +#: documentation/content/en/articles/committers-guide/_index.adoc:3689 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:3655 +#: documentation/content/en/articles/committers-guide/_index.adoc:3682 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 " @@ -8150,38 +8203,38 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3657 +#: documentation/content/en/articles/committers-guide/_index.adoc:3684 #, 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:3660 +#: documentation/content/en/articles/committers-guide/_index.adoc:3687 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:3664 -#: documentation/content/en/articles/committers-guide/_index.adoc:3758 +#: documentation/content/en/articles/committers-guide/_index.adoc:3691 +#: documentation/content/en/articles/committers-guide/_index.adoc:3785 #, no-wrap msgid "Miscellaneous Questions" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3667 +#: documentation/content/en/articles/committers-guide/_index.adoc:3694 #, 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:3670 +#: documentation/content/en/articles/committers-guide/_index.adoc:3697 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:3672 +#: documentation/content/en/articles/committers-guide/_index.adoc:3699 msgid "" "Most infrastructure changes to a port (that is, modernizing, but not " "changing the functionality). For example, the blanket covers converting to " @@ -8190,19 +8243,19 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3673 +#: documentation/content/en/articles/committers-guide/_index.adoc:3700 msgid "Trivial and _tested_ build and runtime fixes." msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3674 +#: documentation/content/en/articles/committers-guide/_index.adoc:3701 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:3679 +#: documentation/content/en/articles/committers-guide/_index.adoc:3706 msgid "" "Exceptions to this are anything maintained by the {portmgr}, or the " "{security-officer}. No unauthorized commits may ever be made to ports " @@ -8210,20 +8263,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3682 +#: documentation/content/en/articles/committers-guide/_index.adoc:3709 #, 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:3686 +#: documentation/content/en/articles/committers-guide/_index.adoc:3713 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:3688 +#: documentation/content/en/articles/committers-guide/_index.adoc:3715 msgid "" "Reports for all the package builds (official, experimental, and non-" "regression) are aggregated at link:pkg-status.FreeBSD.org[pkg-" @@ -8231,26 +8284,26 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3690 +#: documentation/content/en/articles/committers-guide/_index.adoc:3717 #, 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:3693 +#: documentation/content/en/articles/committers-guide/_index.adoc:3720 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:3695 +#: documentation/content/en/articles/committers-guide/_index.adoc:3722 #, 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:3699 +#: documentation/content/en/articles/committers-guide/_index.adoc:3726 msgid "" "Any file directly under [.filename]#ports/#, or any file under a " "subdirectory that starts with an uppercase letter ([.filename]#Mk/#, " @@ -8260,13 +8313,13 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3701 +#: documentation/content/en/articles/committers-guide/_index.adoc:3728 #, 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:3705 +#: documentation/content/en/articles/committers-guide/_index.adoc:3732 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 " @@ -8279,20 +8332,20 @@ msgid "" msgstr "" #. type: Title ==== -#: documentation/content/en/articles/committers-guide/_index.adoc:3707 +#: documentation/content/en/articles/committers-guide/_index.adoc:3734 #, 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:3711 +#: documentation/content/en/articles/committers-guide/_index.adoc:3738 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:3713 +#: documentation/content/en/articles/committers-guide/_index.adoc:3740 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 " @@ -8300,22 +8353,22 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3717 +#: documentation/content/en/articles/committers-guide/_index.adoc:3744 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:3718 +#: documentation/content/en/articles/committers-guide/_index.adoc:3745 msgid "Select the product your patch is about." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3719 +#: documentation/content/en/articles/committers-guide/_index.adoc:3746 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:3720 +#: documentation/content/en/articles/committers-guide/_index.adoc:3747 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 " @@ -8323,56 +8376,56 @@ msgid "" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3721 +#: documentation/content/en/articles/committers-guide/_index.adoc:3748 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:3722 +#: documentation/content/en/articles/committers-guide/_index.adoc:3749 msgid "Submit. Wait for the build to run." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3723 +#: documentation/content/en/articles/committers-guide/_index.adoc:3750 msgid "{portmgr} will reply with a possible fallout." msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3724 +#: documentation/content/en/articles/committers-guide/_index.adoc:3751 msgid "Depending on the fallout:" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3725 +#: documentation/content/en/articles/committers-guide/_index.adoc:3752 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:3726 +#: documentation/content/en/articles/committers-guide/_index.adoc:3753 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:3727 +#: documentation/content/en/articles/committers-guide/_index.adoc:3754 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:3730 +#: documentation/content/en/articles/committers-guide/_index.adoc:3757 #, no-wrap msgid "Issues Specific to Developers Who Are Not Committers" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3735 +#: documentation/content/en/articles/committers-guide/_index.adoc:3762 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 " @@ -8381,17 +8434,17 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3737 +#: documentation/content/en/articles/committers-guide/_index.adoc:3764 msgid "crossref:committers-guide[admin, Administrative Details]" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3738 +#: documentation/content/en/articles/committers-guide/_index.adoc:3765 msgid "crossref:committers-guide[conventions-everyone, For Everyone]" msgstr "" #. type: Plain text -#: documentation/content/en/articles/committers-guide/_index.adoc:3742 +#: documentation/content/en/articles/committers-guide/_index.adoc:3769 msgid "" "Get your mentor to add you to the \"Additional Contributors\" " "([.filename]#doc/shared/contrib-additional.adoc#), if you are not already " @@ -8399,48 +8452,48 @@ msgid "" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3744 +#: documentation/content/en/articles/committers-guide/_index.adoc:3771 msgid "crossref:committers-guide[developer.relations, Developer Relations]" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3745 +#: documentation/content/en/articles/committers-guide/_index.adoc:3772 msgid "crossref:committers-guide[ssh.guide, SSH Quick-Start Guide]" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3746 +#: documentation/content/en/articles/committers-guide/_index.adoc:3773 msgid "" "crossref:committers-guide[rules, The FreeBSD Committers' Big List of Rules]" msgstr "" #. type: Title == -#: documentation/content/en/articles/committers-guide/_index.adoc:3748 +#: documentation/content/en/articles/committers-guide/_index.adoc:3775 #, no-wrap msgid "Information About Google Analytics" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3751 +#: documentation/content/en/articles/committers-guide/_index.adoc:3778 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:3755 +#: documentation/content/en/articles/committers-guide/_index.adoc:3782 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:3760 +#: documentation/content/en/articles/committers-guide/_index.adoc:3787 #, 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:3764 +#: documentation/content/en/articles/committers-guide/_index.adoc:3791 msgid "" "`people.FreeBSD.org` is the same as `freefall.FreeBSD.org`. Just create a " "[.filename]#public_html# directory. Anything you place in that directory " @@ -8449,45 +8502,45 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3765 +#: documentation/content/en/articles/committers-guide/_index.adoc:3792 #, no-wrap msgid "Where are the mailing list archives stored?" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3768 +#: documentation/content/en/articles/committers-guide/_index.adoc:3795 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:3769 +#: documentation/content/en/articles/committers-guide/_index.adoc:3796 #, 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:3772 +#: documentation/content/en/articles/committers-guide/_index.adoc:3799 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:3774 +#: documentation/content/en/articles/committers-guide/_index.adoc:3801 #, no-wrap msgid "Benefits and Perks for FreeBSD Committers" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3777 +#: documentation/content/en/articles/committers-guide/_index.adoc:3804 #, no-wrap msgid "Recognition" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3781 +#: documentation/content/en/articles/committers-guide/_index.adoc:3808 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 " @@ -8495,33 +8548,33 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3783 +#: documentation/content/en/articles/committers-guide/_index.adoc:3810 #, no-wrap msgid "FreeBSD Mall" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3786 +#: documentation/content/en/articles/committers-guide/_index.adoc:3813 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:3788 +#: documentation/content/en/articles/committers-guide/_index.adoc:3815 #, no-wrap msgid "`Gandi.net`" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3791 +#: documentation/content/en/articles/committers-guide/_index.adoc:3818 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:3795 +#: documentation/content/en/articles/committers-guide/_index.adoc:3822 msgid "" "Gandi offers an E-rate discount to all FreeBSD developers. To streamline " "the process of getting the discount first set up a Gandi account, fill in " @@ -8531,20 +8584,20 @@ msgid "" msgstr "" #. type: Title === -#: documentation/content/en/articles/committers-guide/_index.adoc:3797 +#: documentation/content/en/articles/committers-guide/_index.adoc:3824 #, no-wrap msgid "`rsync.net`" msgstr "" #. type: delimited block = 4 -#: documentation/content/en/articles/committers-guide/_index.adoc:3800 +#: documentation/content/en/articles/committers-guide/_index.adoc:3827 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:3801 +#: documentation/content/en/articles/committers-guide/_index.adoc:3828 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/" |