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

Added a link to WWW PR form and to "Writing FreeBSD PRs" with text,

Browse source 
and:
= Changed "-doc" to "<tt>FreeBSD-doc</tt>" twice.
= Added the hypen in "plain-text documents".
= Changed "e-mail" to FDP's "email" thrice.
= Removed useless "r" from: diff -ru foo.sgml.old foo.sgml > foo.diff

Approved by:    keramida (mentor)
This commit is contained in:
Gary W. Swearingen 2005-09-18 14:01:21 +00:00
parent 66229ed32d
commit 102f4cbca2
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/www/; revision=25694
1 changed files with 15 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
en/docproj/submitting.sgml
View file

@ -1,6 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" [
<!ENTITY base CDATA "..">
<!ENTITY date "$FreeBSD: www/en/docproj/submitting.sgml,v 1.14 2004/01/19 19:08:36 ceri Exp $">
<!ENTITY url.articles "../doc/en_US.ISO8859-1/articles">
<!ENTITY date "$FreeBSD: www/en/docproj/submitting.sgml,v 1.15 2004/07/22 23:11:15 ceri Exp $">
<!ENTITY title "FreeBSD Documentation Project: Submitting documentation">
<!ENTITY % includes SYSTEM "../includes.sgml"> %includes;
]>
@ -15,13 +16,13 @@
<p>You should make your documentation available for review. If you can,
put it on an FTP site or a website.</p>
<p>Then post a message to the -doc mailing list, with a brief outline of
<p>Then post a message to the <tt>FreeBSD-doc</tt> mailing list, with a brief outline of
the documentation and the pointer to its location, and solicit
feedback.</p>
<p>If, for some reason, you can not put the documentation up for FTP or on
a web site somewhere you can send it directly to the -doc mailing list.
If you do this, please only send plain text documents.</p>
<p>If, for some reason, you cannot put the documentation up for FTP or on
a web site somewhere you can send it directly to the <tt>FreeBSD-doc</tt> mailing list.
If you do this, please only send plain-text documents.</p>
<p>You should probably cc: this request for comments to other appropriate
mailing lists. For example, something that relates to how to use CVSup to
@ -49,7 +50,7 @@
<p>which will produce <tt>doc.tar.gz</tt>.</p>
<p>Finally, encode the file so that it will not be mangled by any e-mail
<p>Finally, encode the file so that it will not be mangled by any email
programs.</p>
<pre>
@ -58,14 +59,17 @@
<p>You should then let the Documentation Project know about it. The
correct way to do this is to use a command called <b>send-pr</b>, which
should be installed on your machine.</p>
should be installed on your machine.
The <a href="&base;/send-pr.html">WWW problem report form</a> may also be used.</p>
<p>You do this so that your submission can be tracked. When you submit a PR
(Problem Report) it is assigned a unique number. One of the committers
can then assign the PR to themselves, and liaise with you on committing
the new documentation.</p>
the new documentation.
For more information, see
<a href="&url.articles;/problem-reports/">Writing FreeBSD Problem Reports</a>.</p>
<p><b>send-pr</b> itself is pretty simple. All it does is send an e-mail
<p><b>send-pr</b> itself is pretty simple. All it does is send an email
with some special formatting to a particular address. When you run
<b>send-pr</b> you will be put into your editor (probably <b>vi</b> or
<b>emacs</b>) with a template to fill out, and some instructions on how
@ -75,7 +79,7 @@
to one of "change-request". You should include the <tt>.uue</tt> file
you created earlier in the body of the PR.</p>
<p>When you come out of the editor the PR will be sent as an e-mail to the
<p>When you come out of the editor the PR will be sent as an email to the
right place. You will get a notification message shortly afterwards
telling you what number your PR has been given, and this number can
be used to track its progress.</p>
@ -114,7 +118,7 @@
<li><p>Make the diff. The command to do this is</p>
<pre>
% <b>diff -ru foo.sgml.old foo.sgml > foo.diff</b>
% <b>diff -u foo.sgml.old foo.sgml > foo.diff</b>
</pre>
<p>This looks at the difference between the two files, and writes them