The translation is temporarily closed for contributions due to maintenance, please come back later.

Source string Read only

(itstool) path: note/para
Context English State
<prompt>#</prompt> <userinput>echo DEVELOPER=yes &gt;&gt; /etc/make.conf</userinput>
This setting enables the <quote>developer mode</quote> that displays deprecation warnings and activates some further quality checks on calling <command>make</command>.
Writing the <filename>Makefile</filename>
The minimal <filename>Makefile</filename> would look something like this:
# $FreeBSD$

PORTNAME= oneko
DISTVERSION= 1.1b
CATEGORIES= games
MASTER_SITES= ftp://ftp.cs.columbia.edu/archives/X11R5/contrib/

MAINTAINER= youremail@example.com
COMMENT= Cat chasing a mouse all over the screen

.include &lt;bsd.port.mk&gt;
In some cases, the <filename>Makefile</filename> of an existing port may contain additional lines in the header, such as the name of the port and the date it was created. This additional information has been declared obsolete, and is being phased out.
Try to figure it out. Do not worry about the contents of the <literal>$FreeBSD$</literal> line, it will be filled in automatically by <application>Subversion</application> when the port is imported to our main ports tree. A more detailed example is shown in the <link linkend="porting-samplem">sample Makefile</link> section.
Writing the Description Files
There are two description files that are required for any port, whether they actually package or not. They are <filename>pkg-descr</filename> and <filename>pkg-plist</filename>. Their <filename>pkg-</filename> prefix distinguishes them from other files.
<filename>pkg-descr</filename>
This is a longer description of the port. One to a few paragraphs concisely explaining what the port does is sufficient.
This is <emphasis>not</emphasis> a manual or an in-depth description on how to use or compile the port! <emphasis>Please be careful when copying from the <filename>README</filename> or manpage</emphasis>. Too often they are not a concise description of the port or are in an awkward format. For example, manpages have justified spacing, which looks particularly bad with monospaced fonts.
On the other hand, the content of <filename>pkg-descr</filename> must be longer than the <link linkend="makefile-comment"><varname>COMMENT</varname></link> line from the Makefile. It must explain in more depth what the port is all about.
A well-written <filename>pkg-descr</filename> describes the port completely enough that users would not have to consult the documentation or visit the website to understand what the software does, how it can be useful, or what particularly nice features it has. Mentioning certain requirements like a graphical toolkit, heavy dependencies, runtime environment, or implementation languages help users decide whether this port will work for them.
Include a URL to the official WWW homepage. Prepend <emphasis>one</emphasis> of the websites (pick the most common one) with <literal>WWW:</literal> (followed by single space) so that automated tools will work correctly. If the URI is the root of the website or directory, it must be terminated with a slash.
If the listed webpage for a port is not available, try to search the Internet first to see if the official site moved, was renamed, or is hosted elsewhere.
This example shows how <filename>pkg-descr</filename> looks:
This is a port of oneko, in which a cat chases a poor mouse all over
the screen.
:
(etc.)

WWW: http://www.oneko.org/
<filename>pkg-plist</filename>
This file lists all the files installed by the port. It is also called the <quote>packing list</quote> because the package is generated by packing the files listed here. The pathnames are relative to the installation prefix (usually <filename>/usr/local</filename>).
Here is a small example:
bin/oneko
man/man1/oneko.1.gz
lib/X11/app-defaults/Oneko
lib/X11/oneko/cat1.xpm
lib/X11/oneko/cat2.xpm
lib/X11/oneko/mouse.xpm
Refer to the <citerefentry><refentrytitle>pkg-create</refentrytitle><manvolnum>8</manvolnum></citerefentry> manual page for details on the packing list.
It is recommended to keep all the filenames in this file sorted alphabetically. It will make verifying changes when upgrading the port much easier.
Creating a packing list manually can be a very tedious task. If the port installs a large numbers of files, <link linkend="plist-autoplist">creating the packing list automatically</link> might save time.
There is only one case when <filename>pkg-plist</filename> can be omitted from a port. If the port installs just a handful of files, list them in <varname>PLIST_FILES</varname>, within the port's <filename>Makefile</filename>. For instance, we could get along without <filename>pkg-plist</filename> in the above <filename>oneko</filename> port by adding these lines to the <filename>Makefile</filename>:
PLIST_FILES= bin/oneko \
man/man1/oneko.1.gz \
lib/X11/app-defaults/Oneko \
lib/X11/oneko/cat1.xpm \
lib/X11/oneko/cat2.xpm \
lib/X11/oneko/mouse.xpm
Usage of <varname>PLIST_FILES</varname> should not be abused. When looking for the origin of a file, people usually try to <application>grep</application> through the <filename>pkg-plist</filename> files in the ports tree. Listing files in <varname>PLIST_FILES</varname> in the <filename>Makefile</filename> makes that search more difficult.
If a port needs to create an empty directory, or creates directories outside of <filename>${PREFIX}</filename> during installation, refer to <xref linkend="plist-dir-cleaning"/> for more information.
As <varname>PLIST_FILES</varname> is a <citerefentry><refentrytitle>make</refentrytitle><manvolnum>1</manvolnum></citerefentry> variable, any entry with spaces must be quoted. For example, if using keywords described in <citerefentry><refentrytitle>pkg-create</refentrytitle><manvolnum>8</manvolnum></citerefentry> and <xref linkend="plist-keywords"/>, the entry must be quoted.
PLIST_FILES= "@sample ${ETCDIR}/oneko.conf.sample"

Loading…

No matching activity found.

Browse all component changes

Source information

Source string comment
(itstool) path: note/para
Flags
read-only
Source string location
book.translate.xml:330
String age
a year ago
Source string age
a year ago
Translation file
books/porters-handbook.pot, string 44