diff options
Diffstat (limited to 'release/doc')
25 files changed, 5452 insertions, 0 deletions
diff --git a/release/doc/Makefile b/release/doc/Makefile new file mode 100644 index 0000000..75bc4fd --- /dev/null +++ b/release/doc/Makefile @@ -0,0 +1,38 @@ +# $FreeBSD$ +# +# The user can override the default language to build and install +# with the RELNOTES_LANG variable. +# +.if defined(RELNOTES_LANG) && !empty(RELNOTES_LANG) +SUBDIR+= ${RELNOTES_LANG} +.else +SUBDIR+= en_US.ISO8859-1 +.endif +SUBDIR+= share/xml + +RELN_ROOT?= ${.CURDIR} + +.if exists(/usr/local/bin/svn) +SVN?= /usr/local/bin/svn +.elif exists(/usr/bin/svn) +SVN?= /usr/bin/svn +.else +SVN?= /usr/bin/svnlite +.endif + +SVNFLAGS?= -r HEAD + +update: +.if !exists(${SVN}) + @echo "--------------------------------------------------------------" + @echo ">>> Updating ${RELN_ROOT} requires ${SVN}." + @echo "--------------------------------------------------------------" + @exit 1 +.endif + @echo "--------------------------------------------------------------" + @echo ">>> Updating ${.CURDIR}" + @echo "--------------------------------------------------------------" + @(cd ${.CURDIR} && ${SVN} update ${SVNFLAGS}) + +.include "${RELN_ROOT}/share/mk/doc.relnotes.mk" +.include "${DOC_PREFIX}/share/mk/doc.subdir.mk" diff --git a/release/doc/README b/release/doc/README new file mode 100644 index 0000000..a46779d --- /dev/null +++ b/release/doc/README @@ -0,0 +1,127 @@ +-*- text -*- +RELNOTESng README +Bruce A. Mah <bmah@freebsd.org> +$FreeBSD$ + +This is the top-level directory for RELNOTESng, a re-write of +FreeBSD's *.TXT documentation files. They have been converted to +DocBook, and versions of the documents can be now be built for various +supported architectures. The output files can be rendered in any +format supported by the FreeBSD Documentation Project (for example, +ASCII text, PDF, PS, HTML). + +RELNOTESng requires that the FreeBSD doc/ sources are installed; it +leverages off of much of the DocProj build infrastructure, including +DocBook extensions and stylesheets. If the doc/ sources are not +installed in /usr/src, their location should be specified with the +DOC_PREFIX Makefile variable. RELNOTESng also requires the DocProj +build tools, which can easily be installed with the textproc/docproj +port in the Ports Collection. + +Notable files and directories: + +share/mk/doc.relnotes.mk + Common Makefile definitions for RELNOTESng. These definitions + mostly accommodate the fact that we're building DocProj-like + documents outside the doc/ tree. +share/xml/catalog + Main SGML catalog for all language-neutral (and default EN) + stylesheet and entity files. Can be overridden if needed for + translations. +share/xml/default.dsl + All documents build with this file as a stylesheet. All it + does is to make it possible to use the document catalogs to + locate the "real" stylesheet by reference, rather than having + to specify it by pathname. +share/xml/release.dsl + Language-neutral stylesheet. This stylesheet supports + the arch= attribute on (all?) DocBook elements; elements with + an arch= attribute are only included in the output if their + value is equal to the value of the &arch; entity. In the + future, arch= could be a list of possible &arch; entity values + that match, such as "i386,sparc64". +share/xml/release.ent + Release information. Need to update the entry definitions in + this file when rolling new revisions; these should take effect + in all documents. + +en_US.ISO8859-1/share/xml/release.dsl + Language-dependent stylesheet for en, but also the default for + translations if they don't override the settings here. This + stylesheet sets the email footer at the bottom of HTML pages, + as well as a few other parameters. If necessary for + translations, this file can be overridden with + */share/xml/release.dsl and */share/xml/catalog. + +*/relnotes/common/ + Directory for multi-architecture release notes files. +*/relnotes/*/ + Directories for architecture-specific release notes files. + +*/hardware/common/ + Directory for multi-architecture hardware notes files. +*/hardware/*/ + Directories for architecture-specific hardware notes files. + +*/installation/common/ + Directory for multi-architecture installation notes files. + Note that the FreeBSD DocProj build infrastructure does + not handle documents (or subdirectories) named "install" + well, so we call our document "installation" and do + a hack when it gets installed into a distribution to fix + this up. +*/installation/*/ + Directories for architecture-specific release notes files. + +*/errata/ + Directory for errata document. + +*/readme/ + Directory for (introductory) document. + +If building the release notes "standalone" (in other words, not part +of a release), it may be necessary (depending on the relative +locations of the checked-out src/ and doc/ directories) to set the +DOC_PREFIX Makefile variable to point to the top directory of the doc/ +tree. For example: + + % make DOC_PREFIX=/usr/doc all + +All definition of the "current" version of FreeBSD is contained in the +share/xml/release.ent file; release engineers should peruse the +contents of this file carefully when doing version number bumps. + +When creating content for the architecture-dependent files, authors +should use the arch= attribute to elements that are specific to a +particular machine architecture. The value of this attribute should +be a single word that indicates for which architecture the current +element will be included. For example: + + <para arch="sparc64">SPARC64-specific text</para> + +The currently-supported architectures are amd64, arm, i386, pc98, +powerpc and sparc64. An element may appear for multiple architectures +by specifying a comma-separated list of architectures +(i.e. arch="sparc64,amd64"). + +When creating a translation, make a new directory under this +directory with a language code (paralleling the DocProj directory +structure). If necessary, new language-dependent HTML footers can be +generated by making a new language-dependent +${LANG}/share/xml/release.dsl, a ${LANG}/share/xml/catalog that +points to it, and a new definition in the Makefiles that adds +${LANG}/share/xml/catalog to EXTRA_CATALOGS. Except for the Makefile +changes, this is the same procedure that is used for creating a new +translation for DocProj files. + +RELNOTESng is now enabled by default in the FreeBSD release-build +process. It can be disabled by setting NODOC=YES when building a +release (note that this is the same variable that disables DocProj +documentation builds). + +Release builders can set which language gets built with the +RELNOTES_LANG variable; note that this is different from the +DOC_LANG variable because (at least initially) most languages +will have localized DocProj files but not localized release notes. +The default language, if none is specified, is en_US.ISO8859-1. + diff --git a/release/doc/en_US.ISO8859-1/Makefile b/release/doc/en_US.ISO8859-1/Makefile new file mode 100644 index 0000000..82e5f33 --- /dev/null +++ b/release/doc/en_US.ISO8859-1/Makefile @@ -0,0 +1,16 @@ +# $FreeBSD$ + +RELN_ROOT?= ${.CURDIR}/.. + +SUBDIR = relnotes +SUBDIR+= hardware +SUBDIR+= readme +SUBDIR+= errata + +COMPAT_SYMLINK = en + +LANGCODE=en_US.ISO8859-1 +_LANGCODE=en_US.ISO8859-1 + +.include "${RELN_ROOT}/share/mk/doc.relnotes.mk" +.include "${DOC_PREFIX}/share/mk/doc.project.mk" diff --git a/release/doc/en_US.ISO8859-1/errata/Makefile b/release/doc/en_US.ISO8859-1/errata/Makefile new file mode 100644 index 0000000..036609a --- /dev/null +++ b/release/doc/en_US.ISO8859-1/errata/Makefile @@ -0,0 +1,19 @@ +# $FreeBSD$ + +RELN_ROOT?= ${.CURDIR}/../.. +.ifdef NO_LANGCODE_IN_DESTDIR +DESTDIR?= ${DOCDIR}/errata +.else +DESTDIR?= ${DOCDIR}/en_US.ISO8859-1/errata +.endif + +DOC?= article +FORMATS?= html +INSTALL_COMPRESSED?= gz +INSTALL_ONLY_COMPRESSED?= + +# SGML content +SRCS+= article.xml + +.include "${RELN_ROOT}/share/mk/doc.relnotes.mk" +.include "${DOC_PREFIX}/share/mk/doc.project.mk" diff --git a/release/doc/en_US.ISO8859-1/errata/article.xml b/release/doc/en_US.ISO8859-1/errata/article.xml new file mode 100644 index 0000000..2fdf294 --- /dev/null +++ b/release/doc/en_US.ISO8859-1/errata/article.xml @@ -0,0 +1,100 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook XML V5.0-Based Extension//EN" + "http://www.FreeBSD.org/XML/share/xml/freebsd50.dtd" [ +<!ENTITY % release PUBLIC "-//FreeBSD//ENTITIES Release Specification//EN" + "http://www.FreeBSD.org/release/XML/release.ent"> +%release; +<!ENTITY security SYSTEM "../../share/xml/security.xml"> +<!ENTITY errata SYSTEM "../../share/xml/errata.xml"> +]> + +<article xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + version="5.0"> + <info> + <title>&os; &release; Errata </title> + + <author><orgname>The &os; Project</orgname></author> + + <pubdate>$FreeBSD$</pubdate> + + <copyright> + <year>2015</year> + + <holder role="mailto:doc@FreeBSD.org">The &os; Documentation Project</holder> + </copyright> + + <legalnotice xml:id="trademarks" role="trademarks"> + &tm-attrib.freebsd; + &tm-attrib.intel; + &tm-attrib.sparc; + &tm-attrib.general; + </legalnotice> + + <abstract> + <para>This document lists errata items for &os; &release;, + containing significant information discovered after the release + or too late in the release cycle to be otherwise included in the + release documentation. + This information includes security advisories, as well as news + relating to the software or documentation that could affect its + operation or usability. An up-to-date version of this document + should always be consulted before installing this version of + &os;.</para> + + <para>This errata document for &os; &release; + will be maintained until the release of &os; &release.next;.</para> + </abstract> + </info> + + <sect1 xml:id="intro"> + <title>Introduction</title> + + <para>This errata document contains <quote>late-breaking news</quote> + about &os; &release; + Before installing this version, it is important to consult this + document to learn about any post-release discoveries or problems + that may already have been found and fixed.</para> + + <para>Any version of this errata document actually distributed + with the release (for example, on a CDROM distribution) will be + out of date by definition, but other copies are kept updated on + the Internet and should be consulted as the <quote>current + errata</quote> for this release. These other copies of the + errata are located at + <link xlink:href="https://www.FreeBSD.org/releases/" />, + plus any sites + which keep up-to-date mirrors of this location.</para> + + <para>Source and binary snapshots of &os; &release.branch; also + contain up-to-date copies of this document (as of the time of + the snapshot).</para> + + <para>For a list of all &os; CERT security advisories, see + <link xlink:href="https://www.FreeBSD.org/security/"/>.</para> + </sect1> + + <sect1 xml:id="security"> + <title>Security Advisories</title> + + &security; + </sect1> + + <sect1 xml:id="errata"> + <title>Errata Notices</title> + + &errata; + </sect1> + + <sect1 xml:id="open-issues"> + <title>Open Issues</title> + + <para>No open issues.</para> + </sect1> + + <sect1 xml:id="late-news"> + <title>Late-Breaking News</title> + + <para>No news.</para> + </sect1> +</article> diff --git a/release/doc/en_US.ISO8859-1/hardware/Makefile b/release/doc/en_US.ISO8859-1/hardware/Makefile new file mode 100644 index 0000000..4648146 --- /dev/null +++ b/release/doc/en_US.ISO8859-1/hardware/Makefile @@ -0,0 +1,30 @@ +# $FreeBSD$ + +RELN_ROOT?= ${.CURDIR}/../.. + +.ifdef NO_LANGCODE_IN_DESTDIR +DESTDIR?= ${DOCDIR}/hardware +.else +DESTDIR?= ${DOCDIR}/en_US.ISO8859-1/hardware +.endif + +DOC?= article +FORMATS?= html +INSTALL_COMPRESSED?= gz +INSTALL_ONLY_COMPRESSED?= + +JADEFLAGS+= -V %generate-article-toc% + +# SGML content +SRCS+= article.xml +SRCS+= ${DEV-AUTODIR}/catalog-auto +SRCS+= ${DEV-AUTODIR}/dev-auto.ent + +CATALOGS+= -c ${DEV-AUTODIR}/catalog-auto + +URL_RELPREFIX?= ../../../.. + +HWNOTES_MI= 1 + +.include "${RELN_ROOT}/share/mk/doc.relnotes.mk" +.include "${DOC_PREFIX}/share/mk/doc.project.mk" diff --git a/release/doc/en_US.ISO8859-1/hardware/article.xml b/release/doc/en_US.ISO8859-1/hardware/article.xml new file mode 100644 index 0000000..4b66434 --- /dev/null +++ b/release/doc/en_US.ISO8859-1/hardware/article.xml @@ -0,0 +1,1659 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook XML V5.0-Based Extension//EN" + "../../../share/xml/freebsd50.dtd" [ +<!ENTITY % release PUBLIC "-//FreeBSD//ENTITIES Release Specification//EN" "release.ent"> +%release; +<!ENTITY % devauto PUBLIC "-//FreeBSD//ENTITIES Auto Generated Device Lists//EN" "nonexistent"> +%devauto; +]> +<article xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> + <info><title>&os; &release.current; Hardware Notes</title> + + + <author><orgname>The &os; Documentation Project</orgname></author> + + <pubdate>$FreeBSD$</pubdate> + + <copyright> + <year>2000</year> + <year>2001</year> + <year>2002</year> + <year>2003</year> + <year>2004</year> + <year>2005</year> + <year>2006</year> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <year>2011</year> + <year>2012</year> + <year>2013</year> + <year>2014</year> + <holder role="mailto:doc@FreeBSD.org">The &os; Documentation Project</holder> + </copyright> + + <legalnotice xml:id="trademarks" role="trademarks"> + &tm-attrib.freebsd; + &tm-attrib.amd; + &tm-attrib.fujitsu; + &tm-attrib.ibm; + &tm-attrib.intel; + &tm-attrib.sparc; + &tm-attrib.sun; + &tm-attrib.general; + </legalnotice> + + </info> + + <sect1 xml:id="intro"> + <title>Introduction</title> + + <para>This document contains the hardware compatibility notes for + &os; &release.current;. It lists the hardware platforms + supported by &os;, as well as the various types of hardware + devices (storage controllers, network interfaces, and so on), + along with known working instances of these devices.</para> + </sect1> + + <sect1 xml:id="proc"> + <title>Supported Processors and System Boards</title> + + <para>This section provides some architecture-specific information + about the specific processors and systems that are supported by + each architecture.</para> + + <sect2 xml:id="proc-amd64"> + <title>amd64</title> + + <para>Since mid-2003 &os;/&arch.amd64; has supported the AMD64 + (<quote>Hammer</quote>) and &intel; EM64T architecture, and is + now one of the Tier-1 platforms (fully supported + architecture), which are expected to be Production Quality + with respects to all aspects of the &os; operating system, + including installation and development environments.</para> + + <para>Note that there are two names for this architecture, AMD64 + (AMD) and Intel EM64T (Extended Memory 64-bit Technology). + 64-bit mode of the two architectures are almost compatible + with each other, and &os;/&arch.amd64; supports them + both.</para> + + <para>As of this writing, the following processors are + supported:</para> + + <itemizedlist> + <listitem> + <para>&amd.athlon;64 (<quote>Clawhammer</quote>).</para> + </listitem> + + <listitem> + <para>&amd.opteron; (<quote>Sledgehammer</quote>).</para> + </listitem> + + <listitem> + <para>&amd.sempron;.</para> + </listitem> + + <listitem> + <para>&amd.turion;.</para> + </listitem> + + <listitem> + <para>&amd.phenom;.</para> + </listitem> + + <listitem> + <para>All multi-core &intel; &xeon; processors except + Sossaman have EM64T support.</para> + </listitem> + + <listitem> + <para>The single-core &intel; &xeon; + processors <quote>Nocona</quote>, <quote>Irwindale</quote>, + <quote>Potomac</quote>, and <quote>Cranford</quote> have + EM64T support.</para> + </listitem> + + <listitem> + <para>All &intel; &core; 2 (not &core; Duo) and later + processors</para> + </listitem> + + <listitem> + <para>All &intel; &core; i range of processors</para> + </listitem> + + <listitem> + <para>All &intel; &pentium; D processors</para> + </listitem> + + <listitem> + <para>All &intel; ¢rino; Duo and ¢rino; Pro platforms</para> + </listitem> + + <listitem> + <para>&intel; &pentium; 4s and &celeron; Ds using + the <quote>Cedar Mill</quote> core have EM64T + support.</para> + </listitem> + + <listitem> + <para>Some &intel; &pentium; 4s and &celeron; Ds using + the <quote>Prescott</quote> core have EM64T support. See + the <link xlink:href="http://processorfinder.intel.com">Intel + Processor Spec Finder</link> for the definitive answer about + EM64T support in Intel processors.</para> + </listitem> + + </itemizedlist> + + <para>&intel; EM64T is an extended version of IA-32 (x86) and + different from &intel; IA-64 (Itanium) architecture. Some + &intel;'s old documentation refers to &intel; EM64T as + <quote>64-bit extension technology</quote> or + <quote>IA-32e</quote>.</para> + + <para>Both Uniprocessor (UP) and Symmetric Multi-processor (SMP) + configurations are supported.</para> + + <para>In many respects, &os;/&arch.amd64; is similar to + &os;/&arch.i386;, in terms of drivers supported. Generally, + drivers that already function correctly on other 64-bit + platforms should work.</para> + + </sect2> + + <sect2 xml:id="proc-i386"> + <title>i386</title> + + <para>&os;/&arch.i386; runs on a wide variety of <quote>IBM PC + compatible</quote> machines. Due to the wide range of + hardware available for this architecture, it is impossible + to exhaustively list all combinations of equipment supported + by &os;. Nevertheless, some general guidelines are + presented here.</para> + + <para>Almost all &i386;-compatible processors with a floating + point unit are supported. All &intel; processors beginning + with the 80486 are supported, including the 80486, &pentium;, + &pentium; Pro, &pentium; II, &pentium; III, &pentium; 4, and + variants thereof, such as the &xeon; and &celeron; processors. + All &i386;-compatible AMD processors are also supported, + including the &am486;, &am5x86;, K5, &amd.k6; (and variants), + &amd.athlon; (including Athlon-MP, Athlon-XP, Athlon-4, and + Athlon Thunderbird), and &amd.duron; processors. The AMD + Élan SC520 embedded processor is supported. The + Transmeta Crusoe is recognized and supported, as are + &i386;-compatible processors from Cyrix and NexGen.</para> + + <para>There is a wide variety of motherboards available for this + architecture. Motherboards using the ISA, VLB, EISA, AGP, and + PCI expansion buses are well-supported. There is some + limited support for the MCA (<quote>MicroChannel</quote>) + expansion bus used in the IBM PS/2 line of PCs.</para> + + <para>Symmetric multi-processor (SMP) systems are generally + supported by &os;, although in some cases, BIOS or motherboard + bugs may generate some problems. Perusal of the archives of + the &a.smp; may yield some clues.</para> + + <para>&os; will take advantage of SMT (Symmetric MultiThreading, + also known as HyperThreading on &intel; CPUs) on the supported + CPUs. The <filename>GENERIC</filename> kernel which is + installed by default will automatically detect the additional + logical processors. The default &os; scheduler recognizes + processor topology on the system and selects logical and + physical processors to obtain optimal performance. + The &man.smp.4; manual page has more details.</para> + + <para>&os; will take advantage of Physical Address Extensions + (PAE) support on CPUs that support this feature. A kernel + with the <literal>PAE</literal> feature enabled will detect + memory above 4 gigabytes and allow it to be used by the + system. This feature places constraints on the device drivers + and other features of &os; which may be used; consult the + &man.pae.4; manual page for more details.</para> + + <para>&os; will generally run on i386-based laptops, albeit with + varying levels of support for certain hardware features such + as sound, graphics, power management, and PCCARD expansion + slots. These features tend to vary in idiosyncratic ways + between machines, and frequently require special-case support + in &os; to work around hardware bugs or other oddities. When + in doubt, a search of the archives of the &a.mobile; may be + useful.</para> + + <para>Most modern laptops (as well as many desktops) use the + Advanced Configuration and Power Management (ACPI) standard. + &os; supports ACPI via the ACPI Component Architecture + reference implementation from &intel;, as described in the + &man.acpi.4; manual page. The use of ACPI causes + instabilities on some machines and it may be necessary to + disable the ACPI driver, which is normally loaded via a kernel + module. This may be accomplished by adding the following line + to <filename>/boot/device.hints</filename>:</para> + + <programlisting>hint.acpi.0.disabled="1"</programlisting> + + <para>Users debugging ACPI-related problems may find it useful + to disable portions of the ACPI functionality. The + &man.acpi.4; manual page has more information on how to do + this via loader tunables.</para> + + <para>ACPI depends on a Differentiated System Descriptor Table + (DSDT) provided by each machine's BIOS. Some machines have + bad or incomplete DSDTs, which prevents ACPI from functioning + correctly. Replacement DSDTs for some machines can be found + at the <link xlink:href="http://acpi.sourceforge.net/dsdt/index.php">DSDT</link> + section of the <link xlink:href="http://acpi.sourceforge.net/">ACPI4Linux</link> project + Web site. &os; can use these DSDTs to override the DSDT + provided by the BIOS; see the &man.acpi.4; manual page for + more information.</para> + </sect2> + + <sect2 xml:id="proc-pc98"> + <title>pc98</title> + + <para>NEC PC-9801/9821 series with almost all &i386;-compatible + processors, including 80486, &pentium;, &pentium; Pro, + &pentium; II, and variants. All &i386;-compatible processors + by AMD, Cyrix, IBM, and IDT are also supported.</para> + + <para>NEC FC-9801/9821 series, and NEC SV-98 series (both of + them are compatible with PC-9801/9821 series) should be + supported.</para> + + <para>EPSON PC-386/486/586 series, which are compatible with NEC + PC-9801 series are supported.</para> + + <para>High-resolution mode is not supported. NEC + PC-98XA/XL/RL/XL^2, and NEC PC-H98 series are supported in + normal (PC-9801 compatible) mode only.</para> + + <para>Although there are some multi-processor systems (such as + Rs20/B20), SMP-related features of &os; are not supported + yet.</para> + + <para>PC-9801/9821 standard bus (called C-Bus), PC-9801NOTE + expansion bus (110pin), and PCI bus are supported. New Extend + Standard Architecture (NESA) bus (used in PC-H98, SV-H98, and + FC-H98 series) is not supported.</para> + </sect2> + + <sect2 xml:id="proc-powerpc"> + <title>powerpc</title> + + <para>All Apple PowerPC machines with built-in USB are supported, + as well a limited selection of non-Apple machines, + including KVM on POWER7</para> + + <para>SMP is supported on all systems with more than + 1 processor.</para> + </sect2> + + <sect2 xml:id="proc-sparc64"> + <title>sparc64</title> + + <para>This section describes the systems currently known to be + supported by &os; on the Fujitsu &sparc64; and Sun &ultrasparc; + platforms.</para> + + <para>SMP is supported on all systems with more than 1 + processor.</para> + + <para>When using the <filename>GENERIC</filename> kernel, + &os;/&arch.sparc64; systems not equipped with a framebuffer + supported by the &man.creator.4; (Sun Creator, Sun Creator3D + and Sun Elite3D) or &man.machfb.4; (Sun PGX and Sun PGX64 + as well as the ATI Mach64 chips found onboard in for example + &sun.blade; 100, &sun.blade; 150, &sun.ultra; 5 and &sun.ultra; 10) + driver must use the serial console.</para> + + <para>If you have a system that is not listed here, it may not + have been tested with &os; &release.current;. We encourage + you to try it and send a note to the &a.sparc; with your + results, including which devices work and which do not.</para> + + <para>The following systems are fully supported by &os;:</para> + + <itemizedlist> + <listitem> + <para>Naturetech GENIALstation 777S</para> + </listitem> + + <listitem> + <para>&sun.blade; 100</para> + </listitem> + + <listitem> + <para>&sun.blade; 150</para> + </listitem> + + <listitem> + <para>&sun.enterprise; 150</para> + </listitem> + + <listitem> + <para>&sun.enterprise; 220R</para> + </listitem> + + <listitem> + <para>&sun.enterprise; 250</para> + </listitem> + + <listitem> + <para>&sun.enterprise; 420R</para> + </listitem> + + <listitem> + <para>&sun.enterprise; 450</para> + </listitem> + + <listitem> + <para>&sun.fire; B100s (support for the on-board NICs first + appeared in 8.1-RELEASE)</para> + </listitem> + + <listitem> + <para>&sun.fire; V100</para> + </listitem> + + <listitem> + <para>&sun.fire; V120</para> + </listitem> + + <listitem> + <para>Sun &netra; t1 100/105</para> + </listitem> + + <listitem> + <para>Sun &netra; T1 AC200/DC200</para> + </listitem> + + <listitem> + <para>Sun &netra; t 1100</para> + </listitem> + + <listitem> + <para>Sun &netra; t 1120</para> + </listitem> + + <listitem> + <para>Sun &netra; t 1125</para> + </listitem> + + <listitem> + <para>Sun &netra; t 1400/1405</para> + </listitem> + + <listitem> + <para>Sun &netra; 120</para> + </listitem> + + <listitem> + <para>Sun &netra; X1</para> + </listitem> + + <listitem> + <para>Sun &sparcengine; Ultra AX1105</para> + </listitem> + + <listitem> + <para>Sun &sparcengine; Ultra AXe</para> + </listitem> + + <listitem> + <para>Sun &sparcengine; Ultra AXi</para> + </listitem> + + <listitem> + <para>Sun &sparcengine; Ultra AXmp</para> + </listitem> + + <listitem> + <para>Sun &sparcengine; CP1500</para> + </listitem> + + <listitem> + <para>&sun.ultra; 1</para> + </listitem> + + <listitem> + <para>&sun.ultra; 1E</para> + </listitem> + + <listitem> + <para>&sun.ultra; 2</para> + </listitem> + + <listitem> + <para>&sun.ultra; 5</para> + </listitem> + + <listitem> + <para>&sun.ultra; 10</para> + </listitem> + + <listitem> + <para>&sun.ultra; 30</para> + </listitem> + + <listitem> + <para>&sun.ultra; 60</para> + </listitem> + + <listitem> + <para>&sun.ultra; 80</para> + </listitem> + + <listitem> + <para>&sun.ultra; 450</para> + </listitem> + </itemizedlist> + + <para>The following systems are partially supported by &os;. In + particular the fiber channel controllers in SBus-based systems are not + supported. However, it is possible to use these with a SCSI controller + supported by the &man.esp.4; driver (Sun ESP SCSI, Sun FAS Fast-SCSI + and Sun FAS366 Fast-Wide SCSI controllers).</para> + + <itemizedlist> + <listitem> + <para>&sun.enterprise; 3500</para> + </listitem> + + <listitem> + <para>&sun.enterprise; 4500</para> + </listitem> + </itemizedlist> + + <para>Starting with 7.2-RELEASE, &arch.sparc64; systems based on Sun + &ultrasparc; III and beyond are also supported by &os;, which includes + the following known working systems:</para> + + <itemizedlist> + <listitem> + <para>&sun.blade; 1000</para> + </listitem> + + <listitem> + <para>&sun.blade; 1500</para> + </listitem> + + <listitem> + <para>&sun.blade; 2000</para> + </listitem> + + <listitem> + <para>&sun.blade; 2500</para> + </listitem> + + <listitem> + <para>&sun.fire; 280R</para> + </listitem> + + <listitem> + <para>&sun.fire; V210</para> + </listitem> + + <listitem> + <para>&sun.fire; V215 (support first appeared in 7.3-RELEASE and 8.1-RELEASE)</para> + </listitem> + + <listitem> + <para>&sun.fire; V240</para> + </listitem> + + <listitem> + <para>&sun.fire; V245 (support first appeared in 7.3-RELEASE and 8.1-RELEASE)</para> + </listitem> + + <listitem> + <para>&sun.fire; V250</para> + </listitem> + + <listitem> + <para>&sun.fire; V440 (support for the on-board NICs first + appeared in 7.3-RELEASE and 8.0-RELEASE)</para> + </listitem> + + <listitem> + <para>&sun.fire; V480 (501-6780 and 501-6790 centerplanes only, for + which support first appeared in 7.3-RELEASE and 8.1-RELEASE, + other centerplanes might work beginning with 8.3-RELEASE and 9.0-RELEASE)</para> + </listitem> + + <listitem> + <para>&sun.fire; V880</para> + </listitem> + + <listitem> + <para>&sun.fire; V890 (support first appeared in 7.4-RELEASE and 8.1-RELEASE, + non-mixed &ultrasparc; IV/IV+ CPU-configurations only)</para> + </listitem> + + <listitem> + <para>&netra; 20/&netra; T4</para> + </listitem> + </itemizedlist> + + <para>The following Sun &ultrasparc; systems are not tested but + believed to be also supported by &os;:</para> + + <itemizedlist> + <listitem> + <para>&sun.fire; V125</para> + </listitem> + + <listitem> + <para>&sun.fire; V490 (support first appeared in 7.4-RELEASE and 8.1-RELEASE, + non-mixed &ultrasparc; IV/IV+ CPU-configurations only)</para> + </listitem> + </itemizedlist> + + <para>Starting with 7.4-RELEASE and 8.1-RELEASE, &arch.sparc64; systems based on + Fujitsu &sparc64; V are also supported by &os;, which + includes the following known working systems:</para> + + <itemizedlist> + <listitem> + <para>Fujitsu &primepower; 250</para> + </listitem> + </itemizedlist> + + <para>The following Fujitsu &primepower; systems are not tested but + believed to be also supported by &os;:</para> + + <itemizedlist> + <listitem> + <para>Fujitsu &primepower; 450</para> + </listitem> + + <listitem> + <para>Fujitsu &primepower; 650</para> + </listitem> + + <listitem> + <para>Fujitsu &primepower; 850</para> + </listitem> + </itemizedlist> + + </sect2> + </sect1> + + <!-- + + The "Supported Devices" section of the release notes. + Generally processor-independent, with conditional text + inclusion handling any architecture-dependent text. + + Within each subsection describing a class of hardware + (i.e. Ethernet interfaces), list broad groups of devices + alphabetically as paragraphs sorted alphabetically (frequently + these groups will be arranged by manufacturer, i.e. 3Com + Ethernet interfaces). + + Where applicable, a "Miscellaneous" section may follow all + other named sections. + + These guidelines are not hard-and-fast rules, and exceptions + will occur. Following these guidelines (vague as they may be) + is highly recommended to try to keep the formatting of + this section consistent. + + We give manpage references using the &man entities where + possible. If a driver has no manpage (and consequently no + &man entity, we simply give the name of the driver). + Please avoid doing &man entity conversions unless you + know for sure that an entity and manpage exist; sweeps through + this file to fix "missed" conversions are likely to break the + build. + --> + + <sect1 xml:id="support"> + <title>Supported Devices</title> + + <para>This section describes the devices currently known to be + supported by &os;. Other configurations may also work, but + simply have not been tested yet. Feedback, updates, and + corrections to this list are encouraged.</para> + + <para>Where possible, the drivers applicable to each device or + class of devices is listed. If the driver in question has a + manual page in the &os; base distribution (most should), it is + referenced here. Information on specific models of supported + devices, controllers, etc. can be found in the manual + pages.</para> + + <note> + <para>The device lists in this document are being generated + automatically from &os; manual pages. This means that some + devices, which are supported by multiple drivers, may appear + multiple times.</para> + </note> + + <sect2 xml:id="disk"> + <title>Disk Controllers</title> + + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;, &arch.sparc64;] + IDE/ATA controllers (&man.ata.4; driver)</para> + + <para>[&arch.pc98;] IDE/ATA controllers (wdc driver)</para> + + <itemizedlist> + <listitem> + <para>On-board IDE controller</para> + </listitem> + </itemizedlist> + + &hwlist.aac; + + &hwlist.adv; + + &hwlist.adw; + + &hwlist.aha; + + &hwlist.ahb; + + &hwlist.ahc; + + &hwlist.ahci; + + &hwlist.ahd; + + &hwlist.aic; + + &hwlist.amr; + + &hwlist.arcmsr; + + &hwlist.bt; + + &hwlist.ciss; + + &hwlist.ct; + + &hwlist.dpt; + + <note> + <para>[&arch.amd64;, &arch.i386;] Booting from these + controllers is supported. EISA adapters are not + supported.</para> + </note> + + &hwlist.esp; + + &hwlist.hpt27xx; + + &hwlist.hptiop; + + &hwlist.hptmv; + + &hwlist.hptrr; + + &hwlist.ida; + + &hwlist.iir; + + &hwlist.ips; + + &hwlist.isci; + + &hwlist.isp; + + &hwlist.mfi; + + &hwlist.mlx; + + <note> + <para>[&arch.amd64;, &arch.i386;] Booting from these + controllers is supported. EISA adapters are not + supported.</para> + </note> + + &hwlist.mly; + + &hwlist.mpr; + + &hwlist.mps; + + &hwlist.mpt; + + &hwlist.mrsas; + + &hwlist.mvs; + + &hwlist.ncr; + + &hwlist.ncv; + + &hwlist.nsp; + + &hwlist.pms; + + &hwlist.pst; + + &hwlist.siis; + + &hwlist.stg; + + &hwlist.sym; + + &hwlist.trm; + + &hwlist.twa; + + &hwlist.twe; + + &hwlist.tws; + + &hwlist.vpo; + + <para>[&arch.i386;] The wds(4) driver supports the WD7000 SCSI + controller.</para> + + <para>With all supported SCSI controllers, full support is + provided for SCSI-I, SCSI-II, and SCSI-III peripherals, + including hard disks, optical disks, tape drives (including + DAT, 8mm Exabyte, Mammoth, and DLT), medium changers, + processor target devices and CD-ROM drives. WORM devices that + support CD-ROM commands are supported for read-only access by + the CD-ROM drivers (such as &man.cd.4;). WORM/CD-R/CD-RW + writing support is provided by &man.cdrecord.1;, which is a + part of the <package>sysutils/cdrtools</package> port in the Ports + Collection.</para> + + <para>The following CD-ROM type systems are supported at this + time:</para> + + <itemizedlist> + <listitem> + <para>SCSI interface (also includes ProAudio Spectrum and + SoundBlaster SCSI) (&man.cd.4;)</para> + </listitem> + + <listitem> + <para>[&arch.i386;] Sony proprietary interface (all models) + (&man.scd.4;)</para> + </listitem> + + <listitem> + <para>ATAPI IDE interface (&man.acd.4;)</para> + </listitem> + </itemizedlist> + + <para>[&arch.i386;] The following device is unmaintained:</para> + + <itemizedlist> + <listitem> + <para>Mitsumi proprietary CD-ROM interface (all models) + (&man.mcd.4;)</para> + </listitem> + </itemizedlist> + </sect2> + + <sect2 xml:id="ethernet"> + <title>Ethernet Interfaces</title> + + &hwlist.ae; + + &hwlist.age; + + &hwlist.ale; + + &hwlist.aue; + + &hwlist.axe; + + <para>ASIX Electronics AX88178A/AX88179 USB Gigabit Ethernet + adapters (&man.axge.4; driver)</para> + + &hwlist.bce; + + <para>[&arch.amd64;, &arch.i386;] Broadcom BCM4401 based Fast + Ethernet adapters (&man.bfe.4; driver)</para> + + &hwlist.bge; + + &hwlist.bxe; + + &hwlist.cas; + + &hwlist.cdce; + + <para>[&arch.amd64;, &arch.i386;] Crystal Semiconductor + CS89x0-based NICs (&man.cs.4; driver)</para> + + &hwlist.cue; + + &hwlist.cxgb; + + &hwlist.dc; + + &hwlist.de; + + &hwlist.ed; + + &hwlist.em; + + &hwlist.ep; + + <para>Agere ET1310 Gigabit Ethernet adapters + (&man.et.4; driver)</para> + + &hwlist.ex; + + &hwlist.fe; + + &hwlist.fxp; + + &hwlist.gem; + + &hwlist.hme; + + &hwlist.ie; + + &hwlist.igb; + + &hwlist.ipheth; + + &hwlist.ixgb; + + &hwlist.ixgbe; + + &hwlist.jme; + + &hwlist.kue; + + &hwlist.lge; + + &hwlist.msk; + + &hwlist.mxge; + + &hwlist.my; + + &hwlist.nfe; + + &hwlist.nge; + + &hwlist.nxge; + + &hwlist.oce; + + &hwlist.pcn; + + &hwlist.qlxgb; + + &hwlist.qlxgbe; + + &hwlist.qlxge; + + &hwlist.re; + + &hwlist.rl; + + &hwlist.rue; + + &hwlist.sf; + + &hwlist.sfxge; + + &hwlist.sge; + + &hwlist.sis; + + &hwlist.sk; + + &hwlist.smsc; + + &hwlist.sn; + + &hwlist.snc; + + &hwlist.ste; + + &hwlist.stge; + + &hwlist.ti; + + &hwlist.tl; + + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] SMC 83c17x + (EPIC)-based Ethernet NICs (&man.tx.4; driver)</para> + + &hwlist.txp; + + &hwlist.udav; + + &hwlist.urndis; + + &hwlist.vge; + + &hwlist.vr; + + &hwlist.vte; + + &hwlist.vx; + + &hwlist.vxge; + + &hwlist.wb; + + &hwlist.xe; + + &hwlist.xl; + + </sect2> + + <sect2 xml:id="fddi"> + <title>FDDI Interfaces</title> + + <para>[&arch.i386;, &arch.pc98;] DEC DEFPA PCI (&man.fpa.4; + driver)</para> + + <para>[&arch.i386;] DEC DEFEA EISA (&man.fpa.4; driver)</para> + </sect2> + + <sect2 xml:id="atm"> + <title>ATM Interfaces</title> + + <para>[&arch.i386;, &arch.pc98;] Midway-based ATM interfaces + (&man.en.4; driver)</para> + + <para>[&arch.i386;, &arch.pc98; &arch.sparc64;] FORE Systems, + Inc. PCA-200E ATM PCI Adapters (hfa and &man.fatm.4; + drivers)</para> + + <para>[&arch.i386;, &arch.pc98;] IDT NICStAR 77201/211-based ATM + Adapters (&man.idt.4; driver)</para> + + <para>[&arch.i386;, &arch.pc98; &arch.sparc64;] FORE Systems, + Inc. HE155 and HE622 ATM interfaces (&man.hatm.4; + driver)</para> + + <para>[&arch.i386;, &arch.pc98;] IDT77252-based ATM cards + (&man.patm.4; driver)</para> + </sect2> + + <sect2 xml:id="wlan"> + <title>Wireless Network Interfaces</title> + + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] Cisco/Aironet + 802.11b wireless adapters (&man.an.4; driver)</para> + + &hwlist.ath; + + &hwlist.bwi; + + &hwlist.bwn; + + <para>[&arch.i386;, &arch.amd64;] Intel PRO/Wireless 2100 + MiniPCI network adapter (&man.ipw.4; driver)</para> + + <para>[&arch.i386;, &arch.amd64;] Intel PRO/Wireless + 2200BG/2915ABG MiniPCI and 2225BG PCI network adapters + (&man.iwi.4; driver)</para> + + <para>[&arch.i386;, &arch.amd64;] Intel Dual Band Wireless AC + 3160/7260/7265 IEEE 802.11ac network adapters (&man.iwm.4; + driver)</para> + + <para>[&arch.i386;, &arch.amd64;] Intel Wireless WiFi Link + 4965AGN IEEE 802.11n PCI network adapters + (&man.iwn.4; driver)</para> + + <para>[&arch.i386;, &arch.amd64;] Marvell Libertas IEEE 802.11b/g + PCI network adapters (&man.malo.4; driver)</para> + + <para>Marvell 88W8363 IEEE 802.11n wireless network + adapters (&man.mwl.4; driver)</para> + + &hwlist.otus; + + &hwlist.ral; + + &hwlist.rsu; + + <para>Realtek RTL8188CE based PCIe IEEE 802.11b/g/n wireless network + adapters (&man.rtwn.4; driver)</para> + + &hwlist.rum; + + &hwlist.run; + + &hwlist.uath; + + &hwlist.upgt; + + &hwlist.ural; + + &hwlist.urtw; + + &hwlist.urtwn; + + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] Lucent + Technologies WaveLAN/IEEE 802.11b wireless network adapters + and workalikes using the Lucent Hermes, Intersil PRISM-II, + Intersil PRISM-2.5, Intersil Prism-3, and Symbol Spectrum24 + chipsets (&man.wi.4; driver)</para> + + <para>[&arch.i386;] NCR / AT&T / Lucent Technologies WaveLan + T1-speed ISA/radio LAN cards (&man.wl.4; driver)</para> + + <para>[&arch.i386;, &arch.amd64;] Intel PRO/Wireless 3945ABG + MiniPCI network adapters (&man.wpi.4; driver)</para> + + &hwlist.zyd; + </sect2> + + <sect2 xml:id="misc-network"> + <title>Miscellaneous Networks</title> + + &hwlist.ce; + + &hwlist.cx; + + &hwlist.cp; + + &hwlist.ctau; + + &hwlist.cm; + </sect2> + + <sect2 xml:id="serial"> + <title>Serial Interfaces</title> + + <para>[&arch.amd64;, &arch.i386;] <quote>PC standard</quote> + 8250, 16450, and 16550-based serial ports (&man.sio.4; + driver)</para> + + &hwlist.uart; + + &hwlist.scc; + + <para>[&arch.amd64;, &arch.i386;] AST 4 port serial card using + shared IRQ</para> + + <itemizedlist> + <listitem> + <para>ARNET 8 port serial card using shared IRQ</para> + </listitem> + + <listitem> + <para>ARNET (now Digiboard) Sync 570/i high-speed + serial</para> + </listitem> + </itemizedlist> + + <para>[&arch.i386;] Boca multi-port serial cards</para> + + <itemizedlist> + <listitem> + <para>Boca BB1004 4-Port serial card (Modems + <emphasis>not</emphasis> supported)</para> + </listitem> + + <listitem> + <para>Boca IOAT66 6-Port serial card (Modems + supported)</para> + </listitem> + + <listitem> + <para>Boca BB1008 8-Port serial card (Modems + <emphasis>not</emphasis> supported)</para> + </listitem> + + <listitem> + <para>Boca BB2016 16-Port serial card (Modems + supported)</para> + </listitem> + </itemizedlist> + + <para>[&arch.i386;] Comtrol Rocketport card (&man.rp.4; + driver)</para> + + <para>[&arch.i386;] Cyclades Cyclom-Y serial board (&man.cy.4; + driver)</para> + + <para>[&arch.i386;] STB 4 port card using shared IRQ</para> + + <para>[&arch.i386;] DigiBoard intelligent serial cards (digi + driver)</para> + + <para>[&arch.amd64;, &arch.i386;] PCI-Based multi-port serial + boards (&man.puc.4; driver)</para> + + <itemizedlist> + <listitem> + <para>[&arch.amd64;, &arch.i386;] Actiontech 56K PCI</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] Avlab Technology, PCI IO 2S + and PCI IO 4S</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] Comtrol RocketPort 550</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] Decision Computers PCCOM + 4-port serial and dual port RS232/422/485</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] Dolphin Peripherals + 4025/4035/4036</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] IC Book Labs Dreadnought + 16x Lite and Pro</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] Lava Computers + 2SP-PCI/DSerial-PCI/Quattro-PCI/Octopus-550</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] Middle Digital, Weasle + serial port</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] Moxa Industio CP-114, + Smartio C104H-PCI and C168H/PCI</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] NEC PK-UG-X001 and + PK-UG-X008</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] Netmos NM9835 + PCI-2S-550</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] Oxford Semiconductor + OX16PCI954 PCI UART</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] Syba Tech SD-LAB + PCI-4S2P-550-ECP</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] SIIG Cyber I/O PCI + 16C550/16C650/16C850</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] SIIG Cyber 2P1S PCI + 16C550/16C650/16C850</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] SIIG Cyber 2S1P PCI + 16C550/16C650/16C850</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] SIIG Cyber 4S PCI + 16C550/16C650/16C850</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] SIIG Cyber Serial (Single + and Dual) PCI 16C550/16C650/16C850</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] Syba Tech + Ltd. PCI-4S2P-550-ECP</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] Titan PCI-200H and + PCI-800H</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] US Robotics (3Com) 3CP5609 + modem</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] VScom PCI-400 and + PCI-800</para> + </listitem> + </itemizedlist> + + &hwlist.rc; + + <para>[&arch.i386;, &arch.amd64;] Specialix SI/XIO/SX multiport + serial cards, with both the older SIHOST2.x and the + <quote>enhanced</quote> (transputer based, aka JET) host cards + (ISA, EISA and PCI) are supported. Note that the newer SX+ + PCI cards are not currently supported. (&man.si.4; + driver)</para> + + <para>[&arch.pc98;] Internel serial interfaces (&man.sio.4; + driver)</para> + + <itemizedlist> + <listitem> + <para>PC-9801 on-board</para> + </listitem> + <listitem> + <para>PC-9821 2'nd CCU (flags 0x12000000)</para> + </listitem> + </itemizedlist> + + <para>[&arch.pc98;] NEC PC-9861K, PC-9801-101 and Midori-Denshi + MDC-926Rs (&man.sio.4; driver)</para> + + <itemizedlist> + <listitem> + <para>COM2 (flags 0x01000000)</para> + </listitem> + + <listitem> + <para>COM3 (flags 0x02000000)</para> + </listitem> + </itemizedlist> + + <para>[&arch.pc98;] NEC PC-9801-120 (&man.sio.4; driver)</para> + + <note> + <para>"flags 0x11000000" is necessary in kernel + configuration.</para> + </note> + + <para>[&arch.pc98;] Microcore MC-16550, MC-16550II, MC-RS98 + (&man.sio.4; driver)</para> + + <note> + <para>"flags 0x14000?01" is necessary in kernel + configuration.</para> + </note> + + <para>[&arch.pc98;] Media Intelligent RSB-2000, RSB-3000 and + AIWA B98-02 (&man.sio.4; driver)</para> + + <note> + <para>"flags 0x15000?01" is necessary in kernel + configuration.</para> + </note> + + <para>[&arch.pc98;] Media Intelligent RSB-384 (&man.sio.4; + driver)</para> + + <note> + <para>"flags 0x16000001" is necessary in kernel + configuration.</para> + </note> + + <para>[&arch.pc98;] I-O DATA RSA-98III (&man.sio.4; + driver)</para> + + <note> + <para>"flags 0x18000?01" is necessary in kernel + configuration.</para> + </note> + + <para>[&arch.pc98;] Hayes ESP98 (&man.sio.4; driver)</para> + + <note> + <para>"options COM_ESP" and "flags 0x19000000" are necessary + in kernel configuration.</para> + </note> + + </sect2> + + <sect2 xml:id="sound"> + <title>Sound Devices</title> + + &hwlist.snd.ad1816; + + &hwlist.snd.als4000; + + &hwlist.snd.atiixp; + + &hwlist.snd.audiocs; + + &hwlist.snd.cmi; + + &hwlist.snd.cs4281; + + &hwlist.snd.csa; + + &hwlist.snd.ds1; + + &hwlist.snd.emu10k1; + + &hwlist.snd.emu10kx; + + &hwlist.snd.envy24; + + &hwlist.snd.envy24ht; + + &hwlist.snd.es137x; + + &hwlist.snd.ess; + + &hwlist.snd.fm801; + + &hwlist.snd.gusc; + + &hwlist.snd.hda; + + &hwlist.snd.hdspe; + + &hwlist.snd.ich; + + &hwlist.snd.maestro; + + &hwlist.snd.maestro3; + + &hwlist.snd.mss; + + &hwlist.snd.neomagic; + + &hwlist.snd.sbc; + + &hwlist.snd.solo; + + &hwlist.snd.spicds; + + &hwlist.snd.t4dwave; + + &hwlist.snd.via8233; + + &hwlist.snd.via82c686; + + &hwlist.snd.vibes; + + <para>[&arch.pc98;] NEC PC-9801-73, 86 and compatibles (nss + driver)</para> + + <itemizedlist> + <listitem> + <para>NEC A-MATE internal sound</para> + </listitem> + + <listitem> + <para>Q-Vision WaveStar, WaveMaster</para> + </listitem> + </itemizedlist> + + <para>[&arch.pc98;] NEC X-MATE, CanBe, ValueStar internal (mss + driver)</para> + + <para>[&arch.pc98;] Creative Technologies SoundBlaster(98) + (&man.sb.4; driver)</para> + + <para>[&arch.pc98;] I-O DATA CD-BOX (&man.sb.4; driver)</para> + + <para>[&arch.pc98;] MPU-401 and compatible interfaces (mpu + driver)</para> + + <itemizedlist> + <listitem> + <para>Q-Vision WaveStar</para> + </listitem> + </itemizedlist> + </sect2> + + <sect2 xml:id="camera"> + <title>Camera and Video Capture Devices</title> + + &hwlist.bktr; + + <para>[&arch.i386;] Connectix QuickCam</para> + </sect2> + + <sect2 xml:id="usb"> + <title>USB Devices</title> + + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] A + range of USB peripherals are supported; devices known to work + are listed in this section. Owing to the generic nature of + most USB devices, with some exceptions any device of a given + class will be supported, even if not explicitly listed + here.</para> + + <note> + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] + USB Ethernet adapters can be found in the section listing + <link linkend="ethernet">Ethernet + interfaces</link>.</para> + </note> + + <note> + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] + USB Bluetooth adapters can be found in <link linkend="bluetooth">Bluetooth</link> section.</para> + </note> + + &hwlist.ohci; + + &hwlist.uhci; + + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] USB + 2.0 controllers using the EHCI interface (&man.ehci.4; + driver)</para> + + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] + Hubs</para> + + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] + Keyboards (&man.ukbd.4; driver)</para> + + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] + Miscellaneous</para> + + <itemizedlist> + <listitem> + <para>Assist Computer Systems PC Camera C-M1</para> + </listitem> + + <listitem> + <para>ActiveWire I/O Board</para> + </listitem> + + <listitem> + <para>Creative Technology Video Blaster WebCam Plus</para> + </listitem> + + <listitem> + <para>D-Link DSB-R100 USB Radio (&man.ufm.4; driver)</para> + </listitem> + + <listitem> + <para>Mirunet AlphaCam Plus</para> + </listitem> + </itemizedlist> + + &hwlist.urio; + + &hwlist.umodem; + + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] Mice + (&man.ums.4; driver)</para> + + &hwlist.ulpt; + + &hwlist.ubsa; + + &hwlist.ubser; + + &hwlist.uftdi; + + &hwlist.uplcom; + + &hwlist.umct; + + &hwlist.umass; + + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] Audio Devices + (&man.uaudio.4; driver)</para> + + &hwlist.uvisor; + </sect2> + + <sect2 xml:id="firewire"> + <title>IEEE 1394 (Firewire) Devices</title> + + &hwlist.fwohci; + + <para>[&arch.amd64;, &arch.i386;, &arch.sparc64;] Serial Bus + Protocol 2 (SBP-2) storage devices (&man.sbp.4; driver)</para> + </sect2> + + <sect2 xml:id="bluetooth"> + <title>Bluetooth Devices</title> + + &hwlist.ng.bt3c; + + &hwlist.ng.ubt; + </sect2> + + <sect2 xml:id="crypto-accel"> + <title>Cryptographic Accelerators</title> + + &hwlist.hifn; + + &hwlist.safe; + + &hwlist.ubsec; + </sect2> + + <sect2 xml:id="misc"> + <title>Miscellaneous</title> + + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] + FAX-Modem/PCCARD</para> + + <itemizedlist> + <listitem> + <para>MELCO IGM-PCM56K/IGM-PCM56KH</para> + </listitem> + + <listitem> + <para>Nokia Card Phone 2.0 (gsm900/dcs1800 HSCSD + terminal)</para> + </listitem> + </itemizedlist> + + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] Floppy drives + (&man.fdc.4; driver)</para> + + <para>[&arch.amd64;, &arch.i386;] VGA-compatible video cards + (&man.vga.4; driver)</para> + + <note> + <para>Information regarding specific video cards and + compatibility with <application>Xorg</application> can be + found at <uri xlink:href="http://www.x.org/">http://www.x.org/</uri>.</para> + </note> + + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] + Keyboards including:</para> + + <itemizedlist> + <listitem> + <para>[&arch.i386;] AT-style keyboards (&man.atkbd.4; + driver)</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] PS/2 keyboards + (&man.atkbd.4; driver)</para> + </listitem> + + <listitem> + <para>[&arch.pc98;] Standard keyboards</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] + USB keyboards (&man.ukbd.4; driver)</para> + </listitem> + </itemizedlist> + + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] + Pointing devices including:</para> + + <itemizedlist> + <listitem> + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] Bus mice and + compatible devices (&man.mse.4; driver)</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;] PS/2 mice and compatible + devices, including many laptop pointing devices + (&man.psm.4; driver)</para> + </listitem> + + <listitem> + <para>Serial mice and compatible devices</para> + </listitem> + + <listitem> + <para>[&arch.amd64;, &arch.i386;, &arch.pc98;] + USB mice (&man.ums.4; driver)</para> + </listitem> + </itemizedlist> + + <note> + <para>&man.moused.8; has more information on using pointing + devices with &os;. Information on using pointing devices + with <application>Xorg</application> can be found at <uri xlink:href="http://www.x.org/">http://www.x.org/</uri>.</para> + </note> + + <para>[&arch.amd64;, &arch.i386;] <quote>PC standard</quote> + parallel ports (&man.ppc.4; driver)</para> + + <para>[&arch.pc98;] <quote>PC-9821 standard</quote> parallel + ports (&man.ppc.4; driver)</para> + + <para>[&arch.i386;, &arch.amd64;] PC-compatible joysticks + (&man.joy.4; driver)</para> + + <para>[&arch.pc98;] Joystick port of SoundBlaster(98) + (&man.joy.4; driver)</para> + + <para>[&arch.i386;, &arch.pc98;] PHS Data Communication + Card/PCCARD</para> + + <itemizedlist> + <listitem> + <para>NTT DoCoMo P-in Comp@ct</para> + </listitem> + + <listitem> + <para>Panasonic KX-PH405</para> + </listitem> + + <listitem> + <para>SII MC-P200</para> + </listitem> + </itemizedlist> + + <para>[&arch.i386;] Xilinx XC6200-based reconfigurable hardware + cards compatible with the HOT1 from <link xlink:href="http://www.vcc.com/">Virtual Computers</link> (xrpu + driver).</para> + + <para>[&arch.pc98;] Power Management Controller of NEC PC-98 + Note (pmc driver)</para> + </sect2> + </sect1> +</article> diff --git a/release/doc/en_US.ISO8859-1/readme/Makefile b/release/doc/en_US.ISO8859-1/readme/Makefile new file mode 100644 index 0000000..35219fc --- /dev/null +++ b/release/doc/en_US.ISO8859-1/readme/Makefile @@ -0,0 +1,24 @@ +# $FreeBSD$ + +RELN_ROOT?= ${.CURDIR}/../.. +.ifdef NO_LANGCODE_IN_DESTDIR +DESTDIR?= ${DOCDIR}/readme +.else +DESTDIR?= ${DOCDIR}/en_US.ISO8859-1/readme +.endif + +DOC?= article +FORMATS?= html +INSTALL_COMPRESSED?= gz +INSTALL_ONLY_COMPRESSED?= + +# +# SRCS lists the individual SGML files that make up the document. Changes +# to any of these files will force a rebuild +# + +# SGML content +SRCS+= article.xml + +.include "${RELN_ROOT}/share/mk/doc.relnotes.mk" +.include "${DOC_PREFIX}/share/mk/doc.project.mk" diff --git a/release/doc/en_US.ISO8859-1/readme/article.xml b/release/doc/en_US.ISO8859-1/readme/article.xml new file mode 100644 index 0000000..ffebcc3 --- /dev/null +++ b/release/doc/en_US.ISO8859-1/readme/article.xml @@ -0,0 +1,412 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook XML V5.0-Based Extension//EN" + "../../../share/xml/freebsd50.dtd" [ +<!ENTITY % release PUBLIC "-//FreeBSD//ENTITIES Release Specification//EN" "release.ent"> + %release; +]> +<!-- + Local Variables: + mode: sgml + sgml-indent-data: t + sgml-omittag: nil + sgml-always-quote-attributes: t + End: +--> +<article xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> + <info><title>&os; &release.current; README</title> + + + <author><orgname>The &os; Project</orgname></author> + + <pubdate>$FreeBSD$</pubdate> + + <copyright> + <year>2000</year> + <year>2001</year> + <year>2002</year> + <year>2003</year> + <year>2004</year> + <year>2005</year> + <year>2006</year> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <year>2011</year> + <year>2012</year> + <year>2013</year> + <year>2014</year> + <year>2015</year> + <holder role="mailto:doc@FreeBSD.org">The &os; Documentation Project</holder> + </copyright> + + <legalnotice xml:id="trademarks" role="trademarks"> + &tm-attrib.freebsd; + &tm-attrib.intel; + &tm-attrib.opengroup; + &tm-attrib.sparc; + &tm-attrib.general; + </legalnotice> + + <abstract> + <para>This document gives a brief introduction to &os; + &release.current;. It includes some information on how to + obtain &os;, a listing of various ways to contact the &os; + Project, and pointers to some other sources of + information.</para> + </abstract> + </info> + + <sect1 xml:id="intro"> + <title>Introduction</title> + + <para>This distribution is a &release.type; of &os; &release.current;, the + latest point along the &release.branch; branch.</para> + + <sect2> + <title>About &os;</title> + + <para>&os; is an operating system based on 4.4 BSD Lite for + AMD64 and Intel EM64T based PC hardware (&arch.amd64;), + Intel, AMD, Cyrix or NexGen <quote>x86</quote> based PC hardware (&arch.i386;), + NEC PC-9801/9821 series PCs and compatibles (&arch.pc98;), + and &ultrasparc; machines (&arch.sparc64;). Versions + for the &arm; (&arch.arm;), &mips; (&arch.mips;), and + &powerpc; (&arch.powerpc;) architectures are currently under + development as well. &os; works with a wide variety of + peripherals and configurations and can be used for everything + from software development to games to Internet Service + Provision.</para> + + <para>This release of &os; contains everything you need to run + such a system, including full source code for the kernel and + all utilities in the base distribution. With the source + distribution installed, you can literally recompile the entire + system from scratch with one command, making it ideal for + students, researchers, or users who simply want to see how it + all works.</para> + + <para>A large collection of third-party ported software (the + <quote>Ports Collection</quote>) is also provided to make it + easy to obtain and install all your favorite traditional &unix; + utilities for &os;. Each <quote>port</quote> consists of a + set of scripts to retrieve, configure, build, and install a + piece of software, with a single command. Over &os.numports; + ports, from editors to programming languages to graphical + applications, make &os; a powerful and comprehensive operating + environment that extends far beyond what's provided by many + commercial versions of &unix;. Most ports are also available as + pre-compiled <quote>packages</quote>, which can be quickly + installed from the installation program.</para> + </sect2> + + <sect2> + <title>Target Audience</title> + + <para releasetype="current">This &release.type; is aimed primarily at early adopters + and various other users who want to get involved with the + ongoing development of &os;. While the &os; development team + tries its best to ensure that each &release.type; works as + advertised, &release.branch; is very much a + work-in-progress.</para> + + <para releasetype="current">The basic requirements for using this &release.type; are + technical proficiency with &os; and an understanding of the + ongoing development process of &os; &release.branch; (as + discussed on the &a.current;).</para> + + <para releasetype="current">For those more interested in doing business with &os; than + in experimenting with new &os; technology, formal releases + (such as &release.prev.stable;) are frequently more appropriate. + Releases undergo a period of testing and quality assurance + checking to ensure high reliability and dependability.</para> + + <para releasetype="snapshot">This &release.type; is aimed primarily at early adopters + and various other users who want to get involved with the + ongoing development of &os;. While the &os; development team + tries its best to ensure that each &release.type; works as + advertised, &release.branch; is very much a + work-in-progress.</para> + + <para releasetype="snapshot">The basic requirements for using this &release.type; are + technical proficiency with &os; and an understanding of the + ongoing development process of &os; &release.branch; (as + discussed on the &a.current;).</para> + + <para releasetype="snapshot">For those more interested in doing business with &os; than + in experimenting with new &os; technology, formal releases + (such as &release.prev.stable;) are frequently more appropriate. + Releases undergo a period of testing and quality assurance + checking to ensure high reliability and dependability.</para> + + <para releasetype="release">This &release.type; of &os; is suitable for all users. It + has undergone a period of testing and quality assurance + checking to ensure the highest reliability and + dependability.</para> + </sect2> + </sect1> + + <sect1 xml:id="obtain"> + <title>Obtaining &os;</title> + + <para>&os; may be obtained in a variety of ways. This section + focuses on those ways that are primarily useful for obtaining a + complete &os; distribution, rather than updating an existing + installation.</para> + + <sect2> + <title>CDROM and DVD</title> + + <para>&os; -RELEASE distributions may be ordered on CDROM or DVD + from several publishers. This is frequently the most + convenient way to obtain &os; for new installations, as it + provides a convenient way to quickly reinstall the system if + necessary. Some distributions include some of the optional, + precompiled <quote>packages</quote> from the &os; Ports + Collection, or other extra material.</para> + + <para>A list of the CDROM and DVD publishers known to the + project are listed in the <link xlink:href="&url.books.handbook;/mirrors.html"><quote>Obtaining + &os;</quote></link> appendix to the Handbook.</para> + </sect2> + + <sect2> + <title>FTP</title> + + <para>You can use FTP to retrieve &os; and any or all of its + optional packages from <uri xlink:href="ftp://ftp.FreeBSD.org/">ftp://ftp.FreeBSD.org/</uri>, which is the official + &os; release site, or any of its + <quote>mirrors</quote>.</para> + + <para>Lists of locations that mirror &os; can be found in the + <link xlink:href="&url.books.handbook;/mirrors-ftp.html">FTP + Sites</link> section of the Handbook. + Finding a close (in networking terms) mirror from which to + download the distribution is highly recommended.</para> + + <para>Additional mirror sites are always welcome. Contact + <email>freebsd-admin@FreeBSD.org</email> for more details on + becoming an official mirror site. You can also find useful + information for mirror sites at the <link xlink:href="&url.articles.hubs;/">Mirroring + &os;</link> article.</para> + + <para>Mirrors generally contain the ISO images generally used to + create a CDROM of a &os; release. They usually also contain + floppy disk images (for applicable platforms), as well as the + files necessary to do an installation over the network. + Finally mirrors sites usually contain a set of packages for + the most current release.</para> + </sect2> + </sect1> + + <sect1 xml:id="contacting"> + <title>Contacting the &os; Project</title> + + <sect2> + <title>Email and Mailing Lists</title> + + <para>For any questions or general technical support issues, + please send mail to the &a.questions;.</para> + + <para>If you're tracking the &release.branch; development efforts, you + <emphasis>must</emphasis> join the &a.current;, in order to + keep abreast of recent developments and changes that may + affect the way you use and maintain the system.</para> + + <para>Being a largely-volunteer effort, the &os; + Project is always happy to have extra hands willing to help—there are already far more desired enhancements than + there is time to implement them. To contact the developers on + technical matters, or with offers of help, please send mail to + the &a.hackers;.</para> + + <para>Please note that these mailing lists can experience + <emphasis>significant</emphasis> amounts of traffic. If you + have slow or expensive mail access, or are only interested in + keeping up with major &os; events, you may find it + preferable to subscribe instead to the &a.announce;.</para> + + <para>All of the mailing lists can be freely joined by anyone + wishing to do so. Visit the <link xlink:href="&url.base;/mailman/listinfo"> + &os; Mailman Info Page</link>. This will give you more + information on joining the various lists, accessing archives, + etc. There are a number of mailing lists targeted at special + interest groups not mentioned here; more information can be + obtained either from the Mailman pages or the <link xlink:href="&url.base;/support.html#mailing-list">mailing + lists section</link> of the &os; Web site.</para> + + <important> + <para>Do <emphasis>not</emphasis> send email to the lists + asking to be subscribed. Use the Mailman interface + instead.</para> + </important> + </sect2> + + <sect2> + <title>Submitting Problem Reports</title> + + <para>Suggestions, bug reports and contributions of code are + always valued—please do not hesitate to report any + problems you may find. Bug reports with attached fixes are of + course even more welcome.</para> + + <para>The preferred method to submit bug reports from a machine + with Internet connectivity is to use the + <application>Bugzilla</application> bug tracker. + <quote>Problem Reports</quote> (PRs) submitted in this way + will be filed and their progress tracked; the &os; developers + will do their best to respond to all reported bugs as soon as + possible. <link + xlink:href="https://bugs.FreeBSD.org/search/">A list of all + active PRs</link> is available on the &os; Web site; this + list is useful to see what potential problems other users have + encountered.</para> + + <para>Note that &man.send-pr.1; is deprecated.</para> + + <para>For more information, <link + xlink:href="&url.articles.problem-reports;/"><quote>Writing + &os; Problem Reports</quote></link>, available on the &os; + Web site, has a number of helpful hints on writing and + submitting effective problem reports.</para> + </sect2> + </sect1> + + <sect1 xml:id="seealso"> + <title>Further Reading</title> + + <para>There are many sources of information about &os;; some are + included with this distribution, while others are available + on-line or in print versions.</para> + + <sect2 xml:id="release-docs"> + <title>Release Documentation</title> + + <para>A number of other files provide more specific information + about this &release.type; distribution. These files are + provided in various formats. Most distributions will include + both ASCII text (<filename>.TXT</filename>) and HTML + (<filename>.HTM</filename>) renditions. Some distributions + may also include other formats such as Portable Document Format + (<filename>.PDF</filename>). + + <itemizedlist> + <listitem> + <para><filename>README.TXT</filename>: This file, which + gives some general information about &os; as well as + some cursory notes about obtaining a + distribution.</para> + </listitem> + + <listitem> + <para><filename>RELNOTES.TXT</filename>: The release + notes, showing what's new and different in &os; + &release.current; compared to the previous release (&os; + &release.prev;).</para> + </listitem> + + <listitem> + <para><filename>HARDWARE.TXT</filename>: The hardware + compatibility list, showing devices with which &os; has + been tested and is known to work.</para> + </listitem> + + <listitem> + <para><filename>ERRATA.TXT</filename>: Release errata. + Late-breaking, post-release information can be found in + this file, which is principally applicable to releases + (as opposed to snapshots). It is important to consult + this file before installing a release of &os;, as it + contains the latest information on problems which have + been found and fixed since the release was + created.</para> + </listitem> + </itemizedlist> + </para> + + <para>On platforms that support &man.bsdinstall.8; (currently + &arch.amd64;, &arch.i386;, &arch.pc98;, and &arch.sparc64;), these documents are generally available via the + Documentation menu during installation. Once the system is + installed, you can revisit this menu by re-running the + &man.bsdinstall.8; utility.</para> + + <note> + <para>It is extremely important to read the errata for any + given release before installing it, to learn about any + <quote>late-breaking news</quote> or post-release problems. + The errata file accompanying each release (most likely right + next to this file) is already out of date by definition, but + other copies are kept updated on the Internet and should be + consulted as the <quote>current errata</quote> for this + release. These other copies of the errata are located at + <uri xlink:href="&url.base;/releases/">&url.base;/releases/</uri> (as + well as any sites which keep up-to-date mirrors of this + location).</para> + </note> + </sect2> + + <sect2> + <title>Manual Pages</title> + + <para>As with almost all &unix; like operating systems, &os; comes + with a set of on-line manual pages, accessed through the + &man.man.1; command or through the <link xlink:href="http://www.FreeBSD.org/cgi/man.cgi">hypertext manual + pages gateway</link> on the &os; Web site. In general, the + manual pages provide information on the different commands and + APIs available to the &os; user.</para> + + <para>In some cases, manual pages are written to give + information on particular topics. Notable examples of such + manual pages are &man.tuning.7; (a guide to performance tuning), + &man.security.7; (an introduction to &os; security), and + &man.style.9; (a style guide to kernel coding).</para> + </sect2> + + <sect2> + <title>Books and Articles</title> + + <para>Two highly-useful collections of &os;-related information, + maintained by the &os; Project, + are the &os; Handbook and &os; FAQ (Frequently Asked + Questions document). On-line versions of the <link xlink:href="&url.books.handbook;/">Handbook</link> + and <link xlink:href="&url.books.faq;/">FAQ</link> + are always available from the <link xlink:href="&url.base;/docs.html">&os; Documentation + page</link> or its mirrors. If you install the + <filename>doc</filename> distribution set, you can use a Web + browser to read the Handbook and FAQ locally. In particular, + note that the Handbook contains a step-by-step guide to + installing &os;.</para> + + <para>A number of on-line books and articles, also maintained by + the &os; Project, cover more-specialized, &os;-related topics. + This material spans a wide range of topics, from effective use + of the mailing lists, to dual-booting &os; with other + operating systems, to guidelines for new committers. Like the + Handbook and FAQ, these documents are available from the &os; + Documentation Page or in the <filename>doc</filename> + distribution set.</para> + + <para>A listing of other books and documents about &os; can be + found in the <link xlink:href="&url.books.handbook;/bibliography.html">bibliography</link> + of the &os; Handbook. Because of &os;'s strong &unix; heritage, + many other articles and books written for &unix; systems are + applicable as well, some of which are also listed in the + bibliography.</para> + </sect2> + </sect1> + + <sect1 xml:id="acknowledgements"> + <title>Acknowledgments</title> + + <para>&os; represents the cumulative work of many hundreds, if not + thousands, of individuals from around the world who have worked + countless hours to bring about this &release.type;. For a + complete list of &os; developers and contributors, please see + <link xlink:href="&url.articles.contributors;/"><quote>Contributors + to &os;</quote></link> on the &os; Web site or any of its + mirrors.</para> + + <para>Special thanks also go to the many thousands of &os; users + and testers all over the world, without whom this &release.type; + simply would not have been possible.</para> + </sect1> +</article> diff --git a/release/doc/en_US.ISO8859-1/relnotes/Makefile b/release/doc/en_US.ISO8859-1/relnotes/Makefile new file mode 100644 index 0000000..c0f473e --- /dev/null +++ b/release/doc/en_US.ISO8859-1/relnotes/Makefile @@ -0,0 +1,24 @@ +# $FreeBSD$ + +RELN_ROOT?= ${.CURDIR}/../.. + +.ifdef NO_LANGCODE_IN_DESTDIR +DESTDIR?= ${DOCDIR}/relnotes +.else +DESTDIR?= ${DOCDIR}/en_US.ISO8859-1/relnotes +.endif + +DOC?= article +FORMATS?= html +INSTALL_COMPRESSED?= gz +INSTALL_ONLY_COMPRESSED?= + +JADEFLAGS+= -V %generate-article-toc% + +# SGML content +SRCS+= article.xml + +URL_RELPREFIX?= ../../../.. + +.include "${RELN_ROOT}/share/mk/doc.relnotes.mk" +.include "${DOC_PREFIX}/share/mk/doc.project.mk" diff --git a/release/doc/en_US.ISO8859-1/relnotes/article.xml b/release/doc/en_US.ISO8859-1/relnotes/article.xml new file mode 100644 index 0000000..f860409 --- /dev/null +++ b/release/doc/en_US.ISO8859-1/relnotes/article.xml @@ -0,0 +1,1805 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE article PUBLIC "-//FreeBSD//DTD DocBook XML V5.0-Based Extension//EN" + "../../../share/xml/freebsd50.dtd" [ +<!ENTITY % release PUBLIC "-//FreeBSD//ENTITIES Release Specification//EN" "release.ent"> + %release; +<!ENTITY % sponsor PUBLIC "-//FreeBSD//ENTITIES Sponsor Specification//EN" "sponsor.ent"> + %sponsor; +<!ENTITY % vendor PUBLIC "-//FreeBSD//ENTITIES Vendor Specification//EN" "vendor.ent"> + %vendor; +<!ENTITY security SYSTEM "../../share/xml/security.xml"> +<!ENTITY errata SYSTEM "../../share/xml/errata.xml"> +]> +<article xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"> + + <info> + <title>&os; &release.current; Release Notes</title> + + <author> + <orgname>The &os; Project</orgname> + </author> + + <pubdate>$FreeBSD$</pubdate> + + <!-- Last rev: 288943 --> + + <copyright> + <year>2015</year> + <holder role="mailto:doc@FreeBSD.org">The &os; Documentation + Project</holder> + </copyright> + + <legalnotice xml:id="trademarks" role="trademarks"> + &tm-attrib.freebsd; + &tm-attrib.ibm; + &tm-attrib.ieee; + &tm-attrib.intel; + &tm-attrib.sparc; + &tm-attrib.general; + </legalnotice> + + <abstract> + <para>The release notes for &os; &release.current; contain + a summary of the changes made to the &os; base system on the + &release.branch; development line. This document lists + applicable security advisories that were issued since the last + release, as well as significant changes to the &os; kernel and + userland. Some brief remarks on upgrading are also + presented.</para> + </abstract> + </info> + + <sect1 xml:id="intro"> + <title>Introduction</title> + + <para>This document contains the release notes for &os; + &release.current;. It describes recently added, changed, or + deleted features of &os;. It also provides some notes on + upgrading from previous versions of &os;.</para> + + <para releasetype="current">The &release.type; distribution to + which these release notes apply represents the latest point + along the &release.branch; development branch since + &release.branch; was created. Information regarding pre-built, + binary &release.type; distributions along this branch can be + found at <uri + xlink:href="&release.url;">&release.url;</uri>.</para> + + <para releasetype="snapshot">The &release.type; distribution to + which these release notes apply represents a point along the + &release.branch; development branch between &release.prev; and + the future &release.next;. Information regarding pre-built, + binary &release.type; distributions along this branch can be + found at <uri + xlink:href="&release.url;">&release.url;</uri>.</para> + + <para releasetype="release">This distribution of &os; + &release.current; is a &release.type; distribution. It can be + found at <uri xlink:href="&release.url;">&release.url;</uri> or + any of its mirrors. More information on obtaining this (or + other) &release.type; distributions of &os; can be found in the + <link + xlink:href="&url.books.handbook;/mirrors.html"><quote>Obtaining + &os;</quote> appendix</link> to the <link + xlink:href="&url.books.handbook;/">&os; + Handbook</link>.</para> + + <para>All users are encouraged to consult the release errata + before installing &os;. The errata document is updated with + <quote>late-breaking</quote> information discovered late in the + release cycle or after the release. Typically, it contains + information on known bugs, security advisories, and corrections + to documentation. An up-to-date copy of the errata for &os; + &release.current; can be found on the &os; Web site.</para> + + <para>This document describes the most user-visible new or changed + features in &os; since &release.prev;. In general, changes + described here are unique to the &release.branch; branch unless + specifically marked as &merged; features.</para> + + <para>Typical release note items document recent security + advisories issued after &release.prev;, new drivers or hardware + support, new commands or options, major bug fixes, or + contributed software upgrades. They may also list changes to + major ports/packages or release engineering practices. Clearly + the release notes cannot list every single change made to &os; + between releases; this document focuses primarily on security + advisories, user-visible changes, and major architectural + improvements.</para> + </sect1> + + <sect1 xml:id="upgrade"> + <title>Upgrading from Previous Releases of &os;</title> + + <para arch="amd64,i386">Binary upgrades between RELEASE versions + (and snapshots of the various security branches) are supported + using the &man.freebsd-update.8; utility. The binary upgrade + procedure will update unmodified userland utilities, as well as + unmodified GENERIC kernels distributed as a part of an official + &os; release. The &man.freebsd-update.8; utility requires that + the host being upgraded have Internet connectivity.</para> + + <para>Source-based upgrades (those based on recompiling the &os; + base system from source code) from previous versions are + supported, according to the instructions in + <filename>/usr/src/UPDATING</filename>.</para> + + <important> + <para>Upgrading &os; should only be attempted after backing up + <emphasis>all</emphasis> data and configuration files.</para> + </important> + </sect1> + + <sect1 xml:id="security-errata"> + <title>Security and Errata</title> + + <para>This section lists the various Security Advisories and + Errata Notices since &release.prev;.</para> + + <sect2 xml:id="security"> + <title>Security Advisories</title> + + &security; + </sect2> + + <sect2 xml:id="errata"> + <title>Errata Notices</title> + + &errata; + </sect2> + </sect1> + + <sect1 xml:id="userland"> + <title>Userland</title> + + <para>This section covers changes and additions to userland + applications, contributed software, and system utilities.</para> + + <sect2 xml:id="userland-config"> + <title>Userland Configuration Changes</title> + + <para revision="266463">The default &man.newsyslog.conf.5; now + includes files in the + <filename>/etc/newsyslog.conf.d/</filename> and + <filename>/usr/local/etc/newsyslog.conf.d/</filename> + directories by default for &man.newsyslog.8;.</para> + + <para revision="270675">The &man.mailwrapper.8; utility has been + updated to use &man.mailer.conf.5; from the + <literal>LOCALBASE</literal> environment variable, which + defaults to <filename class="directory">/usr/local</filename> + if unset.</para> + + <para revision="272350">The <literal>MK_ARM_EABI</literal> + &man.src.conf.5; option has been removed.</para> + + <para revision="285169">The <application>ntp</application> suite + has been updated to version 4.2.8p3.</para> + </sect2> + + <sect2 xml:id="userland-programs"> + <title>Userland Application Changes</title> + + <para revision="258838" contrib="sponsor" sponsor="&ff;, + &google;" sponsorurl="">The &man.casperd.8; daemon has been + added, which provides access to functionality that is not + available in the <quote>capability mode</quote> + sandbox.</para> + + <para revision="260594">When unable to load a kernel module with + &man.kldload.8;, a message informing to view output of + &man.dmesg.8; is now printed, opposed to the previous output + <quote>Exec format error.</quote>.</para> + + <para revision="260910">Allow &man.pciconf.8; to identify PCI + devices that are attached to a driver to be identified by + their device name instead of just the selector. Additionally, + an optional device argument to the <literal>-l</literal> flag + to restrict the output to only listing details about a single + device.</para> + + <para revision="260913">A new flag, <quote>onifconsole</quote> + has been added to <filename>/etc/ttys</filename>. This allows + the system to provide a login prompt via serial console if the + device is an active kernel console, otherwise it is equivalent + to <literal>off</literal>.</para> + + <para revision="260926">Support for displaying VPD for PCI + devices via &man.pciconf.8; has been added.</para> + + <para revision="261498">&man.ping.8; protects against malicious + network packets using the Capsicum framework to drop + privileges.</para> + + <para revision="265229">The &man.ps.1; utility has been + updated to include the <literal>-J</literal> flag, used to + filter output by matching &man.jail.8; IDs and names. + Additionally, argument <literal>0</literal> can be used to + <literal>-J</literal> to only list processes running on the + host system.</para> + + <para revision="265249">The &man.top.1; utility has been updated + to filter by &man.jail.8; ID or name, in followup to the + &man.ps.1; change in <literal>r265229</literal>.</para> + + <para revision="266209">The &man.pmcstat.8; utility has been + updated to include a new flag, <literal>-l</literal>, which + ends event collection after the specified number of + seconds.</para> + + <para revision="270745">The &man.ps.1; utility has been updated + to include a new keyword, <quote>tracer</quote>, which + displays the <acronym>PID</acronym> of the tracing + process.</para> + + <para revision="271482">Support for adding empty partitions has + been added to the &man.mkimg.1; utility.</para> + + <para revision="272166">The &man.primes.6; utility has been + updated to correctly enumerate prime numbers between + <literal>4295098369</literal> and + <literal>3825123056546413050</literal>, which prior to this + change, it would be possible for returned values to be + incorrectly identified as prime numbers.</para> + + <para revision="272198">The &man.mkimg.1; utility has been + updated to include three options used to print information + about &man.mkimg.1; itself:</para> + + <informaltable frame="none" pgwide="0"> + <tgroup cols="2"> + <colspec colwidth="1*"/> + <colspec colwidth="1*"/> + <thead> + <row> + <entry>Option</entry> + <entry>Output</entry> + </row> + </thead> + + <tbody> + <row> + <entry><literal>--version</literal></entry> + <entry>The current version of the &man.mkimg.1; + utility</entry> + </row> + + <row> + <entry><literal>--formats</literal></entry> + <entry>The disk image file formats supported by + &man.mkimg.1;</entry> + </row> + + <row> + <entry><literal>--schemes</literal></entry> + <entry>The partition schemes supported by + &man.mkimg.1;</entry> + </row> + </tbody> + </tgroup> + </informaltable> + + <para revision="272488">Userland &man.ctf.5; support in + &man.dtrace.1; has been added. With this change, + &man.dtrace.1; is able to resolve type info for function and + <acronym>USDT</acronym> probe arguments, and function return + values.</para> + + <para revision="274960">The &man.elfdump.1; utility has been + updated to support capability mode provided by + &man.capsicum.4;.</para> + + <para revision="275680" contrib="sponsor" sponsor="&ff;">The + &man.fstyp.8; utility has been added, which is used to + determine the filesystem on a specified device.</para> + + <para revision="276881">The <literal>libedit</literal> library + has been updated to support <acronym>UTF</acronym>-8, which + additionally provides unicode support to &man.sh.1;.</para> + + <para revision="276893" contrib="sponsor" sponsor="&ff;">The + &man.mkimg.1; utility has been updated to support the + <acronym>MBR</acronym> <acronym>EFI</acronym> partition + type.</para> + + <para revision="277166" arch="powerpc">The &man.ptrace.2; system + call has been updated include support for Altivec registers on + &os;/&arch.powerpc;.</para> + + <para revision="278320">A new device control utility, + &man.devctl.8; has been added, which allows making + administrative changes to individual devices, such as + attaching and detaching drivers, and enabling and disabling + devices. The &man.devctl.8; utility uses the new + &man.devctl.3; library.</para> + + <para revision="279122" contrib="sponsor" + sponsor="&juniper;">The &man.netstat.1; utility has been + updated to link against the &man.libxo.3; shared + library.</para> + + <para revision="279139">A new flag, <literal>-c</literal>, has + been added to the &man.mkimg.1; utility, which allows + specifying the capacity of the target disk image.</para> + + <para revision="279315" contrib="sponsor" sponsor="&ff;">The + &man.uefisign.8; utility has been added.</para> + + <para revision="279571" contrib="sponsor" + sponsor="&scaleengine;">The &man.freebsd-update.8; utility has + been updated to prevent fetching updated binary patches when + a previous upgrade has not been thoroughly completed.</para> + + <para revision="280870">A regression in the &man.libarchive.3; + library that would prevent a directory from being included in + the archive when <literal>--one-file-system</literal> is used + has been fixed.</para> + + <para revision="281311" contrib="sponsor" sponsor="&ff;">The + &man.ar.1; utility has been updated to set + <literal>ARCHIVE_EXTRACT_SECURE_SYMLINKS</literal> and + <literal>ARCHIVE_EXTRACT_SECURE_NODOTDOT</literal> to disallow + directory traversal when extracting an archive, similar to + &man.tar.1;.</para> + + <para revision="281617">A race condition in &man.wc.1; that + would cause final results to be sent to &man.stderr.4; when + receiving the <literal>SIGINFO</literal> signal has been + fixed.</para> + + <para revision="282208" contrib="sponsor" + sponsor="&multiplay;">The &man.chflags.1;, &man.chgrp.1;, + &man.chmod.1;, and &man.chown.8; utilities now affect symbolic + links when the <literal>-R</literal> flag is specified, as + documented in &man.symlink.7;.</para> + + <para revision="282608">The &man.date.1; utility has been + updated to print the modification time of the file passed as + an argument to the <literal>-r</literal> flag, improving + compatibility with the <acronym>GNU</acronym> &man.date.1; + utility behavior.</para> + + <para revision="283961">The &man.pw.8; utility has been updated + with a new flag, <literal>-R</literal>, that sets the root + directory within which the utility will operate.</para> + + <para revision="284297" contrib="sponsor" + sponsor="&clusterhq;">The &man.lockstat.1; utility has been + updated with several improvements:</para> + + <itemizedlist> + <listitem> + <para>Spin locks are now reported as the amount of time + spinning, instead of loop iterations.</para> + </listitem> + + <listitem> + <para>Reader locks are now recognized as adaptive that can + spin on &os;.</para> + </listitem> + + <listitem> + <para>Lock aquisition events for successful reader try-lock + events are now reported.</para> + </listitem> + + <listitem> + <para>Spin and block events are now reported before lock + acquisition events.</para> + </listitem> + </itemizedlist> + + <para revision="284589" contrib="sponsor" + sponsor="&scaleengine;">The &man.fstyp.8; utility has been + updated to be able to detect &man.zfs.8; and &man.geli.8; + filesystems.</para> + + <para revision="284883">The &man.mkimg.1; utility has been + updated to include support for <literal>NTFS</literal> + filesystems in both <acronym>MBR</acronym> and + <acronym>GPT</acronym> partitioning schemes.</para> + + <para revision="285253">The &man.quota.1; utility has been + updated to include support for <acronym>IPv6</acronym>.</para> + + <para revision="285420">The &man.jexec.8; utility has been + updated to include a new flag, <literal>-l</literal>, which + ensures a clean environment in the target jail when used. + Additionally, &man.jexec.8; will run a shell within the target + jail when run no commands are specified.</para> + + <para revision="285550">The &man.w.1; utility has been updated + to display the full IPv6 remote address of the host from which + a user is connected.</para> + + <para revision="285685">The &man.jail.8; framework has been + updated to allow mounting &man.linprocfs.5; and + &man.linsysfs.5; within a jail.</para> + + <para revision="285772" contrib="sponsor" + sponsor="&emcisilon;">The &man.patch.1; utility has been + updated to include a new option to the <literal>-V</literal> + flag, <literal>none</literal>, which disables backup file + creation when applying a patch.</para> + + <para revision="286010" contrib="sponsor" sponsor="&ff;">The + &man.ar.1; utility now enables deterministic mode + (<literal>-D</literal>) by default. This behavior can be + disabled by specifying the <literal>-U</literal> flag.</para> + + <para revision="286289" contrib="sponsor" + sponsor="&scaleengine;">The &man.xargs.1; utility has been + updated to allow specifying <literal>0</literal> as an + argument to the <literal>-P</literal> (parallel mode) flag, + which allows creating as many concurrent processes as + possible.</para> + + <para revision="286795">The &man.patch.1; utility has been + updated to remove the automatic checkout feature.</para> + + <para revision="287473" contrib="sponsor" sponsor="&gandi;">A + new utility, &man.sesutil.8;, has been added, which is used + to manage &man.ses.4; devices.</para> + + <para revision="287522">The &man.pciconf.8; utility has been + updated to use the PCI ID database from the <filename + role="package">misc/pciids</filename> package, if present, + falling back to the PCI ID database in the &os; base + system.</para> + + <para revision="287842" contrib="sponsor" + sponsor="&scaleengine;">The &man.ifconfig.8; utility has been + updated to always exit with an error code if an important + &man.ioctl.2; fails.</para> + </sect2> + + <sect2 xml:id="userland-contrib"> + <title>Contributed Software</title> + + <para revision="260445">&man.byacc.1; has been updated to + version 20140101.</para> + + <para revision="261320"><application>OpenSSH</application> has + been updated to 6.5p1.</para> + + <para revision="261344"><application>mdocml</application> has + been updated to version 1.12.3.</para> + + <para revision="275718">The <application>binutils</application> + suite of utilities has been updated to include upstream + patches that add new relocations for &arch.powerpc; + support.</para> + + <para revision="276398" contrib="sponsor" sponsor="&ff;">The + <application>ELF Tool Chain</application> has been updated to + upstream revision r3136.</para> + + <para revision="276551">The <application>texinfo</application> + utility and <literal>info</literal> pages were removed from + the base system. The <filename + role="package">print/texinfo</filename> port should be + installed on systems where <literal>info</literal> pages are + needed.</para> + + <para revision="276796" contrib="sponsor" sponsor="&ff;">The ELF + object manipulation tools + <application>addr2line</application>, + <application>elfcopy (strip)</application>, + <application>nm</application>, + <application>readelf</application>, + <application>size</application>, and + <application>strings</application> were switched to the + versions from the ELF Tool Chain project.</para> + + <para revision="276881">The <literal>libedit</literal> library + has been updated to include <acronym>UTF-8</acronym> support, + adding <acronym>UTF-8</acronym> support to the &man.sh.1; + shell.</para> + + <para revision="278433">The &man.xz.1; utility has been updated + to support multi-threaded compression.</para> + + <para revision="280932" contrib="sponsor" sponsor="&ff;">The + <application>elftoolchain</application> utilities have been + updated to version 3179.</para> + + <para revision="281316">The &man.xz.1; utility has been updated + to version 5.2.1.</para> + + <para revision="281373">The &man.nvi.1; utility has been updated + to version 2.1.3.</para> + + <para revision="281806">The &man.wpa.supplicant.8; and + &man.hostapd.8; utilities have been updated to version + 2.4.</para> + + <para revision="282434" contrib="sponsor" sponsor="&ff;">The + &man.resolvconf.8; utility has been updated to version + 3.7.0.</para> + + <para revision="284254"><application>bmake</application> has + been updated to version 20150606.</para> + + <para revision="285229"><application>sendmail</application> has + been updated to 8.15.2. Starting with &os; 11.0 and + sendmail 8.15, sendmail uses uncompressed IPv6 addresses by + default, i.e., they will not contain <quote>::</quote>. For + example, instead of <quote>::1</quote>, it will be + <quote>0:0:0:0:0:0:0:1</quote>. This permits a zero subnet to + have a more specific match, such as different map entries for + IPv6:0:0 versus IPv6:0. This change requires that + configuration data (including maps, files, classes, custom + ruleset, etc.) must use the same format, so make certain such + configuration data is upgrading. As a very simple check + search for patterns like 'IPv6:[0-9a-fA-F:]*::' and 'IPv6::'. + To return to the old behavior, set the m4 option + <literal>confUSE_COMPRESSED_IPV6_ADDRESSES</literal> or the cf + option <literal>UseCompressedIPv6Addresses</literal>.</para> + + <para revision="285275">The &man.tcpdump.1; utility has been + updated to version 4.7.4.</para> + + <para revision="285329"><application>OpenSSL</application> has + been updated to version 1.0.1p.</para> + + <para revision="285642" contrib="sponsor" sponsor="&dell;">The + &man.ssh.1; utility has been updated to re-implement hostname + canonicalization before locating the host in + <filename>known_hosts</filename>.</para> + + <para revision="285972">The &man.libarchive.3; library has been + updated to properly skip a sparse file entry in a &man.tar.1; + file, which would previously produce errors.</para> + + <para revision="286503">The <application>apr</application> + library used by &man.svnlite.1; has been updated to version + 1.5.2.</para> + + <para revision="286505">The <application>serf</application> + library used by &man.svnlite.1; has been updated to version + 1.3.8.</para> + + <para revision="286505">The &man.svnlite.1; utility has been + updated to version 1.8.14.</para> + + <para revision="286510">The <application>sqlite3</application> + library used by &man.svnlite.1; and &man.kerberos.8; has been + updated to version 3.8.11.1.</para> + + <para revision="286750">Timezone data files have been updated to + version 2015f.</para> + + <para revision="287168">The &man.acpi.4; subsystem has been + updated to version 20150818.</para> + + <para revision="287917">The &man.unbound.8; utility has been + updated to version 1.5.4.</para> + + <para revision="288090">&man.jemalloc.3; has been updated to + version 4.0.2.</para> + + <para revision="288143">The &man.file.1; utility has been + updated to version 5.25.</para> + + <para revision="288303">The &man.nc.1; utility has been updated + to the OpenBSD 5.8 version.</para> + + <para revision="288943"><application>Clang</application> has + been updated to version 3.7.0.</para> + + <para revision="288943"><application>LLVM</application> has + been updated to version 3.7.0.</para> + + <para revision="288943"><application>LLDB</application> has + been updated to version 3.7.0.</para> + + <para revision="288943"><application>libc++</application> has + been updated to version 3.7.0.</para> + + <para revision="288943">The + <application>compiler_rt</application> utility has been + updated to version 3.7.0.</para> + </sect2> + + <sect2 xml:id="userland-installer"> + <title>Installation and Configuration Tools</title> + + <para revision="271539">The &man.bsdinstall.8; partition editor + and &man.sade.8; utility have been updated to include native + <acronym>ZFS</acronym> support.</para> + + <para revision="272274">The &os; installation utility, + &man.bsdinstall.8;, has been updated to set the + <literal>canmount</literal> &man.zfs.8; property to + <literal>off</literal> for the <filename + class="directory">/var</filename> dataset, preventing the + contents of directories within <filename + class="directory">/var</filename> from conflicting when + using multiple boot environments, such as that provided by + <filename role="package">sysutils/beadm</filename>.</para> + + <para revision="274394">The &man.bsdconfig.8; utility has been + updated to skip the initial &man.tzsetup.8; + <acronym>UTC</acronym> versus wall-clock time prompt when run + in a virtual machine, determined when the + <literal>kern.vm_guest</literal> &man.sysctl.8; is set to + <literal>1</literal>.</para> + + <para revision="275874">The &man.bsdinstall.8; utility has been + updated to use the new &man.dpv.3; library to display progress + when extracting the &os; distributions.</para> + + <para revision="285557" contrib="sponsor" + sponsor="&scaleengine;">Support for detecting and implementing + aligning partitions on 1Mb boundaries has been added to + &man.bsdinstall.8;.</para> + + <para revision="285679" contrib="sponsor" + sponsor="&scaleengine;">Support for detecting and implementing + a workaround for various laptops and motherboards that do not + boot properly from <acronym>GPT</acronym>-partitioned disks + has been added to &man.bsdinstall.8;. Additionally, the + <literal>active</literal> flag will be set on the partition + when needed.</para> + + <para revision="285679" contrib="sponsor" + sponsor="&scaleengine;">Support for selecting the partitioning + scheme when installing on the <acronym>UFS</acronym> + filesystem has been added to &man.bsdinstall.8;.</para> + </sect2> + + <sect2 xml:id="userland-rc"> + <title><filename class="directory">/etc/rc.d</filename> + Scripts</title> + + <para revision="270676">The &man.rc.8; subsystem has been + updated to allow configuring services in <filename + class="directory">${LOCALBASE}/etc/rc.conf.d/</filename>. + If <literal>LOCALBASE</literal> is unset, it defaults to + <filename class="directory">/usr/local</filename>.</para> + + <para revision="273955">A new &man.rc.8; script, + <filename>growfs</filename>, has been added, which will resize + the root filesystem on boot if <filename>/firstboot</filename> + exists.</para> + + <para revision="275299">The <filename>mrouted</filename> + &man.rc.8; script has been removed from the base system. An + equivalent script is available from the <filename + role="package">net/mrouted</filename> port.</para> + + <para revision="279463" contrib="sponsor" + sponsor="&sandvine;">A new &man.rc.8; script, + <filename>iovctl</filename>, has been added, which allows + automatically starting the &man.iovctl.8; utility at + boot.</para> + + <para revision="287576" contrib="sponsor" + sponsor="&scaleengine;">The &man.service.8; utility has been + updated to honor entries within <filename + class="directory">/etc/rc.conf.d/</filename>.</para> + + </sect2> + + <sect2 xml:id="userland-periodic"> + <title><filename class="directory">/etc/periodic</filename> + Scripts</title> + + <para revision="271321">The daily &man.periodic.8; script + <filename>110.clean-tmps</filename> has been updated to avoid + crossing filesystem mount boundaries when cleaning files in + <filename class="directory">/tmp</filename>.</para> + + <para revision="277216" contrib="sponsor" sponsor="&ff;">A new + &man.periodic.8; script, + <filename>510.status-world-kernel</filename>, has been added, + which evaluates the running userland and kernel versions from + the &man.uname.1; <literal>-U</literal> and + <literal>-K</literal> arguments, and prints an error if the + system userland and kernel are not in sync.</para> + </sect2> + + <sect2 xml:id="userland-libraries"> + <title>Runtime Libraries and API</title> + + <para revision="265995">The Blowfish &man.crypt.3; default + format has been changed to + <literal>$2b$</literal>.</para> + + <para revision="268461">The &man.readline.3; library is now + statically linked in software within the base system, and the + shared library is no longer installed, allowing the Ports + Collection to use a modern version of the library.</para> + + <para revision="272273">The &man.strptime.3; library has been + updated to add support for <acronym>POSIX</acronym>-2001 + features <literal>%U</literal> and + <literal>%W</literal>.</para> + + <para revision="272842,272848" contrib="sponsor" + sponsor="&ff;">The &man.dl.iterate.phdr.3; library has been + changed to always return the path name of the + <acronym>ELF</acronym> object in the + <literal>dlpi_name</literal> structure member.</para> + + <para revision="273562" contrib="sponsor" + sponsor="&juniper;">The &man.libxo.3; library has been + imported to the base system.</para> + + <para revision="273806" contrib="sponsor" sponsor="&chelsio;">A + userland library for Chelsio Terminator 5 based iWARP cards + has been added, allowing userland <acronym>RDMA</acronym> + applications to work over compatible + <acronym>NIC</acronym>s.</para> + + <para revision="274987">The &man.gpio.3; library has been added, + providing a wrapper around the &man.gpio.4; kernel + interface.</para> + + <para revision="275800" contrib="sponsor" sponsor="&ff;">The + &man.procctl.2; system call has been updated to include + a facility for non-&man.init.8; processes to be declared as + the reaper of child processes and their decendants.</para> + + <para revision="277610">The <literal>futimens()</literal> and + <literal>utimensat()</literal> system calls have been + added. See &man.utimensat.2; for more information.</para> + + <para revision="278934">The &man.elf.3; compile-time dependency + has been removed from <filename>dtri.o</filename>, which + allows adding <application>DTrace</application> probes to + userland applications and libraries without also linking + against &man.elf.3;.</para> + + <para revision="279186">The &man.setmode.3; function has been + updated to consistently set <literal>errno</literal> on + failure.</para> + + <para revision="279663">The &man.qsort.3; functions have been + updated to be able to handle 32-bit aligned data on 64-bit + platforms, also providing a significant improvement in 32-bit + workloads.</para> + + <para revision="281130">Several standard include headers have + been updated to use of <application>gcc</application> + attributes, such as <literal>__result_use_check()</literal>, + <literal>__alloc_size()</literal>, and + <literal>__nonnull()</literal>.</para> + + <para revision="281845">Support for file verification in + <acronym>MAC</acronym> has been added.</para> + + <para revision="282973" contrib="sponsor" sponsor="&ff;">The + <literal>libgomp</literal> library is now only built when + building <acronym>GCC</acronym> from the base system. An + up-to-date version is available in the Ports Collection as + <filename + role="package">devel/libiomp5-devel</filename>.</para> + + <para revision="282988">The <filename>stdlib.h</filename> and + <filename>malloc.h</filename> headers have been updated to + make use of the <application>gcc</application> + <literal>alloc_align()</literal> attribute.</para> + + <para revision="284483" contrib="sponsor" + sponsor="&scaleengine;">The Blowfish &man.crypt.3; library + has been updated to support $2y$ hashes.</para> + + <para revision="285277">The &man.execl.3; and &man.execlp.3; + library functions have been updated to use the + <literal>__sentinel</literal> <application>gcc</application> + attribute.</para> + </sect2> + + <sect2 xml:id="userland-abi"> + <title>ABI Compatibility</title> + + <para revision="271982">The &linux; compatibility version has + been updated to <literal>2.6.18</literal>. The + <literal>compat.linux.osrelease</literal> &man.sysctl.8; is + evaluated when building the <filename + role="package">emulators/linux-c6</filename> and related + ports.</para> + + <para revision="288669">The stack protector has been upgraded to + the "strong" level, elevating the protection against buffer + overflows. While this significantly improves the security of + the system, extensive testing was done to ensure there are no + measurable side effects in performance or + functionality.</para> + </sect2> + </sect1> + + <sect1 xml:id="kernel"> + <title>Kernel</title> + + <para>This section covers changes to kernel configurations, system + tuning, and system control parameters that are not otherwise + categorized.</para> + + <sect2 xml:id="kernel-bugfix"> + <title>Kernel Bug Fixes</title> + + <para revision="265876">A kernel bug that inhibited proper + functionality of the <literal>dev.cpu.0.freq</literal> + &man.sysctl.8; on &intel; processors with Turbo + Boost ™ enabled has been fixed.</para> + + <para revision="271697" arch="powerpc">Support for + &man.dtrace.1; stack tracing has been fixed for + &os;/&arch.powerpc;, using the <literal>trapexit()</literal> + and <literal>asttrapexit()</literal> functions instead of + checking within addressed kernel space.</para> + + <para revision="271917">A kernel panic triggered when destroying + a &man.vnet.9; &man.jail.8; configured with &man.gif.4; has + been fixed.</para> + + <para revision="271918">A kernel panic triggered when destroying + a &man.vnet.9; &man.jail.8; configured with &man.gre.4; has + been fixed.</para> + + <para revision="272089">A bug in &man.ipfw.4; that could + potentially lead to a kernel panic when using &man.dummynet.4; + at layer 2 has been fixed.</para> + + <para revision="280930" contrib="sponsor" sponsor="&mitail;">The + kernel <acronym>RPC</acronym> has been updated to include + several enhancements:</para> + + <itemizedlist> + <listitem> + <para>The 45 MiB limit on requests queued for + &man.nfsd.8; threads has been removed.</para> + </listitem> + + <listitem> + <para>Avoids unnecessary throttling by not deferring + accounting for completed requests.</para> + </listitem> + + <listitem> + <para>Fixes an integer overflow and signedness bugs.</para> + </listitem> + </itemizedlist> + + <para revision="281261" arch="powerpc">Support for + &man.dtrace.1; has been added for the + Book-E ™.</para> + + <para revision="287886" contrib="sponsor" + sponsor="&multiplay;">The &man.kqueue.2; system call has been + updated to handle write events to files larger than 2 + gigabytes.</para> + </sect2> + + <sect2 xml:id="kernel-config"> + <title>Kernel Configuration</title> + + <para revision="266531">The <literal>IMAGACT_BINMISC</literal> + kernel configuration option has been enabled by default, + which enables application execution through emulators, such + as <application>Qemu</application>.</para> + + <para revision="268045">The <literal>VT</literal> kernel + configuration file has been removed, and the &man.vt.4; + driver is included in the <literal>GENERIC</literal> kernel. + To enable &man.vt.4;, enter <literal>set kern.vty=vt</literal> + at the &man.loader.8; prompt during boot, or add + <literal>kern.vty=vt</literal> to &man.loader.conf.5; and + reboot the system.</para> + + <para revision="277904">The &man.config.8; utility has been + updated to allow using a non-standard <filename + class="directory">src/</filename> tree, specified as an + argument to the <literal>-s</literal> flag.</para> + + <para revision="277990" arch="powerpc64">The + &os;/&arch.powerpc64; kernel now builds as + a position-independent executable, allowing the kernel to be + loaded into and run from any physical or virtual + address.</para> + + <important> + <para>This change requires an update to &man.loader.8;. + The userland and kernel must be updated before rebooting the + system.</para> + </important> + + <para revision="278338" arch="arm">A new module for creating + <filename>rpi.dtb</filename> has been added for the Raspberry + Pi.</para> + + <para revision="278340" arch="arm">The + <filename>rpi.dtb</filename> module is now installed to + <filename class="directory">/boot/dtb/</filename> by + default for the Raspberry Pi system.</para> + + <para revision="279189" contrib="sponsor" sponsor="&ff;" + arch="powerpc">Kernel support for Vector-Scalar eXtension + (<acronym>VSX</acronym>) found on POWER7 and POWER8 hardware + has been added.</para> + + <para revision="279252" contrib="sponsor" sponsor="&ff;" + arch="powerpc">The &man.pmap.9; implementation for 64-bit + &powerpc; processors has been overhaulded to improve + concurrency.</para> + + <para revision="279824" arch="arm">A new module for creating + the <filename>dtb</filename> module for AM335x systems has + been added.</para> + + <para revision="281495" contrib="sponsor" sponsor="&ff;">The + <literal>PAE_TABLES</literal> kernel configuration option has + been added for &os;/&arch.i386;, which instructs &man.pmap.9; + to use <acronym>PAE</acronym> format for page tables while + maintaining a 32-bit physical address size elsewhere in the + kernel. The use of this option can enhance application-level + security by enabling the creation of <quote>no execute</quote> + mappings on modern &arch.i386; processors. Unlike the + <literal>PAE</literal> option, <literal>PAE_TABLES</literal> + preserves kernel binary interface (<acronym>KBI</acronym>) + compatibility with non-<literal>PAE</literal> kernels, + allowing non-<literal>PAE</literal> kernel modules and drivers + to work with a <literal>PAE_TABLES</literal>-enabled kernel. + Additionally, system limits are tuned for 4GB maximum + <acronym>RAM</acronym>, avoiding kernel virtual address space + (<acronym>KVA</acronym>) exhaustion.</para> + + <para revision="282215">The <literal>SIFTR</literal> kernel + configuration has been added, allowing building &man.siftr.4; + statically into the kernel.</para> + + <para revision="282731" arch="arm">The &arch.arm; boot loader, + <filename>ubldr</filename>, is now relocatable. In addition, + <filename>ubldr.bin</filename> is now created during build + time, which is a stripped binary with an entry point of + <literal>0</literal>, providing the ability to specify the + load address by running <literal>go + ${loadaddr}</literal> in + <literal>u-boot</literal>.</para> + + <para revision="282921" contrib="sponsor" sponsor="&intelcorp;" + arch="amd64,i386">The &man.nvd.4; and &man.nvme.4; drivers are + now included in the <filename>GENERIC</filename> kernel + configuration by default.</para> + + <para revision="283959" contrib="sponsor" + sponsor="&limelight;">A new kernel configuration option, + <literal>EM_MULTIQUEUE</literal>, has been added which enables + multi-queue support in the &man.em.4; driver.</para> + + <note> + <para>Multi-queue support in the &man.em.4; driver is not + officially supported by &intel;.</para> + </note> + + <para revision="285142" contrib="sponsor" + sponsor="&netgate;">The <filename>GENERIC</filename> kernel + configuration has been updated to include the + <literal>IPSEC</literal> option by default.</para> + + <para revision="285387" contrib="sponsor" + sponsor="&norse;, &dell;">Initial <acronym>NUMA</acronym> + affinity and policy configuration has been added. See + &man.numactl.1;, and &man.numa.getaffinity.2;, for usage + details.</para> + + <para revision="286231">The &man.pms.4; driver has been added + to the <filename>GENERIC</filename> kernel configuration for + supported architectures.</para> + + <para revision="287306" arch="arm">The + <filename>CUBIEBOARD2</filename> kernel configuration has been + renamed to <filename>A20</filename>.</para> + + <para revision="288176" contrib="sponsor" sponsor="&ff;">Kernel + debugging symbols are now installed to <filename + class="directory">/usr/lib/debug/boot/kernel/</filename>. + To retain the previous behavior, add + <literal>KERN_DEBUGDIR=""</literal> to + &man.src.conf.5;.</para> + </sect2> + + <sect2 xml:id="kernel-sysctl"> + <title>System Tuning and Controls</title> + + <para revision="275140" contrib="sponsor" sponsor="&ff;">The + &man.hwpmc.4; default and maximum callchain depths have been + increased. The default has been increased from 16 to 32, and + the maximum increased from 32 to 128.</para> + + <para revision="279361">The <literal>kern.osrelease</literal> + and <literal>kern.osreldate</literal> are now configurable + &man.jail.8; parameters.</para> + + <para revision="280308,280949" contrib="sponsor" + sponsor="&ix;, &ff;">The &man.devfs.5; device filesystem has + been changed to update timestamps for read/write operations + using seconds precision. A new &man.sysctl.8;, + <literal>vfs.devfs.dotimes</literal> has been added, which + when set to a non-zero value, enables default precision + timestamps for these operations.</para> + + <para revision="282213" contrib="sponsor" sponsor="&ff;">A new + &man.sysctl.8;, <literal>kern.racct.enable</literal>, has been + added, which when set to a non-zero value allows using + &man.rctl.8; with the <literal>GENERIC</literal> kernel. + A new kernel configuration option, + <literal>RACCT_DISABLED</literal> has also been added.</para> + + <para revision="282901" contrib="sponsor" sponsor="&ff;">The + <literal>GENERIC</literal> kernel configuration now includes + <literal>RACCT</literal> and <literal>RCTL</literal> by + default.</para> + + <note> + <para>To enable <literal>RACCT</literal> and + <literal>RCTL</literal> on a system using the + <literal>GENERIC</literal> kernel configuration, add + <literal>kern.racct.enable=1</literal> to + &man.loader.conf.5;, and reboot the system.</para> + </note> + + <para revision="283136" contrib="sponsor" + sponsor="&limelight;">A new &man.sysctl.8;, + <literal>net.inet.tcp.hostcache.purgenow</literal>, has + been added, which when set to <literal>1</literal> during + runtime will flush all + <literal>net.inet.tcp.hostcache</literal> entries.</para> + + <para revision="285524">A new &man.sysctl.8;, + <literal>hw.model</literal>, has been added, which displays + <acronym>CPU</acronym> model information.</para> + + <para revision="286591">The &man.uart.4; driver has been + updated to allow tuning pulses per second captured in the + CTS line during runtime, whereas previously only the DCD line + could be used without rebuilding the kernel.</para> + </sect2> + </sect1> + + <sect1 xml:id="drivers"> + <title>Devices and Drivers</title> + + <para>This section covers changes and additions to devices and + device drivers since &release.prev;.</para> + + <sect2 xml:id="drivers-device"> + <title>Device Drivers</title> + + <para revision="260903">Support for GPS ports has been added to + &man.uhso.4;.</para> + + <para revision="265132">The &man.full.4; device has been added, + and the <literal>lindev(4)</literal> device has been removed. + Prior to this change, <literal>lindev(4)</literal> provided + only the <filename>/dev/full</filename> character device, + returning <literal>ENOSPC</literal> on write attempts. As + this device is not specific to &linux;, a native &os; version + has been added.</para> + + <para revision="271705">Hardware context support has been + added to the <literal>drm/i915</literal> driver, adding + support for <application>Mesa</application> 9.2 and + later.</para> + + <para revision="273178">The &man.vt.4; driver has been updated, + replacing the bitmapped <literal>kern.vt.spclkeys</literal> + &man.sysctl.8; with individual + <literal>kern.vt.kbd_*</literal> variants.</para> + + <para revision="273598">The &man.hpet.4; driver has been updated + to create a + <filename>/dev/hpet<replaceable>N</replaceable></filename> + device, providing access to <acronym>HPET</acronym> from + userspace.</para> + + <para revision="280183">The <literal>drm</literal> code has + been updated to match &linux; version 3.8.13.</para> + + <para revision="281440">The &man.psm.4; driver has been updated + to include improved support for newer Synaptics ® + touchpads and the ClickPad ® mouse on newer + Lenovo ™ laptops.</para> + + <para revision="282783" arch="powerpc">Support for the Freescale + <acronym>PCI</acronym> Root Complex device has been + added.</para> + + <para revision="285876">The &man.cyapa.4; driver has been added, + supporting the Cypress APA I2C trackpad.</para> + + <para revision="285883">The &man.isl.4; driver has been added, + supporting the Intersil I2C ISL29018 digital ambient light + sensor.</para> + </sect2> + + <sect2 xml:id="drivers-storage"> + <title>Storage Drivers</title> + + <para revision="265236" contrib="sponsor" + sponsor="&lsi;, &spectralogic;" sponsorurl="">The &man.mpr.4; + device has been added, providing support for LSI Fusion-MPT + 3 12Gb SCSI/SATA controllers.</para> + + <para revision="265555" contrib="sponsor" + sponsor="&lsi;">The &man.mrsas.4; driver has been added, + providing support for LSI MegaRAID SAS controllers. The + &man.mfi.4; driver will attach to the controller, by default. + To enable &man.mrsas.4; add + <literal>hw.mfi.mrsas_enable=1</literal> to + <filename>/boot/loader.conf</filename>, which turns off + &man.mfi.4; device probing.</para> + + <note> + <para>At this time, the &man.mfiutil.8; utility and the &os; + version of <application>MegaCLI</application> and + <application>StorCli</application> do not work with + &man.mrsas.4;.</para> + </note> + + <para revision="275461" contrib="sponsor" sponsor="&ix;">The + &man.ctl.4; subsystem has been updated, increasing the ports + limit from <literal>128</literal> to <literal>256</literal>, + and <acronym>LUN</acronym> limit from <literal>256</literal> + to <literal>1024</literal>.</para> + + <para revision="276526">The <literal>asr(4)</literal> driver has + been removed, and is no longer supported.</para> + + <para revision="281387">The &man.hptnr.4; driver has been + updated to version 1.1.1.</para> + + <para revision="285662">The &man.pms.4; driver has been added, + providing support for the PMC Sierra line of + <acronym>SAS</acronym>/<acronym>SATA</acronym> host bus + adapters.</para> + + <para revision="287117" contrib="sponsor" + sponsor="&emcisilon;">The &man.ioat.4; driver has been added, + providing support for the <acronym>PSE</acronym> (Platform + Storage Extension).</para> + + <para revision="287621" contrib="sponsor" sponsor="&ix;">The + <acronym>CTL</acronym> High Availability implementation has + been rewritten.</para> + + <para revision="288310">The &man.ctl.4; driver has been updated + to support CD-ROM and removable devices.</para> + </sect2> + + <sect2 xml:id="drivers-network"> + <title>Network Drivers</title> + + <para revision="258830">Support for Broadcom chipsets BCM57764, + BCM57767, BCM57782, BCM57786 and BCM57787 has been added to + &man.bge.4;.</para> + + <para revision="260448">Support for the &intel; Centrino™ + Wireless-N 135 chipset has been added.</para> + + <para revision="260552">Firmware for &intel; Centrino™ + Wireless-N 105 devices has been added to the base + system.</para> + + <para revision="261975">The deprecated nve(4) driver has been + removed. Users of NVIDIA nForce MCP network adapters are + advised to use the &man.nfe.4; driver instead, which has been + the default driver for this hardware since + &os; 7.0.</para> + + <para revision="264601" contrib="sponsor" + sponsor="&darpa_afrl;">The <literal>if_nf10bmac(4)</literal> + device has been added, providing support for NetFPGA-10G + Embedded CPU Ethernet Core.</para> + + <note> + <para>The <literal>if_nf10bmac(4)</literal> driver operates on + the FPGA, and is not suited for the PCI host + interface.</para> + </note> + + <para revision="265348" contrib="sponsor" + sponsor="&netgate;">The &man.ath.hal.4; driver has been + updated to support the Atheros AR1111 chipset.</para> + + <para revision="266770">Support for the &intel; Centrino™ + Wireless-N 105 chipset has been added.</para> + + <para revision="266757" contrib="sponsor" + sponsor="&chelsio;">Support for the &man.cxgbe.4; Terminator + 5 (T5) 10G/40G cards has been added to &man.netmap.4;.</para> + + <para revision="272730">The &man.alc.4; driver has been updated + to support AR816x and AR817x ethernet controllers.</para> + + <para revision="272906">The &man.pf.4; packet filter default + hash has been changed from <literal>Jenkins</literal> to + <literal>Murmur3</literal>, providing a 3-percent performance + increase in packets-per-second.</para> + + <para revision="273331">The &man.vxlan.4; driver has been added, + which creates a virtual Layer 2 (Ethernet) network overlaid in + a Layer 3 (IP/UDP) network. The &man.vxlan.4; driver is + analogous to &man.vlan.4;, but is designed to be better suited + for large, multiple-tenant datacenter environments.</para> + + <para revision="274246" contrib="sponsor" sponsor="&yandex;">The + &man.gre.4; driver has been significantly overhauled, and has + been split into two separate modules, &man.gre.4; and + &man.me.4;.</para> + + <para revision="278551">The &man.ral.4; driver has been updated + to support the RT5390 and RT5392 chipsets.</para> + + <para revision="283514" contrib="sponsor" + sponsor="&solarflare;">The &man.sfxge.4; driver has been + updated to support Solarflare Flareon Ultra 7000-series + chipsets.</para> + + <para revision="283766" contrib="sponsor" + sponsor="&limelight;">The &man.em.4; driver has been updated + with improved transmission queue hang detection.</para> + + <para revision="284125">The &man.cdce.4; driver has been updated + to include support for the RTL8153 chipset.</para> + + <para revision="286441">The &man.iwm.4; driver has been imported + from OpenBSD, providing support for &intel; 3160/7260/7265 + wireless chipsets.</para> + + <para revision="286829" contrib="sponsor" + sponsor="&limelight;">The &man.em.4; driver has been updated + to allow disabling <acronym>CRC</acronym> stripping.</para> + + <para revision="287222">The &man.pf.4; implementation has been + updated to remove support for the <literal>scrub fragment + crop|drop-ovl</literal> filtering rule. Systems with this + rule in &man.pf.conf.5; will implicitly be converted to the + <literal>scrub fragment reassemble</literal> filtering rule, + without necessary intervention.</para> + + <para revision="288654">The &man.lagg.4; driver has been updated + to remove support for the <literal>fec</literal> + protocol.</para> + </sect2> + </sect1> + + <sect1 xml:id="hardware"> + <title>Hardware Support</title> + + <para>This section covers general hardware support for physical + machines, hypervisors, and virtualization environments, as well + as hardware changes and updates that do not otherwise fit in + other sections of this document.</para> + + <sect2 xml:id="hardware-support"> + <title>Hardware Support</title> + + <para revision="268303">The &man.asmc.4; driver has been + updated to support the &apple; MacMini 3,1.</para> + + <para revision="268351">Support for &os;/ia64 has been dropped + as of &os; 11.</para> + + <para revision="274386">An issue that could cause a system to + hang when entering <acronym>ACPI</acronym> + <literal>S3</literal> state (suspend to + <acronym>RAM</acronym>) has been corrected in the &man.acpi.4; + and &man.pci.4; drivers.</para> + + <para revision="274733" arch="powerpc">The power management unit + subsystem has been updated to support power button events on + certain &arch.powerpc; hardware, such as aluminum + PowerBook ®.</para> + + <para revision="275171,275190" arch="powerpc">The &man.hwpmc.4; + driver has been updated to correct performance counter + sampling on G4 (MPC74xxx) and G5 class processors.</para> + + <para revision="275732" contrib="sponsor" + sponsor="&ff;,&netgate;">The + <application>OpenCrypto</application> framework has been + updated to include <literal>AES-ICM</literal> and + <literal>AES-GCM</literal> modes, both of which have also been + added to the &man.aesni.4; driver.</para> + + <para revision="281713" arch="powerpc">The &man.hwpmc.4; + driver has been updated to support the Freescale e500 + core.</para> + + <para revision="283766">The &man.ig4.4; driver has been added, + providing support for the fourth generation &intel; + <acronym>I2C</acronym> SMBus.</para> + + <para>The &man.uart.4; driver has been updated to support + <acronym>AMT</acronym> devices on newer systems.</para> + + <para revision="285316" contrib="sponsor" sponsor="&ff;" + arch="arm64">Initial <acronym>SMP</acronym> support has been + added to the &os;/&arch.arm64; port.</para> + </sect2> + + <sect2 xml:id="hardware-virtualization"> + <title>Virtualization Support</title> + + <para revision="260410">Support for the <quote>Virtual Interrupt + Delivery</quote> feature of &intel; VT-x is enabled if + supported by the CPU. This feature can be disabled by running + <literal>sysctl hw.vmm.vmx.use_apic_vid=0</literal>. + Additionally, to persist this setting across reboots, add + <literal>hw.vmm.vmx.use_apic_vid=0</literal> to + <filename>/etc/sysctl.conf</filename>.</para> + + <para revision="260532">Support for <quote>Posted Interrupt + Processing</quote> is enabled if supported by the CPU. This + feature can be disabled by running <literal>sysctl + hw.vmm.vmx.use_apic_pir=0</literal>. Additionally, to + persist this setting across reboots, add + <literal>hw.vmm.vmx.use_apic_pir=0</literal> to + <filename>/etc/sysctl.conf</filename>.</para> + + <para revision="260582">Unmapped IO support has been added to + &man.virtio_blk.4;.</para> + + <para revision="260583">Unmapped IO support has been added to + &man.virtio_scsi.4;.</para> + + <para revision="260847">The &man.virtio_random.4; driver has + been added to harvest entropy from the host system.</para> + + <para revision="261504">&os;/&arch.i386; guests can be run under + bhyve.</para> + + <para revision="267536" contrib="sponsor" + sponsor="&citrix.rd;">Support for running a &os;/&arch.amd64; + <application>Xen</application> guest instance as + <acronym>PVH</acronym> guest has been added. + <acronym>PVH</acronym> mode, short for <quote>Para-Virtualized + Hardware</quote>, uses para-virtualized drivers for boot and + I/O, and uses hardware virtualization extensions for all other + tasks, without the need for emulation.</para> + + <para revision="273375">The &man.bhyve.8; hypervisor has been + updated to support &amd; processors with + <acronym>SVM</acronym> and <acronym>AMD-V</acronym> hardware + extensions.</para> + + <para revision="273515">The &man.virtio.console.4; driver has + been added, which provides an interface to VirtIO console + devices through a &man.tty.4; device.</para> + + <para revision="279957">The &man.bhyve.8; hypervisor has been + updated to support <literal>DSM TRIM</literal> commands for + virtual <acronym>AHCI</acronym> disks.</para> + + <para revision="281439" arch="arm">Support for the + <application>QEMU</application> <literal>virt</literal> system + has been added.</para> + + <para revision="282212" contrib="sponsor" sponsor="&msostc;">The + Hyper-V™ drivers have been updated with several + enhancements:</para> + + <itemizedlist> + <listitem> + <para>The &man.hv.vmbus.4; driver now has multi-channel + support.</para> + </listitem> + + <listitem> + <para>The &man.hv.storvsc.4; driver now has scatter/gather + support, in addition to performance improvements.</para> + </listitem> + + <listitem> + <para>The &man.hv.kvp.4; driver has received several bug + fixes.</para> + </listitem> + </itemizedlist> + + <para revision="282274">Support for &man.xen.4; para-virtualized + <literal>domU</literal> kernels has been removed.</para> + + <para revision="284746" contrib="sponsor" sponsor="&msostc;">The + &man.hv.netvsc.4; driver has been updated to support checksum + offloading and <acronym>TSO</acronym>.</para> + + <para revision="286062">The &man.xen.4; driver has been updated + to include support for <literal>blkif</literal> indirect + segment I/O.</para> + </sect2> + + <sect2 xml:id="hardware-arm"> + <title>ARM Support</title> + + <para revision="260921">The &man.nand.4; device is enabled for + ARM devices by default.</para> + + <para revision="266943" arch="arm">Support for the Exynos 5420 + Octa system has been added.</para> + + <para revision="267390" arch="arm">The <acronym>SMP</acronym> + option has been enabled for all Exynos 5 systems supported by + &os;.</para> + + <para revision="268838" arch="arm">Support for the Toradex + Apalis i.MX6 development board has been added.</para> + + <para revision="273264" arch="armv6">An issue that could cause + instability when detecting <acronym>SD</acronym> cards on the + Raspberry Pi <acronym>SOC</acronym> has been fixed.</para> + + <para revision="275963">The <literal>bcm2835_cpufreq</literal> + driver has been added, which supports <acronym>CPU</acronym> + frequency and voltage control on the Raspberry Pi + <acronym>SOC</acronym>.</para> + + <para revision="277042" arch="arm">Support to turn off the + BeagleBone Black system with the &man.shutdown.8; + <literal>-p</literal> flag or by invoking &man.poweroff.8; has + been added.</para> + + <para revision="277644" arch="arm">Audio transmission drivers + have been added for Digital Audio Multiplexer + (<acronym>AUDMUXM</acronym>), Smart Direct Memory Access + Controller (<acronym>SDMA</acronym>), and Syncronous Serial + Interface (<acronym>SSI</acronym>).</para> + + <para revision="280259" contrib="sponsor" sponsor="&ff;">Initial + support for the ARM AArch64 architecture has been + added.</para> + + <para revision="282779" arch="arm">Kernel support for Thumb-2 + userland has been added.</para> + + <para revision="282827">Support for the hardware power button + on the BeagleBone Black system has been added.</para> + + <para revision="284273" contrib="sponsor" + sponsor="&ff;">Initial + <acronym>ACPI</acronym> support has been added for + &os;/&arch.arm64;.</para> + + <para revision="287225">Support for 1-Wire devices has been + added, providing support for 1-Wire hardware through + &man.gpio.4;. See &man.ow.4;, &man.owc.4;, and + &man.ow.temp.4; for more information.</para> + + <para revision="287371" arch="arm64" contrib="sponsor" + sponsor="&abt;">Support for the HiSilicon HI6220 SoC has been + added.</para> + </sect2> + </sect1> + + <sect1 xml:id="storage"> + <title>Storage</title> + + <para>This section covers changes and additions to file systems + and other storage subsystems, both local and networked.</para> + + <sect2 xml:id="storage-general"> + <title>General Storage</title> + + <para revision="278037" contrib="sponsor" sponsor="&ix;">The + &man.ctl.4; <acronym>LUN</acronym> mapping has been rewritten, + replacing <acronym>iSCSI</acronym>-specific mapping mechanisms + with a new mechanism that works for any port.</para> + + <para revision="278354" contrib="sponsor" sponsor="&ix;">The + &man.ctld.8; utility has been updated to allow controlling + non-<acronym>iSCSI</acronym> &man.ctl.4; ports.</para> + + <para revision="275681" contrib="sponsor" sponsor="&ff;">The + &man.autofs.5; subsystem has been updated to include a new + &man.auto.master.5; map, <literal>-media</literal>, which + allows automatically mounting removable media, such as + <acronym>CD</acronym> drives or <acronym>USB</acronym> flash + drives.</para> + + <para revision="279955" contrib="sponsor" sponsor="&ff;">The + &man.autofs.5; subsystem has been updated to include a new + &man.auto.master.5; map, <literal>-noauto</literal>, which + handles &man.fstab.5; entries set to + <literal>noauto</literal>.</para> + + <para revision="286444">The <acronym>GELI</acronym> class has + been updated to support the <literal>BIO_DELETE</literal> + &man.g.bio.9; <literal>bio_cmd</literal> field, providing + <acronym>TRIM</acronym>/<acronym>UNMAP</acronym> support on + <acronym>GELI</acronym>-backed <acronym>SSD</acronym> storage + providers.</para> + </sect2> + + <sect2 xml:id="storage-net"> + <title>Networked Storage</title> + + <para revision="270096" contrib="sponsor" sponsor="&ff;">The new + filesystem automount facility, &man.autofs.5;, has been added. + The new &man.autofs.5; facility is similar to that found in + other &unix;-like operating systems, such as OS X™ + and Solaris™. The &man.autofs.5; facility uses + a &sun;-compatible &man.auto.master.5; configuration file, and + is administered with the &man.automount.8; userland utility, + and the &man.automountd.8; and &man.autounmountd.8; + daemons.</para> + + <para revision="273849" contrib="sponsor" sponsor="&ff;">Support + for the <literal>timeo</literal>, <literal>actimeo</literal>, + <literal>noac</literal>, and <literal>proto</literal> options + have been added to &man.mount.nfs.8;.</para> + </sect2> + + <sect2 xml:id="storage-zfs"> + <title>ZFS</title> + + <para revision="275748">The <literal>arc_meta_limit</literal> + statistics are now visible through the + <literal>kstat</literal> &man.sysctl.8;. As a result of this + change, the <literal>vfs.zfs.arc_meta_used</literal> + &man.sysctl.8; has been removed, and replaced with the + <literal>kstat.zfs.misc.arcstats.arc_meta_used</literal> + &man.sysctl.8;.</para> + + <para revision="287099" contrib="sponsor" + sponsor="&clusterhq;">The &man.zfs.8; <literal>l2arc</literal> + code has been updated to take <literal>ashift</literal> into + account when gathering buffers to be written to the + <literal>l2arc</literal> device.</para> + </sect2> + + <sect2 xml:id="storage-geom"> + <title>&man.geom.4;</title> + + <para revision="267359">Support for the + <literal>disklabel64</literal> partitioning scheme has been + added to &man.gpart.8;.</para> + + <para revision="282465">Support for the + <literal>apple-boot</literal>, <literal>apple-hfs</literal>, + and <literal>apple-ufs</literal> <acronym>MBR</acronym> + partitioning schemes have been added to &man.gpart.8;.</para> + + <para revision="285594" contrib="sponsor" + sponsor="&scaleengine;">The &man.gpart.8; utility has been + updated to include a new attribute for <acronym>GPT</acronym> + partitions, <literal>lenovofix</literal>, which when set, + which works around <acronym>BIOS</acronym> compatibility + issues reported on several Lenovo ™ laptops.</para> + </sect2> + </sect1> + + <sect1 xml:id="boot"> + <title>Boot Loader Changes</title> + + <para>This section covers the boot loader, boot menu, and other + boot-related changes.</para> + + <sect2 xml:id="boot-loader"> + <title>Boot Loader Changes</title> + + <para revision="258431" contrib="sponsor" sponsor="&ff;">The + memory test run at boot time on &os;/&arch.amd64; platforms + has been disabled by default.</para> + + <para revision="262955">A new &man.ttys.5; class, + <literal>3wire</literal>, has been added. This is similar to + the existing terminal classes, but does not have a defined + baudrate.</para> + + <para revision="274085">The &man.vt.4; driver has been made the + default system console driver. The &man.syscons.4; driver is + still available, and can be enabled by adding + <literal>kern.vty=sc</literal> in &man.loader.conf.5;. + Alternatively, &man.syscons.4; can be enabled at boot time by + entering <literal>set kern.vty=sc</literal> at the + &man.loader.8; prompt.</para> + + <para revision="279950">Support for <literal>bzipfs</literal> + has been added to the <acronym>EFI</acronym> loader.</para> + + <para revision="281616">The boot loader has been updated to + support entering the <acronym>GELI</acronym> passphrase before + loading the kernel. To enable this behavior, add + <literal>geom_eli_passphrase_prompt="YES"</literal> to + &man.loader.conf.5;.</para> + + <para revision="284683" contrib="sponsor" sponsor="&ff;" + arch="arm">The &man.ttys.5; file for &os;/&arch.arm; has been + updated to enable <filename>ttyu1</filename>, + <filename>ttyu2</filename>, and <filename>ttyu3</filename> by + default, if the callin port is an active console port.</para> + </sect2> + + <sect2 xml:id="boot-menu"> + <title>Boot Menu Changes</title> + + <para> </para> + </sect2> + </sect1> + + <sect1 xml:id="network"> + <title>Networking</title> + + <para>This section describes changes that affect networking in + &os;.</para> + + <sect2 xml:id="network-protocols"> + <title>Network Protocols</title> + + <para revision="263140">Support for the IPX network transport + protocol has been removed, and will not be supported in + &os; 11 and later releases.</para> + + <para revision="272720" contrib="sponsor" + sponsor="&limelight;">Support for <acronym>PLPMTUD</acronym> + blackhole detection (<acronym>RFC</acronym> 4821) has been + added to the &man.tcp.4; stack, disabled by default. New + control tunables have been added:</para> + + <informaltable frame="none" pgwide="0"> + <tgroup cols="2"> + <colspec colwidth="1*"/> + <colspec colwidth="1*"/> + <thead> + <row> + <entry>Tunable</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry><literal>net.inet.tcp.pmtud_blackhole_detection</literal></entry> + <entry>Enables or disables <acronym>PLPMTUD</acronym> + blackhole detection</entry> + </row> + + <row> + <entry><literal>net.inet.tcp.pmtud_blackhole_mss</literal></entry> + <entry><acronym>MSS</acronym> to try for IPv4</entry> + </row> + + <row> + <entry><literal>net.inet.tcp.v6pmtud_blackhole_mss</literal></entry> + <entry><acronym>MSS to try for IPv6</acronym></entry> + </row> + </tbody> + </tgroup> + </informaltable> + + <para>New monitoring &man.sysctl.8;s haven been added:</para> + + <informaltable frame="none" pgwide="0"> + <tgroup cols="2"> + <colspec colwidth="1*"/> + <colspec colwidth="1*"/> + <thead> + <row> + <entry>Tunable</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry><literal>net.inet.tcp.pmtud_blackhole_activated</literal></entry> + <entry>Number of times the code was activated to attempt + downshifting the <acronym>MSS</acronym></entry> + </row> + + <row> + <entry><literal>net.inet.tcp.pmtud_blackhole_min_activated</literal></entry> + <entry>Number of times the blackhole + <acronym>MSS</acronym> was used in an attempt to + downshift</entry> + </row> + + <row> + <entry><literal>net.inet.tcp.pmtud_blackhole_failed</literal></entry> + <entry>Number of times that the blackhole failed to + connect after downshifting the + <acronym>MSS</acronym></entry> + </row> + </tbody> + </tgroup> + </informaltable> + + <para revision="280971" contrib="sponsor" + sponsor="&netflix;, &nginx;">Support for <acronym>IP</acronym> + identification for atomic datagrams (<acronym>RFC</acronym> + 6864) has been added. Support for this feature can be toggled + with the <literal>net.inet.ip.rfc6864</literal> + &man.sysctl.8;, which is enabled by default.</para> + + <para revision="285336" contrib="sponsor" + sponsor="&netgate;">The <acronym>IPSEC</acronym> has been + updated to include support for <acronym>AES</acronym> modes on + both software-only and hardware-backed (&man.aesni.4;) + systems.</para> + + <para revision="287798" contrib="sponsor" sponsor="&dell;">The + network stack has been updated to fix handling of + <acronym>IPv6</acronym> On-Link redirects.</para> + </sect2> + </sect1> + + <sect1 xml:id="ports"> + <title>Ports Collection and Package Infrastructure</title> + + <para>This section covers changes to the &os; Ports + Collection, package infrastructure, and package maintenance and + installation tools.</para> + + <sect2 xml:id="ports-infrastructure"> + <title>Infrastructure Changes</title> + + <para> </para> + </sect2> + + <sect2 xml:id="ports-packages "> + <title>Packaging Changes</title> + + <para> </para> + </sect2> + </sect1> + + <sect1 xml:id="doc"> + <title>Documentation</title> + + <para>This section covers changes to the &os; Documentation + Project sources and toolchain.</para> + + <sect2 xml:id="doc-sources"> + <title>Documentation Source Changes</title> + + <para> </para> + </sect2> + + <sect2 xml:id="doc-toolchain"> + <title>Documentation Toolchain Changes</title> + + <para> </para> + </sect2> + </sect1> + + <sect1 xml:id="releng"> + <title>Release Engineering and Integration</title> + + <para>This section convers changes that are specific to the + &os; Release Engineering processes.</para> + + <sect2 xml:id="releng-changes"> + <title>Integration Changes</title> + + <para revision="277458" contrib="sponsor" sponsor="&ff;">The + Release Engineering build tools have been updated to include + support for producing virtual machine disk images for various + cloud hosting providers.</para> + + <para revision="278926">The Release Engineering build tools have + been updated to use multi-threaded &man.xz.1;. By default, + the number of &man.xz.1; threads is set to the number of cores + available.</para> + + <para revision="281802" contrib="sponsor" sponsor="&ff;">The + Release Engineering build tools have been updated to include + support for building &os;/&arch.arm64; virtual machine and + memory stick installation images.</para> + + <para revision="282693" contrib="sponsor" sponsor="&ff;">The + Release Engineering build tools have been updated to support + building &os;/&arch.arm; images without external utilities for + supported boards where a corresponding + <literal>u-boot</literal> port exists in the Ports + Collection.</para> + + <para revision="283307" contrib="sponsor" sponsor="&ff;">The + &os;/&arch.i386; memory stick installation images are now + created using the &man.mkimg.1; utility, matching the way + the &os;/&arch.amd64; images are created.</para> + </sect2> + </sect1> +</article> diff --git a/release/doc/en_US.ISO8859-1/share/xml/catalog.xml b/release/doc/en_US.ISO8859-1/share/xml/catalog.xml new file mode 100644 index 0000000..1bc6541 --- /dev/null +++ b/release/doc/en_US.ISO8859-1/share/xml/catalog.xml @@ -0,0 +1,12 @@ +<?xml version="1.0"?> +<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" + "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd"> + +<!-- $FreeBSD$ --> + +<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"> + <rewriteSystem systemIdStartString="http://www.FreeBSD.org/release/XML/lang/" + rewritePrefix="../../"/> + <rewriteURI uriStartString="http://www.FreeBSD.org/release/XML/lang/" + rewritePrefix="../../"/> +</catalog> diff --git a/release/doc/en_US.ISO8859-1/share/xml/release.xsl b/release/doc/en_US.ISO8859-1/share/xml/release.xsl new file mode 100644 index 0000000..a854cd9 --- /dev/null +++ b/release/doc/en_US.ISO8859-1/share/xml/release.xsl @@ -0,0 +1,28 @@ +<?xml version="1.0"?> +<!-- $FreeBSD$ --> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version='1.0' + xmlns="http://www.w3.org/TR/xhtml1/transitional" + xmlns:db="http://docbook.org/ns/docbook" + exclude-result-prefixes="db"> + + <xsl:param name="release.url"/> + <xsl:param name="release.branch"/> + <xsl:param name="release.maillist"/> + + <xsl:template name="user.footer.content"> + <p align="center"><small>This file, and other release-related documents, + can be downloaded from <a href="{$release.url}"><xsl:value-of select="$release.url"/></a>.</small></p> + + <p align="center"><small>For questions about FreeBSD, read the + <a href="http://www.FreeBSD.org/docs.html">documentation</a> before + contacting <<a href="mailto:questions@FreeBSD.org">questions@FreeBSD.org</a>>.</small></p> + + <p align="center"><small>All users of FreeBSD <xsl:value-of select="$release.branch"/> should + subscribe to the <<a href="mailto:{$release.maillist}@FreeBSD.org"><xsl:value-of select="$release.maillist"/>@FreeBSD.org</a>> + mailing list.</small></p> + + <p align="center"><small>For questions about this documentation, + e-mail <<a href="mailto:doc@FreeBSD.org">doc@FreeBSD.org</a>>.</small></p> + </xsl:template> +</xsl:stylesheet> diff --git a/release/doc/share/examples/Makefile.relnotesng b/release/doc/share/examples/Makefile.relnotesng new file mode 100644 index 0000000..9607e28 --- /dev/null +++ b/release/doc/share/examples/Makefile.relnotesng @@ -0,0 +1,61 @@ +# -*- makefile -*- +# +# $FreeBSD$ +# +# Sample makefile for rendering and uploading RELNOTESng files outside +# the build tree. +# + +ARCHS= amd64 i386 pc98 powerpc sparc64 +MULTITEXTS= +UNITEXTS= hardware readme relnotes errata + +IMAGEDIR= .imagedir +RHOST= freefall.freebsd.org +RDIR= public_html/relnotes/CURRENT +DOCDIR= ./release/doc +LANG= en_US.ISO8859-1 + +DOC_PREFIX?= /usr/doc +CSS_SHEET?= ${DOC_PREFIX}/share/misc/docbook.css +FORMATS?= html txt pdf + +BUILD_OPTIONS+= URLS_ABSOLUTE=YES + +all: + (cd ${DOCDIR}; ${MAKE} DOC_PREFIX=${DOC_PREFIX} FORMATS="${FORMATS}" ${BUILD_OPTIONS} all) + +lint: + (cd ${DOCDIR}; ${MAKE} DOC_PREFIX=${DOC_PREFIX} lint) + +image: all + @echo "#" + @echo "# Creating local image" + @echo "#" + rm -rf ${IMAGEDIR} + mkdir ${IMAGEDIR} + cp -p ${CSS_SHEET} ${IMAGEDIR}/docbook.css + for i in ${ARCHS}; do \ + for j in ${MULTITEXTS}; do \ + for k in ${FORMATS}; do \ + cp -p ${DOCDIR}/${LANG}/$${j}/$${i}/article.$${k} ${IMAGEDIR}/$${j}-$${i}.$${k} ; \ + done; \ + done; \ + done + for j in ${UNITEXTS}; do \ + for k in ${FORMATS}; do \ + cp -p ${DOCDIR}/${LANG}/$${j}/article.$${k} ${IMAGEDIR}/$${j}.$${k} ; \ + done; \ + done + +push: image + @echo "#" + @echo "# Pushing to ${RHOST}" + @echo "#" +# (cd ${IMAGEDIR}; tar -cf - .) | gzip -c -9 | (ssh ${RHOST} "( cd ${RDIR}; gunzip -c | tar -xf -)" ) + (cd ${IMAGEDIR}; rsync -azuv * ${RHOST}:${RDIR}) + rm -rf ${IMAGEDIR} + +clean: + (cd ${DOCDIR}; ${MAKE} DOC_PREFIX=${DOC_PREFIX} FORMATS="${FORMATS}" clean) + rm -rf ${IMAGEDIR} diff --git a/release/doc/share/misc/dev.archlist.txt b/release/doc/share/misc/dev.archlist.txt new file mode 100644 index 0000000..5f62f48 --- /dev/null +++ b/release/doc/share/misc/dev.archlist.txt @@ -0,0 +1,178 @@ +# +# Copyright (c) 2004-2006 The FreeBSD Project +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# 1. Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +# SUCH DAMAGE. +# +# $FreeBSD$ +# + +# +# This file is used by man2hwnotes.pl to set which drivers are usable +# on which architectures. +# +# Format: +# +# Empty lines, and lines beginning with "#" are ignored. +# <Driver name><tab><arch>[,<arch>...] +# +aac i386,amd64 +adv i386,pc98,amd64 +adw i386,pc98,amd64 +aha i386 +ahb i386 +ahd i386,sparc64,amd64 +aic i386,pc98,amd64 +amd i386,pc98,amd64 +arcmsr i386,amd64 +asr i386 +ath i386,pc98,amd64,sparc64 +aue i386,pc98,amd64,powerpc +axe i386,pc98,amd64,powerpc +bce i386,amd64 +bge i386,pc98,sparc64,amd64 +bktr i386,pc98 +bt i386,amd64 +bxe i386,amd64 +cdce i386,pc98,amd64,powerpc +ciss i386,amd64 +ce i386,pc98 +cm i386 +cnw i386,pc98,amd64 +cp i386,pc98 +ct pc98 +ctau i386 +cue i386,pc98,amd64,powerpc +cx i386 +cxgb i386,amd64 +de i386,pc98,amd64 +dpt i386,amd64 +ed i386,pc98 +ep i386,pc98,amd64 +esp sparc64 +ex i386,amd64 +fe i386,pc98,amd64 +fwohci i386,sparc64,amd64,powerpc +hifn i386,pc98,amd64 +hpt27xx i386,amd64 +hptiop i386,amd64 +hptmv i386,amd64 +hptrr i386,amd64 +ida i386 +ie i386 +iir i386,amd64 +ips i386,amd64 +isci i386,amd64 +ixgb i386,amd64 +kue i386,pc98,amd64,powerpc +lge i386,pc98,amd64 +mfi i386,amd64 +mlx i386,amd64 +mly i386,amd64 +msk i386,amd64 +mxge i386,amd64 +my i386,pc98 +ncr i386,pc98,amd64 +ncv i386,pc98 +nfe i386,amd64 +ng_bt3c i386,pc98,amd64 +ng_ubt i386,pc98,amd64 +nsp i386,pc98 +nxge i386,amd64 +oce i386,amd64 +ohci i386,pc98,amd64,powerpc +oltr i386 +otus i386,amd64 +pcn i386,pc98,amd64 +pst i386 +qlxgb amd64 +qlxgbe amd64 +qlxge amd64 +rc i386 +ral i386,amd64 +rsu i386,amd64 +rue i386,pc98,amd64 +rum i386,amd64 +run i386,amd64 +safe i386,pc98,amd64 +sbp i386,sparc64,amd64 +sfgxe amd64 +sn i386,amd64 +snc pc98 +snd_ad1816 i386,amd64 +snd_als4000 i386 +snd_atiixp i386,amd64 +snd_audiocs sparc64 +snd_cmi i386,amd64 +snd_cs4281 i386,amd64 +snd_csa i386,amd64 +snd_ds1 i386,amd64 +snd_emu10k1 i386,amd64 +snd_emu10kx i386,amd64 +snd_envy24 i386,amd64 +snd_envy24ht i386,amd64 +snd_es137x i386,sparc64,amd64 +snd_ess i386,amd64 +snd_fm801 i386,amd64 +snd_gusc i386,amd64 +snd_hda i386,amd64 +snd_hdspe i386,amd64 +snd_ich i386,amd64 +snd_maestro i386,amd64 +snd_maestro3 i386,amd64 +snd_mss i386 +snd_neomagic i386,amd64 +snd_sbc i386,amd64 +snd_solo i386,amd64 +snd_spicds i386,amd64 +snd_t4dwave i386,amd64,sparc64 +snd_via8233 i386,amd64 +snd_via82c686 i386,amd64 +snd_vibes i386,amd64 +stg i386,pc98 +ti i386,pc98,amd64,sparc64 +tl i386,pc98,amd64 +trm i386,amd64 +twa i386,amd64 +twe i386,amd64 +tws i386,amd64 +ubsa i386,pc98,amd64 +ubsec i386,pc98,amd64 +ubser i386,pc98,amd64 +ucycom i386,pc98,amd64 +udav i386,pc98,amd64 +uftdi i386,pc98,amd64 +uhci i386,pc98,amd64,powerpc +ulpt i386,pc98,amd64,powerpc +umass i386,pc98,amd64,powerpc +umodem i386,pc98,amd64 +uplcom i386,pc98,amd64 +ural i386,amd64 +urio i386,pc98,amd64,powerpc +uvisor i386,pc98,amd64 +uvscom i386,pc98,amd64 +vpo i386 +vx i386,pc98,amd64 +vxge i386,amd64 +wb i386,pc98,amd64 +xe i386,amd64 +zyd i386,amd64 diff --git a/release/doc/share/misc/man2hwnotes.pl b/release/doc/share/misc/man2hwnotes.pl new file mode 100644 index 0000000..a64aae8 --- /dev/null +++ b/release/doc/share/misc/man2hwnotes.pl @@ -0,0 +1,533 @@ +#!/usr/bin/perl -w +# Emacs should use -*- cperl -*- mode +# +# Copyright (c) 2003-2006 Simon L. Nielsen <simon@FreeBSD.org> +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# 1. Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +# SUCH DAMAGE. +# +# $FreeBSD$ +# + +# Parse the list of supported hardware out of section 4 manual pages +# and output it on stdout as SGML/DocBook entities. + +# The script will look for the following line in the manual page: +# .Sh HARDWARE +# and make an entity of the content until the line containing: +# .Sh +# +# For Lists only the first line will be printed. If there are +# arguments to the .It command, only the argument will be printed. + +# Usage: +# man2hwnotes.pl [-cl] [-d 0-6] [-a <archlist file>] [-o <outputfile>] +# <manualpage> [<manualpage> ...] + +use strict; +use Getopt::Std; +use Digest::MD5 qw(md5_hex); + +# Section from manual page to extract +my $hwlist_sect = "HARDWARE"; + +# Override default archtecture list for some devices: +my $archlist_file = "dev.archlist.txt"; +my %archlist; + +# Globals +my $compat_mode = 0; # Enable compat for old Hardware Notes style +my $debuglevel = 0; +my $only_list_out = 0; # Should only lists be generated in the output? +my @out_lines; # Single lines +my @out_dev; # Device entities + +# Getopt +my %options = (); +if (!getopts("a:cd:lo:",\%options)) { + die("$!: Invalid command line arguments in ", __LINE__, "\n"); +} + +if (defined($options{c})) { + $compat_mode = 1; +} +if (defined($options{d})) { + $debuglevel = $options{d}; +} +if (defined($options{a})) { + $archlist_file = $options{a}; +} +if (defined($options{l})) { + $only_list_out = 1; +} + +my $outputfile = $options{o}; + +if ($debuglevel > 0) { + # Don't do output buffering in debug mode. + $| = 1; +} + +load_archlist($archlist_file); + +if (defined($outputfile)) { + open(OLDOUT, ">&STDOUT") || die("$!: Could not open STDOUT in ", __LINE__, ".\n"); + open(STDOUT, ">$outputfile") || die("$!: Could not open $outputfile in ", __LINE__, ".\n"); +} + +print <<EOT; +<!-- + These are automatically generated device lists for FreeBSD hardware notes. +--> +EOT + +if ($only_list_out) { + # Print the default device preamble entities + print "<!ENTITY hwlist.preamble.pre 'The'>\n"; + print "<!ENTITY hwlist.preamble.post 'driver supports:'>\n"; +} + +foreach my $page (@ARGV) { + if ($page !~ m/\.4$/) { + dlog(2, "Skipped $page (not *.4)"); + next; + } + dlog(2, "Parsing $page"); + parse($page); + + if (@out_lines) { + print join("\n", @out_lines), "\n"; + } + if (@out_dev) { + print join("\n", @out_dev), "\n"; + } + + @out_lines = (); + @out_dev = (); +} + +if (defined($outputfile)) { + open(STDOUT, ">&OLDOUT") || die("$!: Could not open STDOUT in ", __LINE__, ".\n"); + close(OLDOUT) || die("$!: Could not close OLDOUT in ", __LINE__, ".\n"); +} + +sub normalize (@) { + my @lines = @_; + + foreach my $l (@lines) { + $l =~ s/\\&//g; + $l =~ s:([\x21-\x2f\x5b-\x60\x7b-\x7f]):sprintf("&\#\%d;", ord($1)):eg; + # Make sure ampersand is encoded as & since jade seems to + # be confused when it is encoded as & inside an entity. + $l =~ s/&/&/g; + } + return (wantarray) ? @lines : join "", @lines; +} + +sub parse { + my ($manpage) = @_; + + my $cur_mansection; + my $found_hwlist = 0; + my %mdocvars; + $mdocvars{isin_hwlist} = 0; + $mdocvars{isin_list} = 0; + $mdocvars{first_para} = 1; + $mdocvars{parabuf} = ""; + $mdocvars{listtype} = ""; + $mdocvars{it_nr} = 0; + + open(MANPAGE, "$manpage") || die("$!: Could not open $manpage in ", __LINE__, ".\n"); + while(<MANPAGE>) { + chomp; + my $line = $_; + + dlog(5, "Read '$line'"); + + # Find commands + if (s/^\.(.*)$/$1/) { + my $cmd = $1; + + # Detect, and ignore, comment lines + if (s/^\\"(.*)$/$1/) { + next; + } + + $cmd =~ s/^([^ ]+).*$/$1/; + + if (/^Nm "?(\w+)"?/ && !defined($mdocvars{Nm})) { + dlog(3, "Setting Nm to $1"); + $mdocvars{Nm} = $1; + # "_" cannot be used for an entity name. + $mdocvars{EntNm} = $1; + $mdocvars{EntNm} =~ s,_,.,g; + + } elsif (/^Nm$/) { + if (defined($mdocvars{Nm}) && $mdocvars{Nm} ne "") { + parabuf_addline(\%mdocvars, "&man.".$mdocvars{EntNm}.".$cur_mansection;"); + } else { + dlog(2, "Warning: Bad Nm call in $manpage"); + } + + } elsif (/^Sh (.+)$/) { + dlog(4, "Setting section to $1"); + my $cur_section = $1; + + flush_out(\%mdocvars); + + if ($cur_section =~ /^${hwlist_sect}$/) { + dlog(2, "Found the device section ${hwlist_sect}"); + $mdocvars{isin_hwlist} = 1; + $found_hwlist = 1; + add_sgmltag(\%mdocvars, "<!ENTITY hwlist.".$mdocvars{cur_manname}." '"); + if ($only_list_out) { + add_sgmltag("<para xmlns=\"http://docbook.org/ns/docbook\">&hwlist.preamble.pre; " . + "&man.".$mdocvars{EntNm}.".$cur_mansection; " . + "&hwlist.preamble.post;</para>"); + } + } elsif ($mdocvars{isin_hwlist}) { + dlog(2, "Found a HWLIST STOP key!"); + add_sgmltag(\%mdocvars, "'>"); + $mdocvars{isin_hwlist} = 0; + } + if ($mdocvars{isin_list}) { + dlog(1, "Warning: Still in list, but just entered new " . + "section. This is probably due to missing .El; " . + "check manual page for errors."); + # If we try to recover from this we will probably + # just end with bad SGML output and it really + # should be fixed in the manual page so we don't + # even try to "fix" this. + } + + + } elsif (/^Dt ([^ ]+) ([^ ]+)/) { + dlog(4, "Setting mansection to $2"); + $mdocvars{cur_manname} = lc($1); + $cur_mansection = $2; + + # "_" cannot be used for an entity name. + $mdocvars{cur_manname} =~ s,_,.,g; + + } elsif (/^It ?(.*)$/) { + my $txt = $1; + + $mdocvars{it_nr}++; + + # Flush last item + if ($mdocvars{parabuf} ne "") { + add_listitem(\%mdocvars); + } + + # Remove quotes, if any. + $txt =~ s/"(.*)"/$1/; + + if ($mdocvars{listtype} eq "column") { + # Ignore first item when it is likely to be a + # header. + if ($mdocvars{it_nr} == 1 && $txt =~ m/^(Em|Sy) /) { + dlog(2, "Skipping header line in column list"); + next; + } + # Only extract the first column. + $txt =~ s/ Ta /\t/g; + $txt =~ s/([^\t]+)\t.*/$1/; + } + + # Remove Li commands + $txt =~ s/^Li //g; + + parabuf_addline(\%mdocvars, normalize($txt)); + } elsif (/^Bl/) { + $mdocvars{isin_list} = 1; + flush_out(\%mdocvars); + add_sgmltag(\%mdocvars, "<itemizedlist xmlns=\"http://docbook.org/ns/docbook\">"); + + if (/-tag/) { + $mdocvars{listtype} = "tag"; + # YACK! Hack for ata(4) + if ($mdocvars{Nm} eq "ata") { + $mdocvars{listtype} = "tagHACK"; + } + } elsif (/-bullet/) { + $mdocvars{listtype} = "bullet"; + } elsif (/-column/) { + $mdocvars{listtype} = "column"; + } else { + $mdocvars{listtype} = "unknown"; + } + dlog(2, "Listtype set to $mdocvars{listtype}"); + } elsif (/^El/) { + if ($mdocvars{parabuf} ne "") { + add_listitem(\%mdocvars); + } + + add_sgmltag(\%mdocvars, "</itemizedlist>"); + $mdocvars{isin_list} = 0; + } elsif (/^Tn (.+)$/) { + # For now we print TradeName text as regular text. + my ($txt, $punct_str) = split_punct_chars($1); + + parabuf_addline(\%mdocvars, normalize($txt . $punct_str)); + } elsif (/^Xr ([^ ]+) (.+)$/) { + my ($xr_sect, $punct_str) = split_punct_chars($2); + my $txt; + + # We need to check if the manual page exist to avoid + # breaking the doc build just because of a broken + # reference. + #$txt = "&man.$1.$xr_sect;$punct_str"; + $txt = "$1($xr_sect)$punct_str"; + parabuf_addline(\%mdocvars, normalize($txt)); + } elsif (/^Dq (.+)$/) { + my ($txt, $punct_str) = split_punct_chars($1); + + parabuf_addline(\%mdocvars, + normalize("<quote xmlns=\"http://docbook.org/ns/docbook\">$txt</quote>$punct_str")); + } elsif (/^Sx (.+)$/) { + if ($mdocvars{isin_hwlist}) { + dlog(1, "Warning: Reference to another section in the " . + "$hwlist_sect section in " . $mdocvars{Nm} . + "(${cur_mansection})"); + } + parabuf_addline(\%mdocvars, normalize($1)); + } elsif (/^Pa (.+)$/) { + my ($txt, $punct_str) = split_punct_chars($1); + + $txt = make_ulink($txt) . $punct_str; + parabuf_addline(\%mdocvars, normalize($txt)); + } elsif (/^Pp/) { + dlog(3, "Got Pp command - forcing new para"); + flush_out(\%mdocvars); + } elsif (/^Fx (.+)/) { + dlog(3, "Got Fx command"); + parabuf_addline(\%mdocvars, "FreeBSD $1"); + } elsif (/^Fx/) { + dlog(3, "Got Fx command"); + parabuf_addline(\%mdocvars, "FreeBSD"); + } elsif (/^Em (.+)$/) { + my ($txt, $punct_str) = split_punct_chars($1); + + parabuf_addline(\%mdocvars, + normalize("<emphasis xmlns=\"http://docbook.org/ns/docbook\">$txt</emphasis>$punct_str")); + } else { + # Ignore all other commands. + dlog(3, "Ignoring unknown command $cmd"); + } + } else { + # This is then regular text + parabuf_addline(\%mdocvars, normalize($_)); + } + } + close(MANPAGE) || die("$!: Could not close $manpage in ", __LINE__, ".\n"); + if (! $found_hwlist) { + dlog(2, "Hardware list not found in $manpage"); + } +} + +sub dlog { + my ($level, $txt) = @_; + + if ($level <= $debuglevel) { + print STDERR "$level: $txt\n"; + } +} + +# Output a SGML tag. +sub add_sgmltag { + my ($mdocvars, $txt) = (@_); + + # We only care about the HW list for now. + if (${$mdocvars}{isin_hwlist}) { + push(@out_dev, $txt); + } +} + +# Add a text entity, and return the used entity name. +sub add_txt_ent { + my ($itemtxt) = (@_); + my ($entity_name); + + # Convert mdoc(7) minus + $itemtxt =~ s/\\-/-/g; + + $itemtxt =~ s/'/‘/g; + + $entity_name = "hwlist." . md5_hex($itemtxt); + dlog(4, "Adding '$itemtxt' as entity $entity_name"); + push(@out_lines, "<!ENTITY $entity_name '$itemtxt'>"); + + return ($entity_name); +} +sub flush_out { + my ($mdocvars) = (@_); + my ($entity_name, $out); + my $para_arch = ""; + + if (!${$mdocvars}{isin_hwlist} || ${$mdocvars}{parabuf} eq "") { + return; + } + + $entity_name = add_txt_ent(${$mdocvars}{parabuf}); + ${$mdocvars}{parabuf} = ""; + if(defined($archlist{${$mdocvars}{Nm}})) { + if ($compat_mode) { + $para_arch = ' arch="' . $archlist{${$mdocvars}{Nm}} . '"'; + } else { + $para_arch = '[' . $archlist{${$mdocvars}{Nm}} . '] '; + } + } + if ($compat_mode) { + $out = "<para xmlns=\"http://docbook.org/ns/docbook\"".$para_arch.">&".$entity_name.";</para>"; + } else { + if (${$mdocvars}{first_para}) { + $out = "<para xmlns=\"http://docbook.org/ns/docbook\">".$para_arch."&".$entity_name.";</para>"; + } else { + $out = "<para xmlns=\"http://docbook.org/ns/docbook\">&".$entity_name.";</para>"; + } + ${$mdocvars}{first_para} = 0; + } + + dlog(4, "Flushing parabuf"); + add_sgmltag($mdocvars, $out); +} + +# Add a new list item from the "parabuf". +sub add_listitem { + my ($mdocvars) = (@_); + my ($listitem, $entity_name); + my $para_arch = ""; + + $entity_name = add_txt_ent(${$mdocvars}{parabuf}); + ${$mdocvars}{parabuf} = ""; + + if ($compat_mode) { + if(defined($archlist{${$mdocvars}{Nm}})) { + $para_arch = ' arch="' . $archlist{${$mdocvars}{Nm}} . '"'; + } + } + $listitem = "<listitem><para".$para_arch.">&".$entity_name.";</para></listitem>"; + dlog(4, "Adding '$listitem' to out_dev"); + push(@out_dev, $listitem); + +} + +# Add a line to the "paragraph buffer" +sub parabuf_addline { + my $mdocvars = shift; + my ($txt) = (@_); + + dlog(5, "Now in parabuf_addline for '$txt'"); + + # We only care about the HW list for now. + if (!${$mdocvars}{isin_hwlist}) { + dlog(6, "Exiting parabuf_addline due to: !\${\$mdocvars}{isin_hwlist}"); + return; + } + if ($txt eq "") { + dlog(6, "Exiting parabuf_addline due to: \$txt eq \"\""); + return; + } + + if ($only_list_out && !${$mdocvars}{isin_list}) { + dlog(6, "Exiting parabuf_addline due to: ". + "\$only_list_out && !\${\$mdocvars}{isin_list}"); + return; + } + + # We only add the first line for "tag" lists + if (${$mdocvars}{parabuf} ne "" && ${$mdocvars}{isin_list} && + ${$mdocvars}{listtype} eq "tag") { + dlog(6, "Exiting parabuf_addline due to: ". + "\${\$mdocvars}{parabuf} ne \"\" && \${\$mdocvars}{isin_list} && ". + "\${\$mdocvars}{listtype} eq \"tag\""); + return; + } + + if (${$mdocvars}{parabuf} ne "") { + ${$mdocvars}{parabuf} .= " "; + } + + dlog(4, "Adding '$txt' to parabuf"); + + ${$mdocvars}{parabuf} .= $txt; +} + +sub load_archlist { + my ($file) = (@_); + + my $lineno = 0; + + dlog(2, "Parsing archlist $file"); + + open(FILE, "$file") || die("$!: Could not open archlist $file in ", __LINE__, ".\n"); + while(<FILE>) { + chomp; + $lineno++; + + if (/^#/ || $_ eq "") { + next; + } + + if (/(\w+)\t([\w,]+)/) { + dlog(4, "For driver $1 setting arch to $2"); + $archlist{$1} = $2; + } else { + dlog(1, "Warning: Could not parse archlist line $lineno"); + } + } + + close(FILE); +} + +# Check if a character is a mdoc(7) punctuation character. +sub is_punct_char { + my ($str) = (@_); + + return (length($str) == 1 && $str =~ /[\.,:;()\[\]\?!]/); +} + +# Split out the punctuation characters of a mdoc(7) line. +sub split_punct_chars { + my ($str) = (@_); + my (@stritems, $stritem, $punct_str); + + $punct_str = ""; + @stritems = split(/ /, $str); + + while (defined($stritem = $stritems[$#stritems]) && + is_punct_char($stritem)) { + $punct_str = $stritem . $punct_str; + pop(@stritems); + } + + return (join(' ', @stritems), $punct_str); +} + +# Create a ulink, if the string contains an URL. +sub make_ulink { + my ($str) = (@_); + + $str =~ s,(http://[^ ]+),<link xmlns=\"http://docbook.org/ns/docbook\" xlink:href="$1"></link>,; + + return $str; +} diff --git a/release/doc/share/mk/doc.relnotes.mk b/release/doc/share/mk/doc.relnotes.mk new file mode 100644 index 0000000..ae8a31f --- /dev/null +++ b/release/doc/share/mk/doc.relnotes.mk @@ -0,0 +1,54 @@ +# $FreeBSD$ + +DOC_PREFIX?= ${RELN_ROOT}/../../../doc + +# XXX +RELEASETYPE!= grep -o 'release.type "[a-z]*"' ${RELN_ROOT}/share/xml/release.ent | sed 's|[a-z.]* "\([a-z]*\)"|\1|' +RELEASEURL!= grep -o 'release.url \"[^\"]*\"' ${RELN_ROOT}/share/xml/release.ent | sed 's|[^ ]* "\([^"]*\)"|\1|' +RELEASEBRANCH!= grep -o 'release.branch "\([^"]*\)"' ${RELN_ROOT}/share/xml/release.ent | sed 's|[^ ]* "\([^"]*\)"|\1|' +RELEASEMAILLIST!= grep -o 'release.maillist "\([^"]*\)"' ${RELN_ROOT}/share/xml/release.ent | sed 's|[^ ]* "\([^"]*\)"|\1|' +.if ${RELEASETYPE} == "current" +PROFILING+= --param profile.attribute "'releasetype'" --param profile.value "'current'" +.elif ${RELEASETYPE} == "snapshot" +PROFILING+= --param profile.attribute "'releasetype'" --param profile.value "'snapshot'" +.elif ${RELEASETYPE} == "release" +PROFILING+= --param profile.attribute "'releasetype'" --param profile.value "'release'" +.endif +XSLTPROCFLAGS+= --param release.url "'${RELEASEURL}'" +XSLTPROCFLAGS+= --param release.branch "'${RELEASEBRANCH}'" +XSLTPROCFLAGS+= --param release.maillist "'${RELEASEMAILLIST}'" +XSLTPROCFLAGS+= --param toc.section.depth "'3'" + +# Find the RELNOTESng document catalogs +EXTRA_CATALOGS+= file://${RELN_ROOT}/${LANGCODE}/share/xml/catalog.xml \ + file://${RELN_ROOT}/share/xml/catalog.xml + +XSLXHTML= http://www.FreeBSD.org/release/XML/share/xml/release.xsl + +# +# Automatic device list generation: +# +.if exists(${RELN_ROOT}/../man4) +MAN4DIR?= ${RELN_ROOT}/../man4 +.elif exists(${RELN_ROOT}/../../man4) +MAN4DIR?= ${RELN_ROOT}/../../man4 +.else +MAN4DIR?= ${RELN_ROOT}/../../share/man/man4 +.endif +MAN4PAGES?= ${MAN4DIR}/*.4 ${MAN4DIR}/man4.*/*.4 +ARCHLIST?= ${RELN_ROOT}/share/misc/dev.archlist.txt +DEV-AUTODIR= ${RELN_ROOT:S/${.CURDIR}/${.OBJDIR}/}/share/xml +CLEANFILES+= ${DEV-AUTODIR}/dev-auto.ent + +MAN2HWNOTES_CMD=${RELN_ROOT}/share/misc/man2hwnotes.pl +.if defined(HWNOTES_MI) +MAN2HWNOTES_FLAGS= +.else +MAN2HWNOTES_FLAGS= -c +.endif + +# Dependency that the article makefiles can use to pull in +# dev-auto.ent. +${DEV-AUTODIR}/catalog-auto ${DEV-AUTODIR}/dev-auto.ent: ${MAN4PAGES} \ + ${ARCHLIST} ${MAN2HWNOTES_CMD} + cd ${RELN_ROOT}/share/xml && make MAN2HWNOTES_FLAGS=${MAN2HWNOTES_FLAGS} dev-auto.ent diff --git a/release/doc/share/xml/Makefile b/release/doc/share/xml/Makefile new file mode 100644 index 0000000..b2c1b6d --- /dev/null +++ b/release/doc/share/xml/Makefile @@ -0,0 +1,11 @@ +# $FreeBSD$ + +RELN_ROOT?= ${.CURDIR}/../.. + +.include "${RELN_ROOT}/share/mk/doc.relnotes.mk" +.include "${DOC_PREFIX}/share/mk/doc.project.mk" + +dev-auto.ent: ${MAN4PAGES} ${ARCHLIST} ${MAN2HWNOTES_CMD} + ${PERL} ${MAN2HWNOTES_CMD} ${MAN2HWNOTES_FLAGS} -a ${ARCHLIST} -o ${.TARGET} ${MAN4PAGES} + +all: dev-auto.ent diff --git a/release/doc/share/xml/catalog.xml b/release/doc/share/xml/catalog.xml new file mode 100644 index 0000000..74f8ccd --- /dev/null +++ b/release/doc/share/xml/catalog.xml @@ -0,0 +1,13 @@ +<?xml version="1.0"?> +<!-- $FreeBSD$ --> +<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog"> + <rewriteSystem systemIdStartString="http://www.FreeBSD.org/release/XML/" + rewritePrefix="../../"/> + <rewriteURI uriStartString="http://www.FreeBSD.org/release/XML/" + rewritePrefix="../../"/> + + <public publicId="-//FreeBSD//ENTITIES Release Specification//EN" uri="release.ent"/> + <public publicId="-//FreeBSD//ENTITIES Sponsor Specification//EN" uri="sponsor.ent"/> + <public publicId="-//FreeBSD//ENTITIES Vendor Specification//EN" uri="vendor.ent"/> + <public publicId="-//FreeBSD//ENTITIES Auto Generated Device Lists//EN" uri="dev-auto.ent"/> +</catalog> diff --git a/release/doc/share/xml/errata.xml b/release/doc/share/xml/errata.xml new file mode 100644 index 0000000..efc21a1 --- /dev/null +++ b/release/doc/share/xml/errata.xml @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- + The FreeBSD Documentation Project + + $FreeBSD$ +--> +<informaltable frame="none" pgwide="1"> + <tgroup cols="3"> + <colspec colwidth="40%"/> + <colspec colwidth="30%"/> + <colspec colwidth="30%"/> + <thead> + <row> + <entry>Errata</entry> + <entry>Date</entry> + <entry>Topic</entry> + </row> + </thead> + + <tbody> + <row> + <entry><para>No errata notices.</para></entry> + <entry><para> </para></entry> + <entry><para> </para></entry> + </row> + </tbody> + </tgroup> +</informaltable> diff --git a/release/doc/share/xml/release.ent b/release/doc/share/xml/release.ent new file mode 100644 index 0000000..f72b4d0 --- /dev/null +++ b/release/doc/share/xml/release.ent @@ -0,0 +1,82 @@ +<!-- -*- sgml -*- + + $FreeBSD$ + + OS Release Information --> + +<!-- Version of the OS we're describing. This needs to be updated + with each new release. --> +<!ENTITY release.current "11.0-CURRENT"> + +<!-- The previous version used for comparison in the "What's New" + section. For -CURRENT, we might point back to the last + branchpoint. --> +<!ENTITY release.prev "10.0-RELEASE"> + +<!-- The previous stable release, useful for pointing user's at the + release they SHOULD be running if they don't want the bleeding + edge. --> +<!ENTITY release.prev.stable "9.3-RELEASE"> + +<!-- The next version to be released, usually used for snapshots. --> +<!ENTITY release.next "11.0-RELEASE"> + +<!-- The name of this branch. --> +<!ENTITY release.branch "11-CURRENT"> + +<!-- The URL for obtaining this version of FreeBSD. --> +<!ENTITY release.url "https://www.FreeBSD.org/snapshots/"> + +<!-- The URL for Security Advisories and Errata Notices. --> +<!ENTITY security.url "https://www.FreeBSD.org/security/advisories"> + +<!-- The recommended mailing list to track. --> +<!ENTITY release.maillist "current"> + +<!-- The type of release (usually this will be either "snapshot" + or "release" --> +<!-- WARNING: Do not forget to also change the release type in + doc.relnotes.mk when updating this --> +<!ENTITY release.type "snapshot"> +<!ENTITY % release.type.current "INCLUDE"> +<!ENTITY % release.type.snapshot "IGNORE"> +<!ENTITY % release.type.release "IGNORE"> + +<![%release.type.current;[ +<!ENTITY release '&release.current;'> +]]> +<![%release.type.snapshot;[ +<!ENTITY release '&release.prev;'> +]]> +<![%release.type.release;[ +<!ENTITY release '&release.current;'> +]]> +<!ENTITY release ''> + +<!-- The manpaths for man page references --> +<!ENTITY release.man.url "https://www.FreeBSD.org/cgi/man.cgi"> +<!ENTITY release.manpath.xorg "7.5.1"> +<!ENTITY release.manpath.netbsd "5.1"> +<!ENTITY release.manpath.freebsd-ports "Ports"> +<!ENTITY release.manpath.freebsd "10-current"> + +<!-- Text constants which probably don't need to be changed.--> + +<!-- Name of our OS. This is almost certainly going to remain + FreeBSD, but we might want to try to do some other formatting or + other fancy markup on it in the future. --> +<!ENTITY os "FreeBSD"> + +<!-- Architecture names --> +<!ENTITY arch.amd64 "amd64"> +<!ENTITY arch.arm "arm"> +<!ENTITY arch.arm64 "aarch64"> +<!ENTITY arch.i386 "i386"> +<!ENTITY arch.mips "mips"> +<!ENTITY arch.pc98 "pc98"> +<!ENTITY arch.powerpc "powerpc"> +<!ENTITY arch.powerpc64 "powerpc64"> +<!ENTITY arch.sparc64 "sparc64"> + +<!-- The marker for MFCs. --> +<!ENTITY merged "MERGED"> diff --git a/release/doc/share/xml/release.xsl b/release/doc/share/xml/release.xsl new file mode 100644 index 0000000..f76ae68 --- /dev/null +++ b/release/doc/share/xml/release.xsl @@ -0,0 +1,106 @@ +<?xml version="1.0"?> +<!-- $FreeBSD$ --> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + version='1.0' + xmlns="http://www.w3.org/TR/xhtml1/transitional" + xmlns:db="http://docbook.org/ns/docbook" + exclude-result-prefixes="db"> + + <xsl:import href="http://www.FreeBSD.org/XML/share/xml/freebsd-xhtml.xsl"/> + + <xsl:import href="http://www.FreeBSD.org/release/XML/lang/share/xml/release.xsl"/> + + <xsl:param name="release.url"/> + <xsl:param name="release.branch"/> + <xsl:param name="release.maillist"/> + + <xsl:template name="paragraph"> + <xsl:param name="class" select="''"/> + <xsl:param name="content"/> + + <xsl:variable name="p"> + <p> + <xsl:choose> + <xsl:when test="$class != ''"> + <xsl:call-template name="common.html.attributes"> + <xsl:with-param name="class" select="$class"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:call-template name="locale.html.attributes"/> + </xsl:otherwise> + </xsl:choose> + <xsl:if test="@arch"> + <xsl:value-of select="concat('[', @arch, ']')"/> + <xsl:value-of select='" "'/> + </xsl:if> + <xsl:copy-of select="$content"/> + <xsl:value-of select='" "'/> + <xsl:if test="@revision"> + <xsl:element name="a"> + <xsl:attribute name="href"> + <xsl:value-of select="concat('http://svn.freebsd.org/viewvc/base?view=revision&revision=', @revision)"/> + </xsl:attribute> + <xsl:value-of select="concat('[r', @revision, ']')"/> + </xsl:element> + </xsl:if> + <xsl:if test="@contrib"> + <xsl:element name="span"> + <xsl:attribute name="class"> + <xsl:value-of select="'contrib'"/> + </xsl:attribute> + <xsl:choose> + <xsl:when test="@contrib = 'sponsor'"> + <xsl:if test="@sponsor != ''"> + (Sponsored by + <xsl:choose> + <xsl:when test="@sponsorurl != ''"> + <xsl:element name="a"> + <xsl:attribute name="href"> + <xsl:value-of select="@sponsorurl"/> + </xsl:attribute> + <xsl:value-of select="concat(@sponsor, ')')"/> + </xsl:element> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="concat(@sponsor, ')')"/> + </xsl:otherwise> + </xsl:choose> + </xsl:if> + </xsl:when> + <xsl:when test="@contrib = 'vendor'"> + <xsl:if test="@vendor != ''"> + (Contributed / provided by + <xsl:choose> + <xsl:when test="@vendorurl != ''"> + <xsl:element name="a"> + <xsl:attribute name="href"> + <xsl:value-of select="@vendorurl"/> + </xsl:attribute> + <xsl:value-of select="concat(@vendor, ')')"/> + </xsl:element> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="concat(@vendor, ')')"/> + </xsl:otherwise> + </xsl:choose> + </xsl:if> + </xsl:when> + </xsl:choose> + </xsl:element> + </xsl:if> + </p> + </xsl:variable> + + <xsl:choose> + <xsl:when test="$html.cleanup != 0"> + <xsl:call-template name="unwrap.p"> + <xsl:with-param name="p" select="$p"/> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:copy-of select="$p"/> + </xsl:otherwise> + </xsl:choose> + </xsl:template> +</xsl:stylesheet> diff --git a/release/doc/share/xml/security.xml b/release/doc/share/xml/security.xml new file mode 100644 index 0000000..74a8cd7 --- /dev/null +++ b/release/doc/share/xml/security.xml @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- + The FreeBSD Documentation Project + + $FreeBSD$ +--> +<informaltable frame="none" pgwide="1"> + <tgroup cols="3"> + <colspec colwidth="40%"/> + <colspec colwidth="30%"/> + <colspec colwidth="30%"/> + <thead> + <row> + <entry>Advisory</entry> + <entry>Date</entry> + <entry>Topic</entry> + </row> + </thead> + + <tbody> + <row> + <entry><para>No advisories.</para></entry> + <entry><para> </para></entry> + <entry><para> </para></entry> + </row> + </tbody> + </tgroup> +</informaltable> diff --git a/release/doc/share/xml/sponsor.ent b/release/doc/share/xml/sponsor.ent new file mode 100644 index 0000000..a76ef88 --- /dev/null +++ b/release/doc/share/xml/sponsor.ent @@ -0,0 +1,55 @@ +<!-- -*- sgml -*- + + $FreeBSD$ + + Sponsors of various works. + + Please keep the entity list sorted alphabetically. + +--> + +<!ENTITY abt "ABT Systems, Ltd."> +<!ENTITY afrl "AFRL"> + +<!ENTITY chelsio "Chelsio Communications"> + +<!ENTITY citrix "Citrix Systems"> +<!ENTITY citrix.rd "Citrix Systems R&D"> + +<!ENTITY clusterhq "ClusterHQ"> + +<!ENTITY darpa "DARPA"> +<!ENTITY darpa_afrl "DARPA, AFRL"> +<!ENTITY dell "Dell, Inc."> + +<!ENTITY emcisilon "EMC / Isilon Storage Division"> + +<!ENTITY ff "The &os; Foundation"> +<!ENTITY ff.url "https://www.FreeBSDFoundation.org/"> + +<!ENTITY gandi "Gandi.net"> +<!ENTITY google "Google"> + +<!ENTITY juniper "Juniper Networks, Inc."> + +<!ENTITY intelcorp "Intel Corporation"> +<!ENTITY ix "iXsystems"> + +<!ENTITY limelight "Limelight Networks"> +<!ENTITY lsi "LSI"> + +<!ENTITY msostc "Microsoft Open Source Technology Center"> +<!ENTITY mitail "MIT Computer Science & Artificial Intelligence Laboratory"> +<!ENTITY multiplay "Multiplay"> + +<!ENTITY netflix "Netflix"> +<!ENTITY netgate "Netgate"> +<!ENTITY nginx "Nginx, Inc."> +<!ENTITY norse "Norse Corporation"> + +<!ENTITY sandvine "Sandvine, Inc."> +<!ENTITY scaleengine "ScaleEngine, Inc."> +<!ENTITY solarflare "Solarflare Communications, Inc."> +<!ENTITY spectralogic "Spectra Logic"> + +<!ENTITY yandex "Yandex LLC"> diff --git a/release/doc/share/xml/vendor.ent b/release/doc/share/xml/vendor.ent new file mode 100644 index 0000000..75c879b --- /dev/null +++ b/release/doc/share/xml/vendor.ent @@ -0,0 +1,9 @@ +<!-- -*- sgml -*- + + $FreeBSD$ + + Vendors and contributors. + + Please keep the entity list sorted alphabetically. + +--> |
