On Sun, Apr 19, 2009 at 1:13 AM, Abhishek Dasgupta <[email protected]> wrote: > namcap.1: > changed capitalisation of archlinux to Arch Linux > updated namcap version, date and copyright year > fixed some spelling mistakes > added machine-readable flag to the man page. > tags: > fixed description of file-world-writable > fixed description of directory-not-world-executable > fixed spelling mistake (dependences) > > Signed-off-by: Abhishek Dasgupta <[email protected]> > --- > namcap.1 | 19 +++++++++++-------- > tags | 6 +++--- > 2 files changed, 14 insertions(+), 11 deletions(-) > > diff --git a/namcap.1 b/namcap.1 > index af0ccf4..d5b3554 100644 > --- a/namcap.1 > +++ b/namcap.1 > @@ -1,22 +1,25 @@ > -.TH namcap 1 "July 24, 2007" "namcap 2.0" "User Commands" > +.TH namcap 1 "April 19, 2009" "namcap 2.2" "User Commands" > .SH NAME > namcap \- package analysis utility > .SH SYNOPSIS > \fBnamcap [options] <package|PKGBUILD> [package|PKGBUILD] ... > .SH DESCRIPTION > .PP > -\fBnamcap\fP is a \fIpackage analysis\fP utility that looks for problems > with archlinux packages or their PKGBUILD files. It can apply rules to the > file list, the files themselves, or individual PKGBUILD files. > +\fBnamcap\fP is a \fIpackage analysis\fP utility that looks for problems > with Arch Linux packages or their PKGBUILD files. It can apply rules to the > file list, the files themselves, or individual PKGBUILD files. > .PP > -Rules return lists of messages. Each message can be one of three types: > error, warning, or information (think of them as notes or comments). Errors > (designated by 'E:') are things that namcap is very sure are wrong and need > to be fixed. Warnings (designated by 'W:') are things that namcap thinks > should be changed but if you know what you're doing then you can leave them. > Information (designated 'I:') are only shown when you use the info arguement. > Information messages give information that might be helpful but isn't > anything that needs changing. > +Rules return lists of messages. Each message can be one of three types: > error, warning, or information (think of them as notes or comments). Errors > (designated by 'E:') are things that namcap is very sure are wrong and need > to be fixed. Warnings (designated by 'W:') are things that namcap thinks > should be changed but if you know what you're doing then you can leave them. > Information (designated 'I:') are only shown when you use the info argument. > Information messages give information that might be helpful but isn't > anything that needs changing. > .SH OPTIONS > .TP > .B "\-i, \-\-info" > display information messages > .TP > +.B "\-m, \-\-machine\-readable" > +displays easily parseable namcap tags instead of the normal human readable > description; for example using non-fhs-man-page instead of "Non-FHS man page > (%s) found. Use /usr/share/man instead". A full list of namcap tags along > with their human readable descriptions can be found at /usr/share/namcap/tags. > +.TP > \fB\-r\fR RULELIST, \fB\-\-rules=\fRRULELIST > only apply RULELIST rules to the package > .IP > -RULELIST is a comma-seperated list of rule names; if RULELIST=list then > namcap returns a list of valid rules and their descriptions > +RULELIST is a comma-separated list of rule names; if RULELIST=list then > namcap returns a list of valid rules and their descriptions > .SH RULES > .TP > .B arrays > @@ -35,12 +38,12 @@ capsnames checks a PKGBUILD to verify the package name > does not include upper ca > capsnamespkg checks a package to verify the package name does not include > upper case characters > .TP > .B depends > -depends 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 > (ie. you're smarter than namcap is) > +depends 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 > prgram 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 accesed unless that thing is installed (i.e. a java plugin for > mozilla included in the java package). > +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 > -directoryname checks all of the directory names for standard directories > (ie. /etc, /usr/bin, /usr/lib). All files in directories that are > non-standard are returned > +directoryname checks all of the directory names for standard directories > (i.e. /etc, /usr/bin, /usr/lib). All files in directories that are > non-standard are returned > .TP > .B emptydir > emptydir looks for directories in a package that don't contain any files > @@ -115,7 +118,7 @@ apply all PKGBUILD based rules to the file PKGBUILD > .B namcap -r list > list all of the available rules > .SH COPYRIGHT > -Copyright \(co 2003-2007 Jason Chu > +Copyright \(co 2003-2009 Jason Chu > .br > This is free software; see the source for copying conditions. There is NO > warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. > diff --git a/tags b/tags > index ca3e50e..136666a 100644 > --- a/tags > +++ b/tags > @@ -12,7 +12,7 @@ specific-host-type-used %s :: Reference to one of %s should > be changed to $CARCH > script-link-detected %s in %s :: Script link detected (%s) in file %s > link-level-dependence %s on %s :: File '%s' link-level dependence on %s > dependency-is-testing-release %s :: Dependency '%s' on your system is a > testing release > -dependency-covered-by-link-dependence %s :: Dependency covered by > dependences from link dependence (%s) > +dependency-covered-by-link-dependence %s :: Dependency covered by > dependencies from link dependence (%s) > dependency-detected-not-included %s from files %s :: Dependency detected and > not included (%s) from files %s > dependency-detected-not-included %s :: Dependency detected and not included > ('%s') > dependency-already-satisfied %s :: Dependency included but already satisfied > ('%s') > @@ -41,8 +41,8 @@ too-many-md5sums %i needed :: Too Many md5sums: %i needed > improper-md5sum %s :: Improper md5sum: '%s' > perllocal-pod-present %s :: perllocal.pod found in %s. > file-not-world-readable %s :: File (%s) does not have the world readable bit > set. > -file-world-writable %s :: File (%s) does not have the world readable bit set. > -directory-not-world-executable %s :: File (%s) does not have the world > readable bit set. > +file-world-writable %s :: File (%s) has the world writable bit set. > +directory-not-world-executable %s :: Directory (%s) does not have the world > executable bit set. > incorrect-library-permissions %s :: Library (%s) does not have permission > set to 644. > scrollkeeper-dir-exists %s :: Scrollkeeper directory exists (%s). Remember > to not run scrollkeeper till post_{install,upgrade,remove}. > specific-sourceforge-mirror :: Attempting to use specific sourceforge > mirror, use downloads.sourceforge.net instead
Hugo, In the future, when you import patches like this, please do the following: Save the email as a text file and run 'git am -s saved-email'. This will ensure the original authorship is maintained (give credit where credit is due). I just noticed it was imported with you listed as the author. It's fine and all, but Abhishek does some good work, so it's nice to keep his name on things :)
