On 10/18, Stuart Henderson wrote:
> On 2013-10-18, Gabriel Guzman <g...@guzman-nunez.com> wrote:
> > +<h3>Does my package need a readme?</h3>
> > +A package may require special instructions to run on OpenBSD, or
> > +additional files may need to be downloaded before the port will work
> > +properly, or your port may rely on additional packages to support
> > +additional functionality. If this is the case, and you are unable to
>
> new sentence, new line
>
> > +provide those features via flavors, a readme may be warranted.
>
> I wouldn't talk about flavours here, this encourages people to add
> flavours just for optional deps
>
> > +
> > +<h3>Creating and installing a readme</h3>
> > +You can create a README file in the pkg directory of your port with
> > +the relevant information. Once your file is complete, add
>
> should tell people to base it on infrastructure/README.template
>
> > +<blockquote><pre>
> > +@cwd ${LOCALBASE}/share/doc/pkg-readmes
> > +${FULLPKGNAME}
> > +</pre></blockquote>
> > +to your generated PLIST file. This will allow the pkg tools to copy
> > +your README to /usr/local/share/doc/pkg-readmes/ when your port is
> > +installed, and notify the user to check there for additional
> > +information.
>
> Adding this manually with @cwd is only for things where PREFIX has
> been changed, normally "make plist" picks this up by itself..
>
Thanks for the feedback, here's a diff w/the requested changes.
gabe.
Index: specialtopics.html
===================================================================
RCS file: /var/cvs/www/faq/ports/specialtopics.html,v
retrieving revision 1.29
diff -u -p -u -r1.29 specialtopics.html
--- specialtopics.html 10 Oct 2012 08:50:07 -0000 1.29
+++ specialtopics.html 18 Oct 2013 23:29:00 -0000
@@ -51,6 +51,7 @@ PERFORMANCE OF THIS DOCUMENTATION
<li><a href="#Audio" >3.4 - Audio Applications</a>
<li><a href="#Mandoc" >3.5 - Manual pages</a>
<li><a href="#RcScripts" >3.6 - rc.d(8) scripts</a>
+ <li><a href="#PkgReadmes" >3.7 - Package Readmes</a>
</ul>
<hr>
@@ -1217,6 +1218,39 @@ A
script</a> can also be found in the templates directory of your ports tree.
+<p>
+
+<a name="PkgReadmes"></a>
+<h2>3.7 - Package Readmes</h2>
+This section provides details on installing a package readme.
+
+<h3>Does my package need a readme?</h3>
+A package may require special instructions to run on OpenBSD, or
+additional files may need to be downloaded before the port will work
+properly, or your port may rely on additional packages to support
+additional functionality.
+If this is the case, a readme may be warranted.
+
+<h3>Creating and installing a readme</h3>
+You can create a README file in the pkg directory of your port with
+the relevant information.
+You should base your readme on the template proivded in
+ports/infrastructure/README.template
+Once your file is complete, the pkg tools will automatically copy it
+to /usr/local/share/doc/pkg-readmes/ and notify the user to check there
+for additional information.
+
+use <tt><b>make lib-depends-check</b></tt> or
+<h3>Alternate PREFIX</h3>
+If you need to modify <tt>${PREFIX}</tt> for your port, and
+<tt><b>make plist</b></tt> is unable to automatically pick up your
+README file, you may need to add
+
+<blockquote><pre>
+@cwd ${LOCALBASE}/share/doc/pkg-readmes
+${FULLPKGNAME}
+</pre></blockquote>
+to your generated PLIST file.
<p>
<font color= "#0000e0">
