diff options
Diffstat (limited to 'documentation/content')
11 files changed, 126 insertions, 52 deletions
diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index 0b23426894..71bb302151 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -833,8 +833,10 @@ To abort and get back to the state before "git rebase", run "git rebase --abort" Could not apply 646e0f9cda11... no color ls .... which looks scary. + If you bring up an editor, you will see it is a typical 3-way merge conflict resolution that you may be familiar with from other source code systems (the rest of ls.c has been omitted): [source,shell] +.... <<<<<<< HEAD #ifdef COLORLS_NEW #include <terminfo.h> @@ -844,7 +846,9 @@ If you bring up an editor, you will see it is a typical 3-way merge conflict res #include <termcap.h> >>>>>>> 646e0f9cda11... no color ls .... + The new code is first, and your code is second. + The right fix here is to just add a #undef COLORLS_NEW before #ifdef and then delete the old changes: [source,shell] .... @@ -853,6 +857,7 @@ The right fix here is to just add a #undef COLORLS_NEW before #ifdef and then de #include <terminfo.h> .... save the file. + The rebase was interrupted, so you have to complete it: [source,shell] .... diff --git a/documentation/content/en/books/fdp-primer/structure/_index.adoc b/documentation/content/en/books/fdp-primer/structure/_index.adoc index 864ad53d7e..6aa5e17776 100644 --- a/documentation/content/en/books/fdp-primer/structure/_index.adoc +++ b/documentation/content/en/books/fdp-primer/structure/_index.adoc @@ -264,7 +264,22 @@ toc::[] The FreeBSD project recognizes contributors in several different lists in the documentation and in printed materials. This section describes how the documentation team manages changes to these lists. -=== Finding the Correct Files +=== Mentor and New Committer Relationship Lists + +Since FreeBSD 7.0, FreeBSD has maintained link:https://cgit.freebsd.org/src/tree/share/misc[three lists of contributor mentor / mentee relationships] - one for source code, one for ports and one for documentation. +These files are in *".dot"* format, intended for use with the popular graphing toolkit package:graphics/graphviz[] available as a FreeBSD package or port. + +[NOTE] +==== +man:dot[1] is installed as part of the package:graphics/graphviz[] package or port. +The [.filename]#dot# program reads files in *".dot"* format and creates a graphical image of the directed graph. +==== + +The three files often serve as a learning experience for new committers of all three teams who are instructed to add themselves, and their mentor, to the appropriate file as their first commit. +Each file has a "current" section for new committers, an "alumni" section for when the commit bit is returned, and a "mentor / mentee" section showing the relationships. +The format for each type of entry is explained at the top of the file. + +=== General Contributor Lists extref:{contributors}[Contributors] to FreeBSD are maintained in article format. The source file for managing the *Contributors* article file is located at: @@ -334,19 +349,19 @@ The order of entries for all files is found in the table below. === "In Memoriam" Section -If the intent is to notify the BSD community of the death of a community member, the following procedures should be used: +When notifying the BSD community of the death of a community member, the following procedure should be used: -. Search the files above for the name, email address, and nickname (such as `foobsd`). -. Since the member is deceased (which should be double checked) remove the name from the appropriate file and add them to the "In Memoriam" file ([.filename]#contrib-develinmemoriam.adoc# as noted above) by editing the appropriate files. -Try to find some additional information about their contributions to FreeBSD over the years and add it with their entry in the file. -This may require asking in the development mailing lists, contacting colleagues, contacting the FreeBSD Foundation, or searching through the commit logs. -. Where an email address is found with a name, remove the email address, but leave the name. +. Use the file [.filename]#~/doc/shared/authors.adoc# to look up the person's name and attribute reference, such as `{foobsd}`. +. If they are a current member of one or more FreeBSD project teams in [.filename]#~/doc/website/content/en/administration.adoc#, remove all instances of their attribute reference. +Also, complete the following edits: + -[cols="25%,25%,25%,25%", frame="none", options="header"] -|=== -| Purpose | Section Anchor | File in ~/doc/documentation/content/{language}/articles/contributors/ | Order Specification -| *Development Team: In Memoriam* | [.filename]#contrib-develinmemoriam.adoc# | [.filename]#contrib-develinmemoriam.adoc# | rough reverse chronological order -|=== +* [.filename]#~/doc/shared/contrib-committers.adoc# - Remove the attribute reference. +* [.filename]#~/doc/shared/contrib-corealumni.adoc# - If they are a _current_ member of the core team, create an entry showing start and end dates. +* [.filename]#~/doc/shared/contrib-develalumni.adoc# - Add the attribute reference and dates of activity as a committer. +* [.filename]#~/doc/shared/contrib-portmgralumni.adoc# - Add the attribute reference if necessary. +* [.filename]#~/doc/shared/contrib-additional.adoc# - Remove the entry. +* [.filename]#~/doc/shared/contrib-386bsd.adoc# - This is a historical document only. +No changes are needed. + . In the [.filename]#~/doc/shared/authors.adoc# file, comment out (using one backslash '\') the email address to avoid creating the email link "mailto:" See the example for `itojun` below: @@ -363,4 +378,43 @@ See the example for `itojun` below: [..] .... ++ +. Since the member is deceased (which should be double checked), add them to the "In Memoriam" file [.filename]#contrib-develinmemoriam.adoc#. ++ +Try to find some factual information about their contributions to FreeBSD over the years and add it with their entry in the file. +This may require asking in the development mailing lists, contacting colleagues, contacting the FreeBSD Foundation, or searching through the commit logs. ++ +To find the date of their first commit, use: ++ +[source.programlisting,asciidoc] +.... +% cd ~/src +% git log --reverse --author=foobsd # search for first commit of foobsd +.... ++ +This will print out their commits in reverse order. +The date of the first commit will be at the top. ++ +Ensure that the format of the dates match other entries: ++ +[source.programlisting,asciidoc] +.... +(year of commit bit start - year of commit bit end; RIP year deceased) +For example: + +* Foo BSD (2007 - 2010; RIP 2016) +.... ++ +Check the ordering of the entries in the file. ++ +[cols="25%,25%,25%,25%", frame="none", options="header"] +|=== +| Purpose | Section Anchor | File in ~/doc/documentation/content/{language}/articles/contributors/ | Order Specification +| *Development Team: In Memoriam* | [.filename]#contrib-develinmemoriam.adoc# | [.filename]#contrib-develinmemoriam.adoc# | rough reverse chronological order +|=== ++ +See the "In Memoriam" file for similar entries. ++ +. Finally, if applicable, move the committer member entry from the "current" section to the "alumni" section of the appropriate link:https://cgit.freebsd.org/src/tree/share/misc[list of contributor mentor / mentee relationships] along with an appropriate date. +It is not necessary to change the mentor / mentee relationship. diff --git a/documentation/content/en/books/fdp-primer/translations/_index.adoc b/documentation/content/en/books/fdp-primer/translations/_index.adoc index 664ac9b216..7dbfa915c0 100644 --- a/documentation/content/en/books/fdp-primer/translations/_index.adoc +++ b/documentation/content/en/books/fdp-primer/translations/_index.adoc @@ -176,7 +176,7 @@ documentation/ `sv` is the name of the translation, in [.filename]#lang# form. Note the two Makefiles, which will be used to build the documentation. -Use git diff command to generate a diff and send it to the link:reviews.freebsd.org/[reviews system]. +Use git diff command to generate a diff and send it to the link:https://reviews.freebsd.org/[reviews system]. [source,shell] .... diff --git a/documentation/content/en/books/handbook/desktop/_index.adoc b/documentation/content/en/books/handbook/desktop/_index.adoc index 225ed297b2..829a63d77c 100644 --- a/documentation/content/en/books/handbook/desktop/_index.adoc +++ b/documentation/content/en/books/handbook/desktop/_index.adoc @@ -151,12 +151,21 @@ Enable D-BUS service in `/etc/rc.conf` to start at system boot: # sysrc dbus_enable="YES" .... -To increase messages size execute: +KDE Plasma requires larger message sizes for optimal performance. + +Add the following lines to man:sysctl.conf[5]: + +[.programlisting] +.... +sysctl net.local.stream.recvspace=65536 +sysctl net.local.stream.sendspace=65536 +.... + +To apply the change, either run the following command as root or simply reboot the system: [source,shell] .... -# sysctl net.local.stream.recvspace=65536 -# sysctl net.local.stream.sendspace=65536 +# sysctl -f /etc/sysctl.conf .... [[kde-start]] @@ -281,15 +290,6 @@ To install the XFCE meta package, execute: [[xfce-configuration]] ==== Configure XFCE -XFCE requires `/proc` to be mounted. -Add this line to `/etc/fstab` to mount this file system automatically during system startup: - -[.programlisting] -.... -# Device Mountpoint FStype Options Dump Pass# -proc /proc procfs rw 0 0 -.... - XFCE uses man:dbus-daemon[1] for a message bus and hardware abstraction. This application is automatically installed as a dependency of XFCE. diff --git a/documentation/content/en/books/handbook/jails/_index.adoc b/documentation/content/en/books/handbook/jails/_index.adoc index a9b941a3a2..fd652694cc 100644 --- a/documentation/content/en/books/handbook/jails/_index.adoc +++ b/documentation/content/en/books/handbook/jails/_index.adoc @@ -1051,7 +1051,7 @@ Finally, it will be necessary to remove the jail entry in [.filename]#/etc/jail. The man:pkg[8] tool supports the `-j` argument in order to handle packages installed inside the jail. -For example, to install package:nginx-lite[] in the jail, the next command can be executed *from the host*: +For example, to install package:www/nginx-lite[] in the jail, the next command can be executed *from the host*: [source,shell] .... diff --git a/documentation/content/en/books/handbook/mirrors/_index.adoc b/documentation/content/en/books/handbook/mirrors/_index.adoc index e921ce156e..9c308e1dbf 100644 --- a/documentation/content/en/books/handbook/mirrors/_index.adoc +++ b/documentation/content/en/books/handbook/mirrors/_index.adoc @@ -96,6 +96,8 @@ http://ftp-archive.FreeBSD.org is not in the GeoDNS Infrastructure, hosted in on The project is looking for new locations; those willing to sponsor, please reach out to the Cluster Administrators team for more information. +There is an ongoing project to provide **download.FreeBSD.org** and **pkg.FreeBSD.org** through link:https://www.fastly.com[Fastly], using its CDN acceleration, caching, and bandwidth to bring FreeBSD images and packages to our globally distributed community. + Mirror list maintained by the community and other companies: [cols="1,1,3"] diff --git a/documentation/content/en/books/handbook/network/_index.adoc b/documentation/content/en/books/handbook/network/_index.adoc index 5d54ddd5e8..bb49981b31 100644 --- a/documentation/content/en/books/handbook/network/_index.adoc +++ b/documentation/content/en/books/handbook/network/_index.adoc @@ -577,11 +577,15 @@ The following sections discuss each step. Connecting FreeBSD to an existing wireless network is a very common situation. -This procedure shows the steps required: +This Quick Start procedure shows the steps required to connect to a network using basic authentication. +A more detailed procedure is given in the next section. -* The first step will be to obtain the SSID (Service Set Identifier) and PSK (Pre-Shared Key) for the wireless network from the network administrator. +The first step is to obtain the Service Set Identifier (SSID) and Pre-Shared Key (PSK) for the wireless network from the network administrator. -* The second step will be to add default configuration paramaters and an entry for this network to [.filename]#/etc/wpa_supplicant.conf#. If the file does not exist, create it: +The second step is to add an entry for this network to [.filename]#/etc/wpa_supplicant.conf#. + +If the file does not exist, create it. +Consult man:wpa_supplicant.conf[5] for details on formatting entries in this file. [.programlisting] .... @@ -596,10 +600,28 @@ network={ } .... -<.> Is the SSID of the wireless network. Replace it with the name of the wireless network. -<.> Is the PSK of the wireless network. Replace it with the password of the wireless network. +<.> Is the SSID of the wireless network. +Replace it with the name of the wireless network. +<.> Is the PSK of the wireless network. +Replace it with the password of the wireless network. + +The third step is to add the network interface entry to configure the network on startup. +Obtain the network device interface by using the sysctl `net.wlan.devices`. +In the listing below, the output of this sysctl shows the network device interface is "iwn0". + +[source,shell] +.... +# sysctl net.wlan.devices +.... + +The output should be similar to the following: + +[.programlisting] +.... +net.wlan.devices: iwm0 +.... -* The third step will be to add the network entry to configure the network on startup: +In the sysrc line that follows, replace "iwn0" with the output of the sysctl command if needed. [source,shell] .... @@ -607,7 +629,7 @@ network={ # sysrc ifconfig_wlan0="WPA DHCP" .... -* And the last step will be the restart `netif` service executing the following command: +* And the last step is to restart the `netif` service executing the following command: [source,shell] .... @@ -617,7 +639,7 @@ network={ [[basic-wireless-configuration]] === Basic Wireless Configuration -The first step will be to configure the wireless network card to an interface. +This section provides a more detailed example of configuring a wireless network card. To find out what wireless network cards are in the system check the section crossref:network[config-identify-network-adapter, Identify Network Adapters]. diff --git a/documentation/content/en/books/handbook/wayland/_index.adoc b/documentation/content/en/books/handbook/wayland/_index.adoc index 48d9e4a4e1..aa402971ff 100644 --- a/documentation/content/en/books/handbook/wayland/_index.adoc +++ b/documentation/content/en/books/handbook/wayland/_index.adoc @@ -73,9 +73,10 @@ After reading this chapter, you will know: [[wayland-overview]] == Wayland Overview -Wayland is a new display server, but it differs from Xorg in several important ways. -First, Wayland is only a protocol that acts as an intermediary between clients using a different mechanism which removes the dependency on an X server. -Xorg includes both the X11 protocol, used to run remote displays and the X server will accept connections and display windows. +Wayland is a communication protocol that can replace a display server such as Xorg. +It differs from Xorg in several important ways. +First, Wayland is only a protocol that acts as an intermediary between clients using a mechanism which removes the dependency on an X server. +Xorg includes both the X11 protocol, used to run remote displays, and the X server, used to accept connections and display windows. Under Wayland, the compositor or window manager provides the display server instead of a traditional X server. Since Wayland is not an X server, traditional X screen connections will need to utilize other methods such as VNC or RDP for remote desktop management. diff --git a/documentation/content/en/books/porters-handbook/makefiles/_index.adoc b/documentation/content/en/books/porters-handbook/makefiles/_index.adoc index 7b76b21ab1..e98d2ff336 100644 --- a/documentation/content/en/books/porters-handbook/makefiles/_index.adoc +++ b/documentation/content/en/books/porters-handbook/makefiles/_index.adoc @@ -101,8 +101,8 @@ From time to time, some software will use a version scheme that is not compatibl [TIP] ==== -When updating a port, it is possible to use man:pkg-version[8]'s `-t` argument to check if the new version is greater or lesser than before. -See crossref:makefiles[makefile-versions-ex-pkg-version, Using man:pkg-version\[8\] to Compare Versions]. +When updating a port, it is possible to use the `-t` argument of man:pkg-version[8] to check if the new version is greater or lesser than before. +See below on how to use man:pkg-version[8] to compare versions. ==== [[makefile-versions-ex-pkg-version]] @@ -1581,8 +1581,8 @@ USE_GITHUB= yes GH_TAGNAME= c472d66b .... -This creates a versioning scheme that increases over time, and that is still -before version `0` (see crossref:makefiles[makefile-versions-ex-pkg-version, Using man:pkg-version\[8\] to Compare Versions] for details on man:pkg-version[8]): +This creates a versioning scheme that increases over time, and that is still before version `0`. +See crossref:makefiles[makefile-versions-ex-pkg-version, this secion on how to compare versions] using man:pkg-version[8]): [source,shell] .... @@ -1627,7 +1627,7 @@ USE_GITHUB= yes .... This creates a versioning scheme that increases over time (well, over commits), and does not conflict with the creation of a `0.7.4` version. -(See crossref:makefiles[makefile-versions-ex-pkg-version, Using man:pkg-version\[8\] to Compare Versions] for details on man:pkg-version[8]): +See crossref:makefiles[makefile-versions-ex-pkg-version, this section for how to compare versions] using man:pkg-version[8]): [source,shell] .... diff --git a/documentation/content/en/books/porters-handbook/testing/_index.adoc b/documentation/content/en/books/porters-handbook/testing/_index.adoc index 0f7239536f..4c94b4fc85 100644 --- a/documentation/content/en/books/porters-handbook/testing/_index.adoc +++ b/documentation/content/en/books/porters-handbook/testing/_index.adoc @@ -113,9 +113,7 @@ For a new port, `portlint -A` is the most thorough; for an existing port, `portl Since `portlint` uses heuristics to try to figure out errors, it can produce false positive warnings. In addition, occasionally something that is flagged as a problem really cannot be done in any other way due to limitations in the ports framework. -pass:[<!-- vale Vale.Terms = NO -->] When in doubt, the best thing to do is ask on {freebsd-ports}. -pass:[<!-- vale Vale.Terms = YES -->] [[testing-porttools]] == Port Tools @@ -354,9 +352,7 @@ The command: .... updates the specified jail to the latest version available. -pass:[<!-- vale Vale.Terms = NO -->] For FreeBSD releases, update to the latest patchlevel with man:freebsd-update[8]. -pass:[<!-- vale Vale.Terms = YES -->] For FreeBSD versions built from source, update to the latest git revision in the branch. [TIP] diff --git a/documentation/content/en/books/porters-handbook/versions/_index.adoc b/documentation/content/en/books/porters-handbook/versions/_index.adoc index f7aeec0525..e633ba2fb7 100644 --- a/documentation/content/en/books/porters-handbook/versions/_index.adoc +++ b/documentation/content/en/books/porters-handbook/versions/_index.adoc @@ -4060,9 +4060,7 @@ Template: |1001509 |link:https://svnweb.freebsd.org/changeset/base/279287[279287] |February 25, 2015 -pass:[<!-- vale Vale.Terms = NO -->] |10-STABLE after FreeBSD-EN-15:01.vt, FreeBSD-EN-15:02.openssl, FreeBSD-EN-15:03.freebsd-update, FreeBSD-SA-15:04.igmp, and FreeBSD-SA-15:05.bind. -pass:[<!-- vale Vale.Terms = YES -->] |1001510 |link:https://svnweb.freebsd.org/changeset/base/279329[279329] @@ -4710,9 +4708,7 @@ pass:[<!-- vale Vale.Terms = YES -->] |903508 |link:https://svnweb.freebsd.org/changeset/base/279287[279287] |February 25, 2015 -pass:[<!-- vale Vale.Terms = NO -->] |9-STABLE after FreeBSD-EN-15:01.vt, FreeBSD-EN-15:02.openssl, FreeBSD-EN-15:03.freebsd-update, FreeBSD-SA-15:04.igmp, and FreeBSD-SA-15:05.bind. -pass:[<!-- vale Vale.Terms = YES -->] |903509 |link:https://svnweb.freebsd.org/changeset/base/296219[296219] @@ -5495,9 +5491,7 @@ pass:[<!-- vale Vale.Terms = YES -->] |804508 |link:https://svnweb.freebsd.org/changeset/base/279287[279287] |February 25, 2015 -pass:[<!-- vale Vale.Terms = NO -->] |8-STABLE after FreeBSD-EN-15:01.vt, FreeBSD-EN-15:02.openssl, FreeBSD-EN-15:03.freebsd-update, FreeBSD-SA-15:04.igmp, and FreeBSD-SA-15:05.bind. -pass:[<!-- vale Vale.Terms = YES -->] |804509 |link:https://svnweb.freebsd.org/changeset/base/305736[305736] |