FS#8883 - a little error on PKGBUILD's man page

Attached to Project: Pacman
Opened by bughunter2 (bughunter2) - Sunday, 09 December 2007, 21:11 GMT
Last edited by Dan McGee (toofishes) - Thursday, 03 January 2008, 06:28 GMT
Task Type Bug Report
Category Documentation
Status Closed
Assigned To Dan McGee (toofishes)
Architecture All
Severity Very Low
Priority Normal
Reported Version git
Due in Version 3.1.0
Due Date Undecided
Percent Complete 100%
Votes 0
Private No

Details

Description:
A file path in the man page is incorrect.
Line 243, with '(/var/abs/install.proto)' should read '(/var/abs/core/install.proto)'.


Additional info:
* package version(s)
I don't know to what package PKGBUILD's man page belongs to.


Steps to reproduce:
man PKGBUILD | grep -n install.proto
This task depends upon

This task blocks these from closing
 FS#8109 - Pacman 3.1 Release Roadmap 
Closed by  Dan McGee (toofishes)
Thursday, 03 January 2008, 06:28 GMT
Reason for closing:  Fixed
Additional comments about closing:  Fixed in current manpages
Comment by Jens Adam (byte) - Monday, 10 December 2007, 04:39 GMT
The part about PKGBUILD.proto right at the top is also a bit unclear, it doesn't mention any paths.

bughunter2:
> I don't know to what package PKGBUILD's man page belongs to.

1) man PKGBUILD -> notice the "PKGBUILD(5)" on the top left
2) pacman -Qo /usr/man/man5/PKGBUILD.5.gz
3) /usr/man/man5/PKGBUILD.5.gz is owned by pacman 3.0.6-2

;)
Comment by bughunter2 (bughunter2) - Monday, 10 December 2007, 13:36 GMT
Thank you.
Can this information be found on the Wiki somewhere? It would be handy for the relatively new Arch users.
Comment by Dan McGee (toofishes) - Monday, 10 December 2007, 15:45 GMT
diff --git a/doc/PKGBUILD.5.txt b/doc/PKGBUILD.5.txt
index d022c9a..b3ea4c9 100644
--- a/doc/PKGBUILD.5.txt
+++ b/doc/PKGBUILD.5.txt
@@ -20,10 +20,12 @@ This manual page is meant to describe general rules about PKGBUILDs. Once a
PKGBUILD is written, the actual package is built using makepkg and installed
with pacman.

-NOTE: If you have a local copy of the Arch Build System (ABS) tree on your
-computer, you can copy the PKGBUILD.proto file to your new package build
-directory and edit it from there. To acquire/sync the ABS tree, use the abs
-script included with pacman.
+NOTE: If you are using Arch Linux and have a local copy of the Arch Build
+System (ABS) tree on your computer, or are using another distribution that
+provides a similar tree of build files, you can copy the provided
+PKGBUILD.proto file to a new package build directory and make customizations to
+suit your needs. An up to date prototype file can also be found in the source
+distribution of this package.


Options and Directives
@@ -224,7 +226,9 @@ same directory as the PKGBUILD script. Then use the install directive:
install=pkgname.install

The install script does not need to be specified in the source array. A
-template install file is available in the ABS tree (/var/abs/install.proto).
+template install file is available with the source distribution of this
+program, or one may be provided by your distribution. For example, Arch Linux
+provides prototype install files in the ABS tree.


Development Directives
@@ -294,7 +298,8 @@ from.
Example
-------
The following is an example PKGBUILD for the 'patch' package. For more
-examples, look through the ABS tree.
+examples, look through the build files of your distribution's packages. For
+those using Arch Linux, consult the ABS tree.

[sh]
source~~~~~

Loading...