svn commit: r53374 - head/en_US.ISO8859-1/articles/committers-guide
Benedict Reuschling
bcr at FreeBSD.org
Thu Sep 5 18:56:08 UTC 2019
Author: bcr
Date: Thu Sep 5 18:56:07 2019
New Revision: 53374
URL: https://svnweb.freebsd.org/changeset/doc/53374
Log:
Cleanup some textproc/igor warnings.
Event: vBSDcon FreeBSD Hackathon
Modified:
head/en_US.ISO8859-1/articles/committers-guide/article.xml
Modified: head/en_US.ISO8859-1/articles/committers-guide/article.xml
==============================================================================
--- head/en_US.ISO8859-1/articles/committers-guide/article.xml Thu Sep 5 18:42:53 2019 (r53373)
+++ head/en_US.ISO8859-1/articles/committers-guide/article.xml Thu Sep 5 18:56:07 2019 (r53374)
@@ -93,8 +93,9 @@
<row>
<entry><emphasis>SMTP Host</emphasis></entry>
- <entry><literal><systemitem
- class="fqdomainname">smtp.FreeBSD.org</systemitem>:587</literal>
+ <entry>
+ <literal><systemitem
+ class="fqdomainname">smtp.FreeBSD.org</systemitem>:587</literal>
(see also <xref linkend="smtp-setup"/>).</entry>
</row>
@@ -218,7 +219,8 @@
<para>Existing keys can be used, but should be checked with
<filename>doc/head/share/pgpkeys/checkkey.sh</filename>
- first. In this case, make sure the key has a &os; user ID.</para>
+ first. In this case, make sure the key has a &os; user
+ ID.</para>
<para>For those who do not yet have an
Open<acronym>PGP</acronym> key, or need a new key to meet &os;
@@ -2244,9 +2246,9 @@ freebsd-mfc-after = 2 weeks</programlisting>
or save it elsewhere.</para>
<note>
- <para>If your e-mail system uses SPF with strict rules, you
- should whitelist <systemitem
- class="fqdomainname">mx2.FreeBSD.org</systemitem> from
+ <para>If your e-mail system uses SPF with strict rules,
+ you should whitelist <systemitem
+ class="fqdomainname">mx2.FreeBSD.org</systemitem> from
SPF checks.</para>
</note>
@@ -2272,7 +2274,7 @@ freebsd-mfc-after = 2 weeks</programlisting>
</note>
<sect3 xml:id="smtp-setup">
- <title>SMTP Access Setup</title>
+ <title>SMTP Access Setup</title>
<para>For those willing to send e-mail messages through the
FreeBSD.org infrastructure, follow the instructions
@@ -2280,10 +2282,10 @@ freebsd-mfc-after = 2 weeks</programlisting>
<procedure>
<step>
- <para>Point your mail client at <literal><systemitem
- class="fqdomainname">smtp.FreeBSD.org</systemitem>:587</literal>.</para>
- </step>
-
+ <para>Point your mail client at
+ <literal><systemitem
+ class="fqdomainname">smtp.FreeBSD.org</systemitem>:587</literal>.</para></step>
+
<step>
<para>Enable STARTTLS.</para>
</step>
@@ -2297,7 +2299,7 @@ freebsd-mfc-after = 2 weeks</programlisting>
<step>
<para>For authentication, you can use your &os; Kerberos
username and password (see <xref
- linkend="kerberos-ldap"/>). The
+ linkend="kerberos-ldap"/>). The
<literal><replaceable>yourusername</replaceable>/mail</literal>
principal is preferred, as it is only valid for
authenticating to mail resources.</para>
@@ -2310,12 +2312,12 @@ freebsd-mfc-after = 2 weeks</programlisting>
</procedure>
<note>
- <title>Additional notes</title>
+ <title>Additional Notes</title>
<itemizedlist>
<listitem>
<para>Will only accept mail from
- <literal><replaceable>yourusername</replaceable>@FreeBSD.org</literal>.
+ <literal><replaceable>yourusername</replaceable>@FreeBSD.org</literal>.
If you are authenticated as one user, you are not
permitted to send mail from another.</para>
</listitem>
@@ -2323,8 +2325,7 @@ freebsd-mfc-after = 2 weeks</programlisting>
<listitem>
<para>A header will be appended with the SASL username:
(<literal>Authenticated sender:
- <replaceable>username</replaceable></literal>).</para>
- </listitem>
+ <replaceable>username</replaceable></literal>).</para></listitem>
<listitem>
<para>Host has various rate limits in place to cut down
@@ -2669,6 +2670,20 @@ smtpd_sender_restrictions = reject_known_sender_login_
</row>
<row>
+ <entry><literal>Event:</literal></entry>
+ <entry>The description for the event where this commit was
+ made. If this is a recurring event, add the year or
+ even the month to it. For example, this could be
+ <literal>FooBSDcon 2019</literal>. The idea behind this
+ line is to put recognition to conferences, gatherings,
+ and other types of meetups and to show that these are
+ useful to have. Please do not use the
+ <literal>Sponsored by:</literal> line for this as that
+ is meant for organizations sponsoring certain features
+ or developers working on them.</entry>
+ </row>
+
+ <row>
<entry><literal>Differential Revision:</literal></entry>
<entry>The full URL of the Phabricator review. This line
<emphasis>must be the last line</emphasis>. For
@@ -2781,7 +2796,7 @@ Relnotes: yes</programlisting>
<title>Preferred License for New Files</title>
<para>The &os; Project's full license policy can be found at <link
- xlink:href="&url.base;/internal/software-license.html">https://www.FreeBSD.org/internal/software-license.html</link>.
+ xlink:href="&url.base;/internal/software-license.html">https://www.FreeBSD.org/internal/software-license.html</link>.
The rest of this section is intended to help you get started.
As a rule, when in doubt, ask. It is much easier to give advice
than to fix the source tree.</para>
@@ -3704,9 +3719,6 @@ Relnotes: yes</programlisting>
<listitem>
<para>Test your changes before committing them.</para>
- <!-- XXX Needs update re sparc64 + pc98
- Also, needs more details on which machines are available for testing
- -->
<para>This may sound obvious, but if it really were so
obvious then we probably would not see so many cases of
people clearly not doing this. If your changes are to the
@@ -4103,9 +4115,7 @@ Relnotes: yes</programlisting>
integrated into the &os; documentation.</para>
<para>Current Tier 2 platforms are &arch.arm;, &arch.arm64;,
- &arch.ia64; (through &os; 10), &arch.mips;,
- &arch.pc98; (through &os; 11),
- &arch.powerpc;, and &arch.sparc64;.</para>
+ &arch.mips;, &arch.powerpc;, and &arch.sparc64;.</para>
</sect2>
<sect2>
@@ -4146,9 +4156,7 @@ Relnotes: yes</programlisting>
project.</para>
<para>All systems not otherwise classified into a support tier
- are Tier 4 systems. The &arch.ia64; platform is transitioning
- to Tier 4 status in &os; 11. The &arch.pc98; platform is
- transitioning to Tier 4 status in &os; 12.</para>
+ are Tier 4 systems.</para>
</sect2>
<sect2>
More information about the svn-doc-all
mailing list