[namcap] Remove out of date rules section
diff mbox

Message ID 20170404021724.13807-1-justin@jvreeland.com
State New
Headers show

Commit Message

Justin Vreeland April 4, 2017, 2:17 a.m. UTC
The differences between namcap --list and namcap(1) are confusing. Since
FS#38562 already floats the idea of removing it, and --list uses python
docstrings it seems to make sense to remove the RULES section.

Signed-off-by: Justin Vreeland <justin@jvreeland.com>
---
 namcap.1 | 96 ----------------------------------------------------------------
 1 file changed, 96 deletions(-)

Patch
diff mbox

diff --git a/namcap.1 b/namcap.1
index 28b3e6d..ef33860 100644
--- a/namcap.1
+++ b/namcap.1
@@ -29,102 +29,6 @@  RULELIST is a comma-separated list of rule names
 .TP
 .B "\-v, \-\-version"
 print version and exit
-.SH RULES
-.TP
-.B arrays
-Verifies that array variables are actually arrays and not strings
-.TP
-.B badbackups
-Verifies that backup entries don't begin with /
-.TP
-.B carch
-Looks for references to i686 and i586 and tells you to use $CARCH instead
-.TP
-.B capsnames
-Checks a PKGBUILD to verify that the package name has no upper case characters
-.TP
-.B capsnamespkg
-Checks a package to verify that the package name has no upper case characters
-.TP
-.B checksums
-Makes sure that a PKGBUILD includes valid checksums
-.TP
-.B depends
-This module runs ldd on all executables, gets the link-level dependencies, finds the smallest subset of dependencies that cover the link-level dependencies, and compares that list to the depends of the package.  It returns messages in three cases: dependency detected and not included, dependency included but already satisfied, and dependency included and not needed.  These suggestions are just guidelines and all package builders should take this into account (i.e. you're smarter than namcap is)
-
-Some cases where namcap fails are dlopen() and obscure links.  dlopen()'d libraries don't show up because they are loaded at run time: in the case of a program that loads plugins.  Obscure links are the cases where only a small portion of the package needs something to run; usually, the small portion won't be accessed unless that thing is installed (i.e. a java plugin for mozilla included in the java package).
-.TP
-.B directoryname
-Checks the directory names in the package file list for standard directories (i.e. /etc, /usr/bin, /usr/lib).  All files in directories that are non-standard are returned
-.TP
-.B elffiles
-Gives an error if it finds ELF (binary) files outside the standard paths (/bin, /usr/bin, etc.)
-.TP
-.B emptydir
-Looks for directories in a package that don't contain any files
-.TP
-.B extravars
-Verifies that extra variables start with an underscore
-.TP
-.B fhsinfopages
-Verifies correct installation of info pages
-.TP
-.B fhsmanpages
-Verifies correct installation of man pages
-.TP
-.B fileownership
-Verifies that all files are owned by root:root and not some other user or group
-.TP
-.B gnomemime
-Checks for generated GNOME mime files
-.TP
-.B hicoloricons
-Checks whether the hicolor icon cache is updated when a package installs
-files in /usr/share/icons/hicolor
-.TP
-.B infodirectory
-Verifies that a package does not contain the info directory file (/usr/share/info/dir)
-.TP
-.B invalidstartdir
-Any PKGBUILDs that refer to files in $startdir are incorrect
-.TP
-.B libtool
-Warns if libtool (*.la) files are present
-.TP
-.B license
-Verifies that the licenses variable has been filled in in a PKGBUILD.
-.TP
-.B licensepkg
-Verifies that the licenses variable has been filled in in a package. For packages with a custom license it
-checks whether the license file has been installed in
-/usr/share/licenses/$pkgname/
-.TP
-.B perllocal
-Searches for perllocal.pod.  perllocal.pod is a nasty file that's included during most perl module installations
-.TP
-.B permissions
-Checks basic file and and directory permissions.  It returns warnings about world readable bits not being set, world writable bits being set, and world executable bit not being set for directories
-.TP
-.B rpath
-Gives an error if a binary has RPATH set to something other than /usr/lib
-.TP
-.B scrollkeeper
-Verifies that there aren't any scrollkeeper directories
-.TP
-.B sfurl
-Warns if a PKGBUILD is downloading from a specific sourceforge mirror instead of the generic downloads.sourceforge.net
-.TP
-.B symlink
-Finds out symbolic and hard links which do not point to a valid path in the package
-.TP
-.B tags
-For package maintainers, this module verifies that we have remembered to add a Maintainer and Contributor comment.
-.TP
-.B url
-Verifies that we have the url variable set in the PKGBUILD
-.TP
-.B urlpkg
-Verifies that we have the url variable set in the package file
 .SH EXAMPLES
 .TP
 .B namcap foo.pkg.tar.gz