Changes between Version 11 and Version 12 of PortfileRecipes

Timestamp:

Oct 17, 2009, 4:48:20 PM (15 years ago)

Author:

ryandesign (Ryan Carsten Schmidt)

Comment:

add "installing additional documentation files" section

PortfileRecipes

@@ -139 +139 @@
 
 The [browser:trunk/dports/net/squid/Portfile squid Portfile] and [browser:trunk/dports/security/stegdetect/Portfile stegdetect Portfile] are good examples.
+
+== Installing additional documentation files == #doc
+
+Many ports come with documentation files, like "README" and "ChangeLog", which are part of the source but not installed anywhere. If these files are of value to the end user, they should be installed by the port in the post-destroot phase. (Files such as "INSTALL", which contain only installation instructions, are not of value to the end user and should not be installed.) 
+
+{{{
+post-destroot {
+    set docdir ${destroot}${prefix}/share/doc/${name}
+    xinstall -d ${docdir}
+    xinstall -m 644 -W ${worksrcpath} \
+        AUTHORS \
+        COPYING \
+        NEWS \
+        README \
+        ${docdir}
+}
+}}}
+
+This example is taken from [browser:trunk/dports/www/spawn-fcgi/Portfile spawn-fcgi].
+
+Note: Ensure you use the correct capitalization for each filename. For example, many projects typically use all-caps for most of the documentation files, except for ChangeLog, which is often written in camel-case. If you fail to use the correct capitalization, the port may still install on your system, but will fail for users with case-sensitive filesystems.