diff options
Diffstat (limited to 'documentation/content')
7 files changed, 60 insertions, 60 deletions
diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index 1adfc46e2b..dc3e6a4679 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -2485,6 +2485,7 @@ A good rule of thumb is to stay below 63 characters, and aim for about 50 or few === Prefix the subject line with a component, if applicable If the change relates to a specific component the subject line may be prefixed with that component name and a colon (:). +If applicable, try to use the same prefix used in previous commits to the same files. ✓ `foo: Add -k option to keep temporary data` @@ -2971,6 +2972,9 @@ You can find out more about Bugzilla at: The FreeBSD Project utilizes https://reviews.freebsd.org[Phabricator] for code review requests. See the https://wiki.freebsd.org/Phabricator[Phabricator wiki page] for details. +Please use the `git arc` command provided by `devel/freebsd-git-devtools` (install the port or package, then type `git help arc` for documentation) to create and update Phabricator reviews. +This will make it easier for others to review and test your patches. + Committers with non-``FreeBSD.org`` Phabricator accounts can have the old account renamed to the ``FreeBSD.org`` account by following these steps: [.procedure] diff --git a/documentation/content/en/articles/pgpkeys/_index.adoc b/documentation/content/en/articles/pgpkeys/_index.adoc index ba59411090..4ce40fbc15 100644 --- a/documentation/content/en/articles/pgpkeys/_index.adoc +++ b/documentation/content/en/articles/pgpkeys/_index.adoc @@ -1431,6 +1431,9 @@ include::{include-path}peter.key[] === `{nwhitehorn}` include::{include-path}nwhitehorn.key[] +=== `{obiwac}` +include::{include-path}obiwac.key[] + === `{miwi}` include::{include-path}miwi.key[] diff --git a/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc b/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc index 6d92e1ccc3..8adaf2fe47 100644 --- a/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc +++ b/documentation/content/en/books/fdp-primer/manual-pages/_index.adoc @@ -569,6 +569,7 @@ Resources for manual page writers: * man:man[1] * man:mandoc[1] +* man:style.mdoc[5] * man:groff_mdoc[7] * http://manpages.bsd.lv/mdoc.html[Practical UNIX Manuals: mdoc] * http://manpages.bsd.lv/history.html[History of UNIX Manpages] diff --git a/documentation/content/en/books/handbook/dtrace/_index.adoc b/documentation/content/en/books/handbook/dtrace/_index.adoc index 844e3b3419..755a21404e 100644 --- a/documentation/content/en/books/handbook/dtrace/_index.adoc +++ b/documentation/content/en/books/handbook/dtrace/_index.adoc @@ -97,7 +97,7 @@ The `ctfconvert` utility parses `DWARF` `ELF` debug sections created by the comp Some different providers exist for FreeBSD than for Solaris(TM). Most notable is the `dtmalloc` provider, which allows tracing man:malloc[9] by type in the FreeBSD kernel. -Some of the providers found in Solaris(TM), such as `cpc` and `mib`, are not present in FreeBSD. +Some of the providers found in Solaris(TM), such as `cpc`, are not present in FreeBSD. These may appear in future versions of FreeBSD. Moreover, some of the providers available in both operating systems are not compatible, in the sense that their probes have different argument types. Thus, `D` scripts written on Solaris(TM) may or may not work unmodified on FreeBSD, and vice versa. diff --git a/documentation/content/en/books/handbook/ports/_index.adoc b/documentation/content/en/books/handbook/ports/_index.adoc index f1e1a2e0d3..ac4cf4ce70 100644 --- a/documentation/content/en/books/handbook/ports/_index.adoc +++ b/documentation/content/en/books/handbook/ports/_index.adoc @@ -99,7 +99,7 @@ Select the technology that meets your requirements for installing a particular a + In some cases, multiple packages will exist for the same application with different settings. For example, NGINX(R) is available as a `nginx` package and a `nginx-lite` package, the former has many more options enabled, but this in turn requires many things to be installed as dependencies for it to work, thus increasing space consumption and attack surface. + -The transitive dependencies can grow quite large, for example the full `nginx` package will pull in several X libraries which can be quite surprising, so building from ports allow you to choose only the options you need without a "kitchen sink" approach.In some cases, multiple packages will exist for the same application to specify certain settings. +The transitive dependencies can grow quite large, for example the full `nginx` package will pull in several X libraries which can be quite surprising, so building from ports allow you to choose only the options you need without a "kitchen sink" approach. In some cases, multiple packages will exist for the same application to specify certain settings. * The licensing conditions of some software forbid binary distribution. Such software must be distributed as source code which must be compiled by the end-user. * Some people do not trust binary distributions or prefer to read through source code in order to look for potential problems. * Source code is needed in order to apply custom patches. diff --git a/documentation/content/en/books/handbook/virtualization/_index.adoc b/documentation/content/en/books/handbook/virtualization/_index.adoc index 01c6eb515f..785aaf4ce6 100644 --- a/documentation/content/en/books/handbook/virtualization/_index.adoc +++ b/documentation/content/en/books/handbook/virtualization/_index.adoc @@ -2063,7 +2063,7 @@ Using `vmrun.sh` on a ZFS filesystems: .... # jexec bhyve # sh /usr/share/examples/bhyve/vmrun.sh -c 1 -m 1024M \ - -t tap100 -d /dev/zvols/zroot/vms/bhyvevm0 -i -I /vms/FreeBSD-14.0-RELEASE-amd64-bootonly.iso bhyvevm0 + -t tap100 -d /dev/zvol/zroot/vms/bhyvevm0 -i -I /vms/FreeBSD-14.0-RELEASE-amd64-bootonly.iso bhyvevm0 .... ==== diff --git a/documentation/content/en/books/porters-handbook/porting-samplem/_index.adoc b/documentation/content/en/books/porters-handbook/porting-samplem/_index.adoc index bc8d531397..d56cd68c99 100644 --- a/documentation/content/en/books/porters-handbook/porting-samplem/_index.adoc +++ b/documentation/content/en/books/porters-handbook/porting-samplem/_index.adoc @@ -49,84 +49,54 @@ include::../../../../../shared/asciidoctor.adoc[] endif::[] Here is a sample [.filename]#Makefile# that can be used to create a new port. -Make sure to remove all the extra comments (ones between brackets). -The format shown is the recommended one for ordering variables, empty lines between sections, and so on. +The format shown is the recommended one for crossref:order[, ordering] variables, empty lines between sections, and so on. This format is designed so that the most important information is easy to locate. -We recommend using crossref:quick-porting[porting-portlint,portlint] to check the [.filename]#Makefile#. +Refer to crossref:testing[, the chapter about testing] to learn more about tools for linting, formatting, and checking the [.filename]#Makefile#. [.programlisting] .... -[section to describe the port itself and the master site - PORTNAME - and PORTVERSION or the DISTVERSION* variables are always first, - followed by CATEGORIES, and then MASTER_SITES, which can be followed - by MASTER_SITE_SUBDIR. PKGNAMEPREFIX and PKGNAMESUFFIX, if needed, - will be after that. Then comes DISTNAME, EXTRACT_SUFX and/or - DISTFILES, and then EXTRACT_ONLY, as necessary.] -PORTNAME= xdvi +PORTNAME= xdvi <1> DISTVERSION= 18.2 CATEGORIES= print -[do not forget the trailing slash ("/")! - if not using MASTER_SITE_* macros] -MASTER_SITES= ${MASTER_SITE_XCONTRIB} +MASTER_SITES= ${MASTER_SITE_XCONTRIB} <2> MASTER_SITE_SUBDIR= applications PKGNAMEPREFIX= ja- DISTNAME= xdvi-pl18 -[set this if the source is not in the standard ".tar.gz" form] -EXTRACT_SUFX= .tar.Z +EXTRACT_SUFX= .tar.Z <3> -[section for distributed patches -- can be empty] -PATCH_SITES= ftp://ftp.sra.co.jp/pub/X11/japanese/ +PATCH_SITES= ftp://ftp.sra.co.jp/pub/X11/japanese/ <4> PATCHFILES= xdvi-18.patch1.gz xdvi-18.patch2.gz -[If the distributed patches were not made relative to ${WRKSRC}, - this may need to be tweaked] -PATCH_DIST_STRIP= -p1 - -[maintainer; *mandatory*! This is the person who is volunteering to - handle port updates, build breakages, and to whom a users can direct - questions and bug reports. To keep the quality of the Ports Collection - as high as possible, we do not accept new ports that are assigned to - "ports@FreeBSD.org".] -MAINTAINER= asami@FreeBSD.org +PATCH_DIST_STRIP= -p1 <5> + +MAINTAINER= asami@FreeBSD.org <6> COMMENT= DVI Previewer for the X Window System WWW= http://xdvi.sourceforge.net/ -[license -- should not be empty] -LICENSE= BSD2CLAUSE +LICENSE= BSD2CLAUSE <7> LICENSE_FILE= ${WRKSRC}/LICENSE -[dependencies -- can be empty] -RUN_DEPENDS= gs:print/ghostscript - -[If it requires GNU make, not /usr/bin/make, to build...] -USES= gmake -[If it is an X application and requires "xmkmf -a" to be run...] -USES= imake - -[this section is for other standard bsd.port.mk variables that do not] - belong to any of the above] -[If it asks questions during configure, build, install...] -IS_INTERACTIVE= yes -[If it extracts to a directory other than ${DISTNAME}...] -WRKSRC= ${WRKDIR}/xdvi-new -[If it requires a "configure" script generated by GNU autoconf to be run] -GNU_CONFIGURE= yes -[et cetera.] - -[If it requires options, this section is for options] +RUN_DEPENDS= gs:print/ghostscript <8> + +USES= gmake <9> + +<10> +IS_INTERACTIVE= yes <11> +WRKSRC= ${WRKDIR}/xdvi-new <12> +GNU_CONFIGURE= yes <13> + +<14> OPTIONS_DEFINE= DOCS EXAMPLES FOO -OPTIONS_DEFAULT= FOO -[If options will change the files in plist] -OPTIONS_SUB=yes +OPTIONS_DEFAULT=FOO +OPTIONS_SUB= yes <15> FOO_DESC= Enable foo support - FOO_CONFIGURE_ENABLE= foo -[non-standard variables to be used in the rules below] +<16> MY_FAVORITE_RESPONSE= "yeah, right" -[then the special rules, in the order they are called] +<17> pre-fetch: i go fetch something, yeah @@ -136,7 +106,29 @@ post-patch: pre-install: and then some more stuff before installing, wow -[and then the epilogue] - -.include <bsd.port.mk> +.include <bsd.port.mk> <18> .... + +<1> Section to describe the port itself and the master site -- `PORTNAME` and `PORTVERSION` or the `DISTVERSION*` variables are always first, followed by `CATEGORIES`, and then `MASTER_SITES`, which can be followed by `MASTER_SITE_SUBDIR`. +`PKGNAMEPREFIX` and `PKGNAMESUFFIX`, if needed, will be after that. +Then comes `DISTNAME`, `EXTRACT_SUFX` and/or `DISTFILES`, and then `EXTRACT_ONLY`, as necessary. +<2> Do not forget the trailing slash (`/`) if not using `MASTER_SITE_*` macros. +<3> Set this if the source is not in the standard ".tar.gz" form. +<4> Section for distributed patches -- can be empty. +<5> If the distributed patches were not made relative to `WRKSRC`, this may need to be tweaked. +<6> Maintainer; *mandatory*! +This is the person who is volunteering to handle port updates, build breakages, and to whom a users can direct questions and bug reports. +To keep the quality of the Ports Collection as high as possible, we do not accept new ports that are assigned to "ports@FreeBSD.org". +<7> License -- should not be empty. +<8> Dependencies -- can be empty. +<9> If the port requires GNU make instead of the default FreeBSD `make` (man:make[1]) to build. +For example, some X applications require `xmkmf -a` to run, in which case the port would need `USES=imake`. +<10> This section is for other standard [.filename]#bsd.port.mk# variables that do not belong to any of the above. +<11> If the ports asks interactive questions during configure, build, install. +<12> If it extracts to a directory other than `DISTNAME`. +<13> If it requires a `configure` script generated by GNU autoconf to be run. +<14> This section is for handling ports options. +<15> Set `OPTIONS_SUB` if options will change the list of files in the crossref:plist[plist-sub, plist]. +<16> Non-standard variables to be used in the rules below. +<17> Special rules, in the order they are called by the ports framework. +<18> Finally, the epilogue. |