Differential D36369 Diff 110326 documentation/content/en/books/porters-handbook/quick-porting/_index.adoc

Changeset View

Standalone View

documentation/content/en/books/porters-handbook/quick-porting/_index.adoc

	Show First 20 Lines • Show All 79 Lines • ▼ Show 20 Lines
	....			....
	PORTNAME= oneko			PORTNAME= oneko
	DISTVERSION= 1.1b			DISTVERSION= 1.1b
	CATEGORIES= games			CATEGORIES= games
	MASTER_SITES= ftp://ftp.cs.columbia.edu/archives/X11R5/contrib/			MASTER_SITES= ftp://ftp.cs.columbia.edu/archives/X11R5/contrib/

	MAINTAINER= youremail@example.com			MAINTAINER= youremail@example.com
	COMMENT= Cat chasing a mouse all over the screen			COMMENT= Cat chasing a mouse all over the screen
				WWW= http://www.daidouji.com/oneko/

	.include <bsd.port.mk>			.include <bsd.port.mk>
	....			....

	Try to figure it out.			Try to figure it out.
	A more detailed example is shown in the crossref:porting-samplem[porting-samplem,sample Makefile] section.			A more detailed example is shown in the crossref:porting-samplem[porting-samplem,sample Makefile] section.

	[[porting-desc]]			[[porting-desc]]
	Show All 17 Lines
	For example, manpages have justified spacing, which looks particularly bad with monospaced fonts.			For example, manpages have justified spacing, which looks particularly bad with monospaced fonts.

	On the other hand, the content of [.filename]#pkg-descr# must be longer than the crossref:makefiles[makefile-comment,`COMMENT` line from the Makefile]. It must explain in more depth what the port is all about.			On the other hand, the content of [.filename]#pkg-descr# must be longer than the crossref:makefiles[makefile-comment,`COMMENT` line from the Makefile]. It must explain in more depth what the port is all about.
	====			====

	A well-written [.filename]#pkg-descr# 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.			A well-written [.filename]#pkg-descr# 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.			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 _one_ of the websites (pick the most common one) with `WWW:` (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.

	[NOTE]			[NOTE]
	====			====
	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.			The URL that used to be included as the last line of the [.filename]#pkg-descr# file has been moved to the [.filename]#Makefile#.
	====			====

	This example shows how [.filename]#pkg-descr# looks:

	[.programlisting]
	....
	This is a port of oneko, in which a cat chases a poor mouse all over
	the screen.
	:
	(etc.)

	WWW: http://www.oneko.org/
	....

	[[porting-pkg-plist]]			[[porting-pkg-plist]]
	=== [.filename]#pkg-plist#			=== [.filename]#pkg-plist#

	This file lists all the files installed by the port.			This file lists all the files installed by the port.
	It is also called the "packing list" because the package is generated by packing the files listed here.			It is also called the "packing list" because the package is generated by packing the files listed here.
	The pathnames are relative to the installation prefix (usually [.filename]#/usr/local#).			The pathnames are relative to the installation prefix (usually [.filename]#/usr/local#).

	▲ Show 20 Lines • Show All 194 Lines • Show Last 20 Lines