- Update the Conventions and Traditions to reflect the doc CVS->SVN

conversion.
- Add a note that the .ent, .sgml, and .xml files are in the doc
  repository.
This commit is contained in:
Glen Barber 2012-05-20 20:55:21 +00:00
parent 669674039b
commit 84c284fbef
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=38858

View file

@ -2696,18 +2696,25 @@ $target - head/$source:$P,$Q,$R</screen>
<sect2 id="conventions-committers"> <sect2 id="conventions-committers">
<title>Guidelines For Committers</title> <title>Guidelines For Committers</title>
<note>
<para>The <literal>.ent</literal>, <literal>.sgml</literal>,
and <literal>.xml</literal> files listed below exist in the
&os; Documentation Project SVN repository at
<hostid role="fqdn">svn.FreeBSD.org/doc/</hostid>.</para>
</note>
<para>If you have been given commit rights to one or more of the <para>If you have been given commit rights to one or more of the
repositories:</para> repositories:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>Add your author entity to <para>Add your author entity to
<filename>doc/en_US.ISO8859-1/share/sgml/authors.ent</filename>; <filename>head/en_US.ISO8859-1/share/sgml/authors.ent</filename>;
this should be done first since an omission of this commit will this should be done first since an omission of this commit will
cause the next commits to break the doc/ build.</para> cause the next commits to break the doc/ build.</para>
<para>This is a relatively easy task, but remains a good first test of <para>This is a relatively easy task, but remains a good first test of
your CVS skills.</para> your version control skills.</para>
<note> <note>
<para>Don't forget to get mentor approval for these patches!</para> <para>Don't forget to get mentor approval for these patches!</para>
@ -2717,36 +2724,36 @@ $target - head/$source:$P,$Q,$R</screen>
<listitem> <listitem>
<para>Also add your author entity to <para>Also add your author entity to
<filename>www/en/developers.sgml</filename>.</para> <filename>head/share/sgml/developers.ent</filename>.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Add yourself to the <quote>Developers</quote> section of <para>Add yourself to the <quote>Developers</quote> section of
the <ulink url="&url.articles.contributors;/index.html">Contributors List</ulink> the <ulink url="&url.articles.contributors;/index.html">Contributors List</ulink>
(<filename>doc/en_US.ISO8859-1/articles/contributors/contrib.committers.sgml</filename>) and remove yourself from the <quote>Additional (<filename>head/en_US.ISO8859-1/articles/contributors/contrib.committers.sgml</filename>) and remove yourself from the <quote>Additional
Contributors</quote> section (<filename>doc/en_US.ISO8859-1/articles/contributors/contrib.additional.sgml</filename>). Contributors</quote> section (<filename>head/en_US.ISO8859-1/articles/contributors/contrib.additional.sgml</filename>).
Please note that entries are sorted by last name.</para> Please note that entries are sorted by last name.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Add an entry for yourself to <para>Add an entry for yourself to
<filename>www/share/sgml/news.xml</filename>. Look for the other <filename>head/share/sgml/news.xml</filename>. Look for the other
entries that look like <quote>A new committer</quote> and follow the entries that look like <quote>A new committer</quote> and follow the
format.</para> format.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>You should add your PGP or GnuPG key to <para>You should add your PGP or GnuPG key to
<filename>doc/share/pgpkeys</filename> (and if you do not <filename>head/share/pgpkeys</filename> (and if you do not
have a key, you should create one). Do not forget to commit have a key, you should create one). Do not forget to commit
the updated <filename>doc/share/pgpkeys/pgpkeys.ent</filename> the updated <filename>head/share/pgpkeys/pgpkeys.ent</filename>
and <filename>doc/share/pgpkeys/pgpkeys-developers.sgml</filename>. and <filename>head/share/pgpkeys/pgpkeys-developers.sgml</filename>.
Please note that entries are sorted by last name.</para> Please note that entries are sorted by last name.</para>
<para>&a.des; has <para>&a.des; has
written a shell script (<filename>doc/share/pgpkeys/addkey.sh</filename>) to make this extremely simple. See the written a shell script (<filename>head/share/pgpkeys/addkey.sh</filename>) to make this extremely simple. See the
<ulink <ulink
url="http://cvsweb.FreeBSD.org/doc/share/pgpkeys/README">README</ulink> url="http://svnweb.FreeBSD.org/doc/head/share/pgpkeys/README">README</ulink>
file for more information.</para> file for more information.</para>
<note> <note>