os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Rewrapping, putting commas after i.e., minor fixes that textproc/igor was

Browse source 
emitting.
This commit is contained in:
Benedict Reuschling 2018-08-17 12:37:22 +00:00
parent ee654ba09a
commit 4c54795328
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=52145
2 changed files with 524 additions and 647 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

157
en_US.ISO8859-1/books/developers-handbook/policies/chapter.xml
View file

@ -4,16 +4,28 @@
$FreeBSD$
-->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="policies">
<info><title>Source Tree Guidelines and Policies</title>
<authorgroup>
<author><personname><firstname>Poul-Henning</firstname><surname>Kamp</surname></personname><contrib>Contributed by </contrib></author>
<author><personname><firstname>Giorgos</firstname><surname>Keramidas</surname></personname></author>
</authorgroup>
</info>
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="policies">
<info>
<title>Source Tree Guidelines and Policies</title>
<authorgroup>
<author>
<personname>
<firstname>Poul-Henning</firstname>
<surname>Kamp</surname>
</personname>
<contrib>Contributed by </contrib>
</author>
<author>
<personname>
<firstname>Giorgos</firstname>
<surname>Keramidas</surname>
</personname>
</author>
</authorgroup>
</info>
<para>This chapter documents various guidelines and policies in
force for the FreeBSD source tree.</para>
@ -37,11 +49,11 @@
<para>If a particular portion of the &os;
<filename>src/</filename> distribution is being maintained by a
person or group of persons, this is communicated through an
entry in the <filename>src/MAINTAINERS</filename> file.
Maintainers of ports within the Ports Collection express their
maintainership to the world by adding a
<varname>MAINTAINER</varname> line to the
<filename>Makefile</filename> of the port in question:</para>
entry in <filename>src/MAINTAINERS</filename>. Maintainers of
ports within the Ports Collection express their maintainership
to the world by adding a <varname>MAINTAINER</varname> line to
the <filename>Makefile</filename> of the port in
question:</para>
<programlisting><varname>MAINTAINER</varname>= <replaceable>email-addresses</replaceable></programlisting>
@ -90,16 +102,31 @@
</sect1>
<sect1 xml:id="policies-contributed">
<info><title>Contributed Software</title>
<authorgroup>
<author><personname><firstname>Poul-Henning</firstname><surname>Kamp</surname></personname><contrib>Contributed by </contrib></author>
<author><personname><firstname>David</firstname><surname>O'Brien</surname></personname></author>
<author><personname><firstname>Gavin</firstname><surname>Atkinson</surname></personname></author>
</authorgroup>
</info>
<info>
<title>Contributed Software</title>
<authorgroup>
<author>
<personname>
<firstname>Poul-Henning</firstname>
<surname>Kamp</surname>
</personname>
<contrib>Contributed by </contrib>
</author>
<author>
<personname>
<firstname>David</firstname>
<surname>O'Brien</surname>
</personname>
</author>
<author>
<personname>
<firstname>Gavin</firstname>
<surname>Atkinson</surname>
</personname>
</author>
</authorgroup>
</info>
<indexterm><primary>contributed software</primary></indexterm>
@ -144,12 +171,19 @@
</note>
<sect2 xml:id="vendor-import-svn">
<info><title>Vendor Imports with SVN</title>
<info>
<title>Vendor Imports with SVN</title>
<authorgroup>
<author><personname><firstname>Dag-Erling</firstname><surname>Sm&oslash;rgrav</surname></personname><contrib>Contributed by </contrib></author>
<author>
<personname>
<firstname>Dag-Erling</firstname>
<surname>Sm&oslash;rgrav</surname>
</personname>
<contrib>Contributed by </contrib>
</author>
</authorgroup>
</info>
<para>This section describes the vendor import procedure with
<application>Subversion</application> in details.</para>
@ -212,7 +246,7 @@
&prompt.user; <userinput>svn commit</userinput></screen>
<para>where <replaceable>svn_base</replaceable> is the base
directory of your <acronym>SVN</acronym> repository, e.g.
directory of your <acronym>SVN</acronym> repository, e.g.,
<literal>svn+ssh://svn.FreeBSD.org/base</literal>.</para>
</step>
@ -237,7 +271,7 @@
&prompt.user; <userinput>find . -type f | cut -c 3- | sort &gt; ../<replaceable>new</replaceable></userinput></screen>
<para>With these two files, the following command will list
list removed files (files only in
removed files (files only in
<filename><replaceable>old</replaceable></filename>):</para>
<screen>&prompt.user; <userinput>comm -23 ../<replaceable>old</replaceable> ../<replaceable>new</replaceable></userinput></screen>
@ -248,7 +282,7 @@
<screen>&prompt.user; <userinput>comm -13 ../<replaceable>old</replaceable> ../<replaceable>new</replaceable></userinput></screen>
<para>Let's put this together:</para>
<para>Let us put this together:</para>
<screen>&prompt.user; <userinput>cd vendor/<replaceable>foo</replaceable>/<replaceable>foo-9.9</replaceable></userinput>
&prompt.user; <userinput>tar cf - . | tar xf - -C ../dist</userinput>
@ -337,7 +371,7 @@
<screen>&prompt.user; <userinput>svn diff --no-diff-deleted --old=<replaceable>svn_base</replaceable>/vendor/<replaceable>foo</replaceable>/dist --new=.</userinput></screen>
<para>The <option>--no-diff-deleted</option> option tells
<para><option>--no-diff-deleted</option> tells
<acronym>SVN</acronym> not to check files that are in the
vendor tree but not in the main tree.</para>
@ -401,7 +435,8 @@
<listitem>
<para>Any encumbered file requires specific approval from the
<link xlink:href="&url.base;/administration.html#t-core">Core
<link
xlink:href="&url.base;/administration.html#t-core">Core
Team</link> before it is added to the repository.</para>
</listitem>
@ -433,9 +468,11 @@
<listitem>
<para>Should always be in <filename>LINT</filename>, but
the <link xlink:href="&url.base;/administration.html#t-core">Core
Team</link> decides per case if it should be
commented out or not. The <link xlink:href="&url.base;/administration.html#t-core">Core
the <link
xlink:href="&url.base;/administration.html#t-core">Core
Team</link> decides per case if it should be commented
out or not. The <link
xlink:href="&url.base;/administration.html#t-core">Core
Team</link> can, of course, change their minds later
on.</para>
</listitem>
@ -452,18 +489,19 @@
<orderedlist>
<listitem>
<para>The <link xlink:href="&url.base;/administration.html#t-core">Core
<para>The <link
xlink:href="&url.base;/administration.html#t-core">Core
team</link><indexterm><primary>core
team</primary></indexterm> decides if
the code should be part of
<command>make world</command>.</para>
team</primary></indexterm> decides if the code
should be part of <command>make world</command>.</para>
</listitem>
<listitem>
<para>The <link xlink:href="&url.base;/administration.html#t-re">Release
<para>The <link
xlink:href="&url.base;/administration.html#t-re">Release
Engineering</link><indexterm><primary>release
engineering</primary></indexterm>
decides if it goes into the release.</para>
engineering</primary></indexterm> decides if it goes
into the release.</para>
</listitem>
</orderedlist>
</listitem>
@ -471,16 +509,31 @@
</sect1>
<sect1 xml:id="policies-shlib">
<info><title>Shared Libraries</title>
<authorgroup>
<author><personname><firstname>Satoshi</firstname><surname>Asami</surname></personname><contrib>Contributed by </contrib></author>
<author><personname><firstname>Peter</firstname><surname>Wemm</surname></personname></author>
<author><personname><firstname>David</firstname><surname>O'Brien</surname></personname></author>
</authorgroup>
</info>
<info>
<title>Shared Libraries</title>
<authorgroup>
<author>
<personname>
<firstname>Satoshi</firstname>
<surname>Asami</surname>
</personname>
<contrib>Contributed by </contrib>
</author>
<author>
<personname>
<firstname>Peter</firstname>
<surname>Wemm</surname>
</personname>
</author>
<author>
<personname>
<firstname>David</firstname>
<surname>O'Brien</surname>
</personname>
</author>
</authorgroup>
</info>
<para>If you are adding shared library support to a port or other
piece of software that does not have one, the version numbers
@ -518,7 +571,7 @@
form
<replaceable>x</replaceable>.<replaceable>y</replaceable>.<replaceable>z</replaceable>
well. Any version number after the <replaceable>y</replaceable>
(i.e. the third digit) is totally ignored when comparing shared
(i.e., the third digit) is totally ignored when comparing shared
lib version numbers to decide which library to link with. Given
two shared libraries that differ only in the
<quote>micro</quote> revision, <command>ld.so</command> will
@ -547,7 +600,7 @@
<para>For non-port libraries, it is also our policy to change the
shared library version number only once between releases. In
addition, it is our policy to change the major shared library
version number only once between major OS releases (i.e. from
version number only once between major OS releases (i.e., from
6.0 to 7.0). When you make a change to a system library that
requires the version number to be bumped, check the
<filename>Makefile</filename>'s commit logs. It is the

1014
en_US.ISO8859-1/books/developers-handbook/x86/chapter.xml
View file

File diff suppressed because it is too large Load diff