From 97aaa84e1f5ab5d02179144bae5d67bdc8e7e0c1 Mon Sep 17 00:00:00 2001 From: Matthew Newton Date: Fri, 2 Oct 2015 16:34:12 +0100 Subject: [PATCH] tidy up a load of lintian warnings --- debian/freeradius-common.lintian-overrides | 7 +++++++ debian/freeradius-config.lintian-overrides | 7 +++++++ debian/freeradius-dhcp.lintian-overrides | 4 +++- debian/freeradius-iodbc.lintian-overrides | 4 ++++ debian/freeradius-krb5.lintian-overrides | 4 +++- debian/freeradius-ldap.lintian-overrides | 4 +++- debian/freeradius-memcached.lintian-overrides | 4 +++- debian/freeradius-mysql.lintian-overrides | 3 +++ debian/freeradius-postgresql.lintian-overrides | 4 ++++ debian/freeradius-redis.lintian-overrides | 4 +++- debian/freeradius-rest.lintian-overrides | 3 +++ debian/freeradius-utils.lintian-overrides | 1 - debian/freeradius-yubikey.lintian-overrides | 4 +++- debian/freeradius.lintian-overrides | 6 ++++++ debian/libfreeradius3.lintian-overrides | 4 +++- man/man1/radclient.1 | 4 ++-- man/man1/radwho.1 | 2 +- man/man5/checkrad.5 | 2 +- man/man5/radrelay.conf.5 | 6 +++--- man/man5/rlm_digest.5 | 2 +- man/man5/rlm_passwd.5 | 2 +- man/man5/unlang.5 | 2 +- man/man5/users.5 | 2 +- man/man8/radcrypt.8 | 8 ++++---- man/man8/radiusd.8 | 18 +++++++++--------- man/man8/radmin.8 | 2 +- man/man8/radrelay.8 | 2 +- man/man8/radsqlrelay.8 | 2 +- src/include/build.h | 2 +- src/lib/radius.c | 2 +- src/main/process.c | 2 +- src/main/version.c | 2 +- src/modules/rlm_cache/rlm_cache.c | 2 +- 33 files changed, 87 insertions(+), 40 deletions(-) create mode 100644 debian/freeradius-common.lintian-overrides create mode 100644 debian/freeradius-mysql.lintian-overrides create mode 100644 debian/freeradius-rest.lintian-overrides delete mode 100644 debian/freeradius-utils.lintian-overrides diff --git a/debian/freeradius-common.lintian-overrides b/debian/freeradius-common.lintian-overrides new file mode 100644 index 0000000..7c2fc40 --- /dev/null +++ b/debian/freeradius-common.lintian-overrides @@ -0,0 +1,7 @@ +# There's plenty in the description of this package to identify +# what it does. +freeradius-common: extended-description-is-probably-too-short + +# There are a lot of these that should probably be tidied up, but +# it's not a great priority. +freeradius-common: hyphen-used-as-minus-sign diff --git a/debian/freeradius-config.lintian-overrides b/debian/freeradius-config.lintian-overrides index e37bcbd..4961410 100644 --- a/debian/freeradius-config.lintian-overrides +++ b/debian/freeradius-config.lintian-overrides @@ -1,3 +1,10 @@ freeradius-config: breaks-without-version freeradius-config: package-relation-with-self + +# There are example python scripts in the config, but it's the freeradius +# package that includes dependencies on the python libraries. freeradius-config: python-script-but-no-python-dep etc/freeradius/mods-config/python/*.py + +# There's plenty in the description of this package to identify +# what it does. +freeradius-config: extended-description-is-probably-too-short diff --git a/debian/freeradius-dhcp.lintian-overrides b/debian/freeradius-dhcp.lintian-overrides index 48f82de..dd30c85 100644 --- a/debian/freeradius-dhcp.lintian-overrides +++ b/debian/freeradius-dhcp.lintian-overrides @@ -1 +1,3 @@ -freeradius-dhcp: binary-or-shlib-defines-rpath +# There's plenty in the description of this package to identify +# what it does. +freeradius-dhcp: extended-description-is-probably-too-short diff --git a/debian/freeradius-iodbc.lintian-overrides b/debian/freeradius-iodbc.lintian-overrides index 7e24109..a157baa 100644 --- a/debian/freeradius-iodbc.lintian-overrides +++ b/debian/freeradius-iodbc.lintian-overrides @@ -1 +1,5 @@ freeradius-iodbc: binary-or-shlib-defines-rpath + +# There's plenty in the description of this package to identify +# what it does. +freeradius-iodbc: extended-description-is-probably-too-short diff --git a/debian/freeradius-krb5.lintian-overrides b/debian/freeradius-krb5.lintian-overrides index ae4e075..d3cced5 100644 --- a/debian/freeradius-krb5.lintian-overrides +++ b/debian/freeradius-krb5.lintian-overrides @@ -1 +1,3 @@ -freeradius-krb5: binary-or-shlib-defines-rpath +# There's plenty in the description of this package to identify +# what it does. +freeradius-krb5: extended-description-is-probably-too-short diff --git a/debian/freeradius-ldap.lintian-overrides b/debian/freeradius-ldap.lintian-overrides index a18fc0c..ee27d07 100644 --- a/debian/freeradius-ldap.lintian-overrides +++ b/debian/freeradius-ldap.lintian-overrides @@ -1 +1,3 @@ -freeradius-ldap: binary-or-shlib-defines-rpath +# There's plenty in the description of this package to identify +# what it does. +freeradius-ldap: extended-description-is-probably-too-short diff --git a/debian/freeradius-memcached.lintian-overrides b/debian/freeradius-memcached.lintian-overrides index 836fcfe..15117f9 100644 --- a/debian/freeradius-memcached.lintian-overrides +++ b/debian/freeradius-memcached.lintian-overrides @@ -1 +1,3 @@ -freeradius-memcached: binary-or-shlib-defines-rpath +# There's plenty in the description of this package to identify +# what it does. +freeradius-memcached: extended-description-is-probably-too-short diff --git a/debian/freeradius-mysql.lintian-overrides b/debian/freeradius-mysql.lintian-overrides new file mode 100644 index 0000000..874389c --- /dev/null +++ b/debian/freeradius-mysql.lintian-overrides @@ -0,0 +1,3 @@ +# There's plenty in the description of this package to identify +# what it does. +freeradius-mysql: extended-description-is-probably-too-short diff --git a/debian/freeradius-postgresql.lintian-overrides b/debian/freeradius-postgresql.lintian-overrides index 5f887bc..9aee5e8 100644 --- a/debian/freeradius-postgresql.lintian-overrides +++ b/debian/freeradius-postgresql.lintian-overrides @@ -1 +1,5 @@ freeradius-postgresql: binary-or-shlib-defines-rpath + +# There's plenty in the description of this package to identify +# what it does. +freeradius-postgresql: extended-description-is-probably-too-short diff --git a/debian/freeradius-redis.lintian-overrides b/debian/freeradius-redis.lintian-overrides index dc8a289..c4efd20 100644 --- a/debian/freeradius-redis.lintian-overrides +++ b/debian/freeradius-redis.lintian-overrides @@ -1 +1,3 @@ -freeradius-redis: binary-or-shlib-defines-rpath +# There's plenty in the description of this package to identify +# what it does. +freeradius-redis: extended-description-is-probably-too-short diff --git a/debian/freeradius-rest.lintian-overrides b/debian/freeradius-rest.lintian-overrides new file mode 100644 index 0000000..8e23680 --- /dev/null +++ b/debian/freeradius-rest.lintian-overrides @@ -0,0 +1,3 @@ +# There's plenty in the description of this package to identify +# what it does. +freeradius-rest: extended-description-is-probably-too-short diff --git a/debian/freeradius-utils.lintian-overrides b/debian/freeradius-utils.lintian-overrides deleted file mode 100644 index b9e3b4f..0000000 --- a/debian/freeradius-utils.lintian-overrides +++ /dev/null @@ -1 +0,0 @@ -freeradius-utils: binary-or-shlib-defines-rpath diff --git a/debian/freeradius-yubikey.lintian-overrides b/debian/freeradius-yubikey.lintian-overrides index eba31a0..2977cdc 100644 --- a/debian/freeradius-yubikey.lintian-overrides +++ b/debian/freeradius-yubikey.lintian-overrides @@ -1 +1,3 @@ -freeradius-yubikey: binary-or-shlib-defines-rpath +# There's plenty in the description of this package to identify +# what it does. +freeradius-yubikey: extended-description-is-probably-too-short diff --git a/debian/freeradius.lintian-overrides b/debian/freeradius.lintian-overrides index bd934f6..6d276ab 100644 --- a/debian/freeradius.lintian-overrides +++ b/debian/freeradius.lintian-overrides @@ -1 +1,7 @@ freeradius: binary-or-shlib-defines-rpath + +# There's just too much documentation to register, and most of it isn't a +# "book" or similar that really makes sense anyway. The lintian check is just +# reporting a single file that happens to be .html in a sea of .txt and .rst +# files... +freeradius: possible-documentation-but-no-doc-base-registration diff --git a/debian/libfreeradius3.lintian-overrides b/debian/libfreeradius3.lintian-overrides index 835bea5..9ecb074 100644 --- a/debian/libfreeradius3.lintian-overrides +++ b/debian/libfreeradius3.lintian-overrides @@ -1 +1,3 @@ -libfreeradius3: binary-or-shlib-defines-rpath +# There's plenty in the description of this package to identify +# what it does. +libfreeradius3: extended-description-is-probably-too-short diff --git a/man/man1/radclient.1 b/man/man1/radclient.1 index 5f8e1d1..6305411 100644 --- a/man/man1/radclient.1 +++ b/man/man1/radclient.1 @@ -69,7 +69,7 @@ logical packets within a file. If a pair of files separated by a colon is specified, the second file will be used to filter the responses to requests from the first. The number of requests and filters must be the same. A summary of filter results will be displayed -if -s is passed. +if \-s is passed. .IP \-F Print the file name, packet number and reply code. .IP \-h @@ -79,7 +79,7 @@ Use \fIid\fP as the RADIUS request Id. .IP \-n\ \fInum_requests_per_second\fP Try to send \fInum_requests_per_second\fP, evenly spaced. This option allows you to slow down the rate at which radclient sends requests. -When not using -n, the default is to send packets as quickly as +When not using \-n, the default is to send packets as quickly as possible, with no inter-packet delays. Due to limitations in radclient, this option does not accurately send diff --git a/man/man1/radwho.1 b/man/man1/radwho.1 index 13b3856..c131255 100644 --- a/man/man1/radwho.1 +++ b/man/man1/radwho.1 @@ -35,7 +35,7 @@ Shows caller ID (if available) instead of the full name. The directory that contains the RADIUS configuration files. Defaults to \fI/etc/raddb\fP. .IP \-F\ \fIradutmp_file\fP -The file that contains the radutmp file. If this is specified, -d is +The file that contains the radutmp file. If this is specified, \-d is not necessary. .IP \-i Shows the session ID instead of the full name. diff --git a/man/man5/checkrad.5 b/man/man5/checkrad.5 index a6a5823..68a33f4 100644 --- a/man/man5/checkrad.5 +++ b/man/man5/checkrad.5 @@ -14,7 +14,7 @@ Returns: 0 = no duplicate, 1 = duplicate, >1 = error. .SH OPTIONS .IP -d -Enable printing of debugging informations. +Enable printing of debugging information. .IP nas-type Type of port/NAS. Can be one of: diff --git a/man/man5/radrelay.conf.5 b/man/man5/radrelay.conf.5 index 3b3acaf..5fb38bf 100644 --- a/man/man5/radrelay.conf.5 +++ b/man/man5/radrelay.conf.5 @@ -12,7 +12,7 @@ .. .TH radrelay.conf 5 "27 May 2005" "" "FreeRADIUS configuration file" .SH NAME -radrelay.conf \- configuration file for the FreeRADIUS server "radrelay" personality +radrelay.conf - configuration file for the FreeRADIUS server "radrelay" personality .SH DESCRIPTION The \fBradrelay.conf\fP file resides in the radius database directory, by default \fB/etc/raddb\fP. It defines the global configuration for @@ -41,7 +41,7 @@ another, so they both have the same set of accounting data. .SH "BUFFERING FOR HIGH-LOAD SERVERS" If the RADIUS server suddenly receives a many accounting packets, there may be insufficient CPU power to process them all in a timely -manner. This problem is especially noticable when the accounting +manner. This problem is especially noticeable when the accounting packets are going to a back-end database. Similarly, you may have one database that tracks "live" sessions, and @@ -123,7 +123,7 @@ to another RADIUS server. Then, start the server via the following command: -$ radiusd -n radrelay +$ radiusd \-n radrelay The server should start up, read the detail file, and process accounting packets from it. diff --git a/man/man5/rlm_digest.5 b/man/man5/rlm_digest.5 index 792d70c..fb99e0f 100644 --- a/man/man5/rlm_digest.5 +++ b/man/man5/rlm_digest.5 @@ -40,7 +40,7 @@ Once the server has been started (debugging mode is recommended), use '\fIradclient\fP to send the following packet to the server: .PP .DS -$ radclient -f digest localhost auth testing123 +$ radclient \-f digest localhost auth testing123 .DE Where 'digest' is a file containing: diff --git a/man/man5/rlm_passwd.5 b/man/man5/rlm_passwd.5 index ce37bb0..5a9ac7b 100644 --- a/man/man5/rlm_passwd.5 +++ b/man/man5/rlm_passwd.5 @@ -75,7 +75,7 @@ added as a control attribute list. .PP To add an attribute to the RADIUS request (as though it had been sent by the NAS), prefix the attribute name in the "format" string with the -'~' character. +\(aq~' character. .PP To add an attribute to the RADIUS reply (to be sent back to the NAS), prefix the attribute name in the "format" string with the '=' diff --git a/man/man5/unlang.5 b/man/man5/unlang.5 index ac3cae8..68fbee3 100644 --- a/man/man5/unlang.5 +++ b/man/man5/unlang.5 @@ -218,7 +218,7 @@ See raddb/sites-available/originate-coa for additional information. The "session-state" list is primarily used for EAP. Attributes put into the "session-state" list are saved for the next packet in the -session. They are automatically retreived when the next packet is +session. They are automatically retrieved when the next packet is received. The only contents permitted in an "update" section are attributes and diff --git a/man/man5/users.5 b/man/man5/users.5 index 0c28054..deae8a9 100644 --- a/man/man5/users.5 +++ b/man/man5/users.5 @@ -28,7 +28,7 @@ empty) list of check items, all on one line. The next line begins with a tab, and a (possibly empty) list of reply items. Each item in the check or reply item list is an attribute of the form \fBname = value\fP. Multiple items may be placed on one line, in which case -they must be seperated by commas. The reply items may be specified +they must be separated by commas. The reply items may be specified over multiple lines, in which case each line must end with a comma, and the last line of the reply items must not end with a comma. diff --git a/man/man8/radcrypt.8 b/man/man8/radcrypt.8 index 916a8b3..08336c6 100644 --- a/man/man8/radcrypt.8 +++ b/man/man8/radcrypt.8 @@ -22,13 +22,13 @@ will be 0 (Note this is the opposite of a normal successful shell status). .SH OPTIONS -.IP "-d --des" +.IP "\-d --des" Use a DES (Data Encryption Standard) hash (default). Ignored if performing a password check. -.IP "-m --md5" +.IP "\-m --md5" Use a MD5 (Message Digest 5) hash. Ignored if performing a password check. -.IP "-c --check" +.IP "\-c --check" Perform a validation check on a password hash to verify if it matches the plantext password. @@ -36,7 +36,7 @@ the plantext password. .nf $ radcrypt foobar HaX0xn7Qy650Q -$ radcrypt -c foobar HaX0xn7Qy650Q +$ radcrypt \-c foobar HaX0xn7Qy650Q Password OK .fi .SH SEE ALSO diff --git a/man/man8/radiusd.8 b/man/man8/radiusd.8 index 7424e88..c825f22 100644 --- a/man/man8/radiusd.8 +++ b/man/man8/radiusd.8 @@ -45,11 +45,11 @@ server will exit with a zero status code. Note that there are limitations to this check. Due to the complexities involved in \fIalmost\fP starting a RADIUS server, these checks are necessarily incomplete. The server can return a zero -status code when run with -C, but may still exit with an error when +status code when run with \-C, but may still exit with an error when run normally. See the output of -.B "radiusd -XC" +.B "radiusd \-XC" for an informative list of which modules are checked for correct configuration, and which modules are skipped, and therefore not checked. .IP "\-d \fIconfig directory\fP" @@ -96,13 +96,13 @@ Do not spawn threads. .IP \-v Print server version information and exit. .IP \-X -Debugging mode. Equivalent to "-sfxx -l stdout". When trying to -understand how the server works, ALWAYS run it with "radiusd -X". +Debugging mode. Equivalent to "\-sfxx \-l stdout". When trying to +understand how the server works, ALWAYS run it with "radiusd \-X". For production servers, use "raddebug" .IP \-x Finer-grained debug mode. In this mode the server will print details of every request on it's \fBstdout\fP output. You can specify this -option multiple times (-x -x or -xx) to get more detailed output. +option multiple times (\-x \-x or \-xx) to get more detailed output. .SH DEBUGGING The default configuration is set to work in the widest possible circumstances. It requires minimal changes for your system. @@ -113,7 +113,7 @@ guaranteed method of failure. Instead, we STRONGLY RECOMMEND proceeding via the following steps: .PP 1) Always run the server in debugging mode ( -.B radiusd -X +.B radiusd \-X ) after making a configuration change. We cannot emphasize this enough. If you are not running the server in debugging mode, you \fIwill not\fP be able to see what is doing, and you \fIwill not\fP be @@ -165,14 +165,14 @@ can be skipped. .br .br d) Start the server in debugging mode ( -.B radiusd -X +.B radiusd \-X ), and start testing. .in -0.3i .PP 5) Ask questions on the mailing list (freeradius-users@lists.freeradius.org). When asking questions, include the output from debugging mode ( -.B radiusd -X +.B radiusd \-X ). This information will allow people to help you. If you do not include it, the first response to your message will be "post the output of debug mode". @@ -191,7 +191,7 @@ the case of a PPP connection. .PP The access server also sends login and logout records to the \fBradius\fP server so accounting can be done. These records are kept for each terminal -server seperately in a file called \fBdetail\fP, and in the \fIwtmp\fP +server separately in a file called \fBdetail\fP, and in the \fIwtmp\fP compatible logfile \fB/var/log/radwtmp\fP. .SH CONFIGURATION \fBRadiusd\fP uses a number of configuration files. Each file has it's diff --git a/man/man8/radmin.8 b/man/man8/radmin.8 index 577c2b6..5ecc963 100644 --- a/man/man8/radmin.8 +++ b/man/man8/radmin.8 @@ -77,7 +77,7 @@ enclosed in double-quotes must have back-slashes and the quotation marks escaped inside of the string. Only one debug condition can be active at a time. -.IP debug\ condition\ '((User-Name\ ==\ "bob")\ ||\ (Packet-Src-IP-Address\ ==\ 192.0.2.22))' +.IP "debug condition '((User-Name == ""bob"") || (Packet-Src-IP-Address == 192.0.2.22))'" A more complex condition that enables debugging output for requests containing User-Name "bob", or requests that originate from source IP address 192.0.2.22. diff --git a/man/man8/radrelay.8 b/man/man8/radrelay.8 index a8694c6..fdba699 100644 --- a/man/man8/radrelay.8 +++ b/man/man8/radrelay.8 @@ -30,7 +30,7 @@ See raddb/sites-available/buffered-sql for more information. .SH "BUFFERING FOR HIGH-LOAD SERVERS" If the RADIUS server suddenly receives a many accounting packets, there may be insufficient CPU power to process them all in a timely -manner. This problem is especially noticable when the accounting +manner. This problem is especially noticeable when the accounting packets are going to a back-end database. Similarly, you may have one database that tracks "live" sessions, and diff --git a/man/man8/radsqlrelay.8 b/man/man8/radsqlrelay.8 index 65622e1..344c3ab 100644 --- a/man/man8/radsqlrelay.8 +++ b/man/man8/radsqlrelay.8 @@ -71,7 +71,7 @@ The pathname of the SQL logfile to use. .SH NOTES .SS Oracle driver -The command "radsqlrelay -d oracle -b db.domain.tld sql-relay" reads the +The command "radsqlrelay \-d oracle \-b db.domain.tld sql-relay" reads the database description stored in $TNS_ADMIN/tnsnames.ora: .PP .DS diff --git a/src/include/build.h b/src/include/build.h index 80cfeea..2d80039 100644 --- a/src/include/build.h +++ b/src/include/build.h @@ -122,7 +122,7 @@ extern "C" { * Other projects seem to use endian.h and variants, but these are * in non standard locations, and may mess up cross compiling. * - * Here at least the endianess can be set explicitly with + * Here at least the endianness can be set explicitly with * -DLITTLE_ENDIAN or -DBIG_ENDIAN. */ #if !defined(FR_LITTLE_ENDIAN) && !defined(FR_BIG_ENDIAN) diff --git a/src/lib/radius.c b/src/lib/radius.c index c6bcdbe..7664cf9 100644 --- a/src/lib/radius.c +++ b/src/lib/radius.c @@ -374,7 +374,7 @@ ssize_t rad_recv_header(int sockfd, fr_ipaddr_t *src_ipaddr, uint16_t *src_port, * Convert AF. If unknown, discard packet. */ if (!fr_sockaddr2ipaddr(&src, sizeof_src, src_ipaddr, src_port)) { - FR_DEBUG_STRERROR_PRINTF("Unkown address family"); + FR_DEBUG_STRERROR_PRINTF("Unknown address family"); rad_recv_discard(sockfd); return 1; diff --git a/src/main/process.c b/src/main/process.c index 2f0c7f2..14cc3b0 100644 --- a/src/main/process.c +++ b/src/main/process.c @@ -3621,7 +3621,7 @@ static void mark_home_server_zombie(home_server_t *home, struct timeval *now, st */ start = now->tv_sec - ((home->zombie_period + 3) / 4); if (home->last_packet_recv >= start) { - DEBUG("Recieved reply from home server %d seconds ago. Might not be zombie.", + DEBUG("Received reply from home server %d seconds ago. Might not be zombie.", (int) (now->tv_sec - home->last_packet_recv)); return; } diff --git a/src/main/version.c b/src/main/version.c index c0287bb..4a4a156 100644 --- a/src/main/version.c +++ b/src/main/version.c @@ -552,7 +552,7 @@ void version_print(void) talloc_free(versions); - DEBUG3("Endianess:"); + DEBUG3("Endianness:"); #if defined(FR_LITTLE_ENDIAN) DEBUG3(" little"); #elif defined(FR_BIG_ENDIAN) diff --git a/src/modules/rlm_cache/rlm_cache.c b/src/modules/rlm_cache/rlm_cache.c index e2b7e88..e9572bc 100644 --- a/src/modules/rlm_cache/rlm_cache.c +++ b/src/modules/rlm_cache/rlm_cache.c @@ -347,7 +347,7 @@ static rlm_rcode_t cache_insert(rlm_cache_t *inst, REQUEST *request, rlm_cache_h return RLM_MODULE_FAIL; case CACHE_OK: - RDEBUG("Commited entry, TTL %d seconds", ttl); + RDEBUG("Committed entry, TTL %d seconds", ttl); cache_free(inst, &c); return RLM_MODULE_UPDATED; -- 2.1.4