summaryrefslogtreecommitdiff
path: root/doc/pkgsrc.txt
diff options
context:
space:
mode:
authorreed <reed@pkgsrc.org>2009-05-02 19:00:35 +0000
committerreed <reed@pkgsrc.org>2009-05-02 19:00:35 +0000
commitb3f1d3cfb09c211f82aa371cd39feadb7db7f86f (patch)
tree1fb95c82e973978bbacb7a0484e9d94124cf01e8 /doc/pkgsrc.txt
parentd292cc780633f3106a3088e0e22bbaa82b2eb1a3 (diff)
downloadpkgsrc-b3f1d3cfb09c211f82aa371cd39feadb7db7f86f.tar.gz
Regen.
(Looks like it adds audit changes and new pkg_summary metadata. Also some style/format changes, probably due to different docbook used.)
Diffstat (limited to 'doc/pkgsrc.txt')
-rw-r--r--doc/pkgsrc.txt101
1 files changed, 66 insertions, 35 deletions
diff --git a/doc/pkgsrc.txt b/doc/pkgsrc.txt
index 237159d1e6a..a057af20d80 100644
--- a/doc/pkgsrc.txt
+++ b/doc/pkgsrc.txt
@@ -149,15 +149,16 @@ I. The pkgsrc user's guide
9.7. How to fetch files from behind a firewall
9.8. How do I tell make fetch to do passive FTP?
9.9. How to fetch all distfiles at once
- 9.10. What does Don't know how to make /usr/share/tmac/tmac.andoc mean?
- 9.11. What does Could not find bsd.own.mk mean?
+ 9.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc"
+ mean?
+ 9.11. What does "Could not find bsd.own.mk" mean?
9.12. Using 'sudo' with pkgsrc
9.13. How do I change the location of configuration files?
9.14. Automated security checks
9.15. Why do some packages ignore my CFLAGS?
9.16. A package does not build. What shall I do?
- 9.17. What does Makefile appears to contain unresolved cvs/rcs/???
- merge conflicts mean?
+ 9.17. What does "Makefile appears to contain unresolved cvs/rcs/???
+ merge conflicts" mean?
II. The pkgsrc developer's guide
@@ -304,7 +305,7 @@ II. The pkgsrc developer's guide
19.1. General operation
19.1.1. Portability of packages
- 19.1.2. How to pull in user-settable variables from ???
+ 19.1.2. How to pull in user-settable variables from mk.conf
19.1.3. User interaction
19.1.4. Handling licenses
19.1.5. Restricted packages
@@ -341,7 +342,7 @@ II. The pkgsrc developer's guide
19.5.1. Compiling C and C++ code conditionally
19.5.2. How to handle compiler bugs
- 19.5.3. Undefined reference to ...
+ 19.5.3. Undefined reference to "..."
19.5.4. Running out of memory
19.6. Fixing problems in the install phase
@@ -377,7 +378,8 @@ II. The pkgsrc developer's guide
21.3. General notes when adding, updating, or removing packages
21.4. Committing: Importing a package into CVS
21.5. Updating a package to a newer version
- 21.6. Moving a package in pkgsrc
+ 21.6. Renaming a package in pkgsrc
+ 21.7. Moving a package in pkgsrc
22. Frequently Asked Questions
23. GNOME packaging and porting
@@ -791,15 +793,15 @@ Table of Contents
9.7. How to fetch files from behind a firewall
9.8. How do I tell make fetch to do passive FTP?
9.9. How to fetch all distfiles at once
- 9.10. What does Don't know how to make /usr/share/tmac/tmac.andoc mean?
- 9.11. What does Could not find bsd.own.mk mean?
+ 9.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
+ 9.11. What does "Could not find bsd.own.mk" mean?
9.12. Using 'sudo' with pkgsrc
9.13. How do I change the location of configuration files?
9.14. Automated security checks
9.15. Why do some packages ignore my CFLAGS?
9.16. A package does not build. What shall I do?
- 9.17. What does Makefile appears to contain unresolved cvs/rcs/??? merge
- conflicts mean?
+ 9.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
+ conflicts" mean?
Chapter 2. Where to get pkgsrc and how to keep it up-to-date
@@ -2482,7 +2484,7 @@ src/etc, be sure the following items are present and properly configured:
10. Make /usr/sandbox/usr/pkgsrc/packages and .../distfiles point somewhere
appropriate. NFS- and/or nullfs-mounts may come in handy!
-11. Edit mk.conf, see Section 7.3.1.2, "???".
+11. Edit mk.conf, see Section 7.3.1.2, "mk.conf".
12. Adjust mk/bulk/build.conf to suit your needs.
@@ -2849,15 +2851,15 @@ Table of Contents
9.7. How to fetch files from behind a firewall
9.8. How do I tell make fetch to do passive FTP?
9.9. How to fetch all distfiles at once
-9.10. What does Don't know how to make /usr/share/tmac/tmac.andoc mean?
-9.11. What does Could not find bsd.own.mk mean?
+9.10. What does "Don't know how to make /usr/share/tmac/tmac.andoc" mean?
+9.11. What does "Could not find bsd.own.mk" mean?
9.12. Using 'sudo' with pkgsrc
9.13. How do I change the location of configuration files?
9.14. Automated security checks
9.15. Why do some packages ignore my CFLAGS?
9.16. A package does not build. What shall I do?
-9.17. What does Makefile appears to contain unresolved cvs/rcs/??? merge
- conflicts mean?
+9.17. What does "Makefile appears to contain unresolved cvs/rcs/??? merge
+ conflicts" mean?
This section contains hints, tips & tricks on special things in pkgsrc that we
didn't find a better place for in the previous chapters, and it contains items
@@ -3140,14 +3142,14 @@ The database can be downloaded automatically, and a security audit of all
packages installed on a system can take place. To do this, refer to the
following two tools (installed as part of the pkgtools/pkg_install package):
- 1. download-vulnerability-list, an easy way to download a list of the security
- vulnerabilities information. This list is kept up to date by the NetBSD
- security officer and the NetBSD packages team, and is distributed from the
- NetBSD ftp server:
+ 1. pkg_admin fetch-pkg-vulnerabilities, an easy way to download a list of the
+ security vulnerabilities information. This list is kept up to date by the
+ NetBSD security officer and the NetBSD packages team, and is distributed
+ from the NetBSD ftp server:
ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities
- 2. audit-packages, an easy way to audit the current machine, checking each
+ 2. pkg_admin audit, an easy way to audit the current machine, checking each
vulnerability which is known. If a vulnerable package is installed, it will
be shown by output to stdout, including a description of the type of
vulnerability, and a URL containing more information.
@@ -3354,7 +3356,7 @@ Table of Contents
19.1. General operation
19.1.1. Portability of packages
- 19.1.2. How to pull in user-settable variables from ???
+ 19.1.2. How to pull in user-settable variables from mk.conf
19.1.3. User interaction
19.1.4. Handling licenses
19.1.5. Restricted packages
@@ -3390,7 +3392,7 @@ Table of Contents
19.5.1. Compiling C and C++ code conditionally
19.5.2. How to handle compiler bugs
- 19.5.3. Undefined reference to ...
+ 19.5.3. Undefined reference to "..."
19.5.4. Running out of memory
19.6. Fixing problems in the install phase
@@ -3426,7 +3428,8 @@ Table of Contents
21.3. General notes when adding, updating, or removing packages
21.4. Committing: Importing a package into CVS
21.5. Updating a package to a newer version
- 21.6. Moving a package in pkgsrc
+ 21.6. Renaming a package in pkgsrc
+ 21.7. Moving a package in pkgsrc
22. Frequently Asked Questions
23. GNOME packaging and porting
@@ -6486,7 +6489,7 @@ Table of Contents
19.1. General operation
19.1.1. Portability of packages
- 19.1.2. How to pull in user-settable variables from ???
+ 19.1.2. How to pull in user-settable variables from mk.conf
19.1.3. User interaction
19.1.4. Handling licenses
19.1.5. Restricted packages
@@ -6522,7 +6525,7 @@ Table of Contents
19.5.1. Compiling C and C++ code conditionally
19.5.2. How to handle compiler bugs
- 19.5.3. Undefined reference to ...
+ 19.5.3. Undefined reference to "..."
19.5.4. Running out of memory
19.6. Fixing problems in the install phase
@@ -7931,7 +7934,8 @@ Table of Contents
21.3. General notes when adding, updating, or removing packages
21.4. Committing: Importing a package into CVS
21.5. Updating a package to a newer version
-21.6. Moving a package in pkgsrc
+21.6. Renaming a package in pkgsrc
+21.7. Moving a package in pkgsrc
21.1. Submitting binary packages
@@ -8036,7 +8040,25 @@ which pkgsrc is used. Please use your judgement about what should go into
pkgsrc, and bear in mind that stability is to be preferred above new and
possibly untested features.
-21.6. Moving a package in pkgsrc
+21.6. Renaming a package in pkgsrc
+
+Renaming packages is not recommended.
+
+When renaming packages, be sure to fix any references to old name in other
+Makefiles, options, buildlink files, etc.
+
+Also When renaming a package, please define SUPERSEDES to the package name and
+dewey version pattern(s) of the previous package name. This may be repeated for
+multiple renames. The new package would be an exact replacement.
+
+Note that "successor" in the CHANGES-YYYY file doesn't necessarily mean that it
+supersedes, as that successor may not be an exact replacement but is a
+suggestion for the replaced functionality.
+
+21.7. Moving a package in pkgsrc
+
+It is preferred that packages are not renamed or moved, but if needed please
+follow these steps.
1. Make a copy of the directory somewhere else.
@@ -8051,22 +8073,31 @@ possibly untested features.
3. Fix CATEGORIES and any DEPENDS paths that just did "../package" instead of
"../../category/package".
- 4. cvs import the modified package in the new place.
+ 4. In the modified package's Makefile, consider setting PREV_PKGPATH to the
+ previous category/package pathname. The PREV_PKGPATH can be used by tools
+ for doing an update using pkgsrc building; for example, it can search the
+ pkg_summary(5) database for PREV_PKGPATH (if no SUPERSEDES) and then use
+ the corresponding new PKGPATH for that moved package. Note that it may have
+ multiple matches, so the tool should also check on the PKGBASE too. The
+ PREV_PKGPATH probably has no value unless SUPERSEDES is not set, i.e.
+ PKGBASE stays the same.
+
+ 5. cvs import the modified package in the new place.
- 5. Check if any package depends on it:
+ 6. Check if any package depends on it:
% cd /usr/pkgsrc
% grep /package */*/Makefile* */*/buildlink*
- 6. Fix paths in packages from step 5 to point to new location.
+ 7. Fix paths in packages from step 5 to point to new location.
- 7. cvs rm (-f) the package at the old location.
+ 8. cvs rm (-f) the package at the old location.
- 8. Remove from oldcategory/Makefile.
+ 9. Remove from oldcategory/Makefile.
- 9. Add to newcategory/Makefile.
+10. Add to newcategory/Makefile.
-10. Commit the changed and removed files:
+11. Commit the changed and removed files:
% cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile