From d3ed94814302f0943e7fcb088de7ed02a36b9ef8 Mon Sep 17 00:00:00 2001 From: Ben Kibbey Date: Sun, 12 Apr 2009 15:56:34 -0400 Subject: [PATCH] Fixed a couple Debian lintian warnings with the manual page. --- debian/changelog | 3 ++- debian/lintian.overrides | 1 + doc/DoxygenLayout.xml | 18 +++++++++--------- doc/Makefile.am | 6 ++++-- doc/libpwmd.3 | 34 ++++++++++++++-------------------- src/libpwmd.h.in | 13 ++++--------- 6 files changed, 34 insertions(+), 41 deletions(-) diff --git a/debian/changelog b/debian/changelog index e76fc810..ceea42d9 100644 --- a/debian/changelog +++ b/debian/changelog @@ -8,5 +8,6 @@ libpwmd (6.0.0-1) testing; urgency=low * Don't build with libpth2 support. * Updated description. * Fixed installing the wrong lintian overrides for libpwmd5. + * Added new-package-should-close-itp-bug to lintian overrides. - -- Ben Kibbey Sat, 11 Apr 2009 12:41:09 -0400 + -- Ben Kibbey Sun, 12 Apr 2009 15:55:14 -0400 diff --git a/debian/lintian.overrides b/debian/lintian.overrides index c35f9af7..7e35e908 100644 --- a/debian/lintian.overrides +++ b/debian/lintian.overrides @@ -1 +1,2 @@ libpwmd6: non-dev-pkg-with-shlib-symlink +libpwmd6: new-package-should-close-itp-bug diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml index c6ca0105..acd2eba3 100644 --- a/doc/DoxygenLayout.xml +++ b/doc/DoxygenLayout.xml @@ -100,7 +100,7 @@ - + @@ -109,18 +109,18 @@ - - - - + + + + - - - - + + + + diff --git a/doc/Makefile.am b/doc/Makefile.am index 76e04ca1..26c60371 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -5,5 +5,7 @@ dist_man1_MANS = pwmc.1 doxygen: $(MAKE) -C $(top_builddir)/src libpwmd.h - sed 's/\(.*\)^^SRC_DIR^^/\1$(shell echo $(abs_top_builddir) | sed 's/\//\\\//g')\/src/' < doxygen.conf.in > doxygen.conf - doxygen doxygen.conf && mv -f man/man3/libpwmd.h.3 libpwmd.3 + @rm -f libpwmd.3.in + @sed 's/\(.*\)^^SRC_DIR^^/\1$(shell echo $(abs_top_builddir) | sed 's/\//\\\//g')\/src/' < doxygen.conf.in > doxygen.conf + doxygen doxygen.conf && mv -f man/man3/libpwmd.h.3 libpwmd.3.in + @test -s libpwmd.3.in && sed '5s/.*$$/libpwmd\.h - an API for accessing pwmd/' < libpwmd.3.in > libpwmd.3 && echo Successfully generated libpwmd.3. diff --git a/doc/libpwmd.3 b/doc/libpwmd.3 index 89446d42..efe6570b 100644 --- a/doc/libpwmd.3 +++ b/doc/libpwmd.3 @@ -2,8 +2,8 @@ .ad l .nh .SH NAME -libpwmd.h \- -.SH "Detailed Description" +libpwmd.h - an API for accessing pwmd +.SH "Description" .PP libpwmd is a library making it easy for applications to use the pwmd server. .SH "SSH Details" @@ -128,11 +128,11 @@ The following example will list the element tree of the data file specified in t .RI "struct \fBpwmd_fd_t\fP" .br .in -1c -.SS "Defines" +.SS "Constants" .in +1c .ti -1c -.RI "#define \fBLIBPWMD_VERSION\fP" +.RI "#define \fBLIBPWMD_VERSION\fP 0x600" .br .ti -1c .RI "#define \fBPWMD_FD_READABLE\fP" @@ -225,7 +225,7 @@ The following example will list the element tree of the data file specified in t .RI "gpg_error_t \fBpwmd_get_hostkey_async\fP (\fBpwm_t\fP *pwm, const char *host, int port)" .br .ti -1c -.RI "gpg_error_t \fBpwmd_get_fds\fP (\fBpwm_t\fP *pwm, pwmd_fd_t *fds, int *n_fds)" +.RI "gpg_error_t \fBpwmd_get_fds\fP (\fBpwm_t\fP *pwm, \fBpwmd_fd_t\fP *fds, int *n_fds)" .br .ti -1c .RI "gpg_error_t \fBpwmd_pending_line\fP (\fBpwm_t\fP *pwm)" @@ -300,7 +300,7 @@ The following example will list the element tree of the data file specified in t .RI "int \fBpwmd_strerror_r\fP (gpg_error_t code, char *buf, size_t size)" .br .in -1c -.SH "Define Documentation" +.SH "Constant Details" .PP .SS "#define EPWMD_ERROR" .PP @@ -320,7 +320,7 @@ The maximum number of cache slots has been reached. There is no available slot f .SS "#define EPWMD_NO_FILE" .PP A command required an open file but no file has yet been opened. -.SS "#define LIBPWMD_VERSION" +.SS "#define LIBPWMD_VERSION 0x600" .PP The version of this library. .SS "#define PWMD_FD_READABLE" @@ -329,7 +329,7 @@ Set when the file descriptor is readable. .SS "#define PWMD_FD_WRITABLE" .PP Set when the file descriptor is writable. -.SH "Typedef Documentation" +.SH "Typedef Details" .PP .SS "\fBpwm_t\fP" .PP @@ -400,7 +400,7 @@ The value of the option \fBPWMD_OPTION_STATUS_CB\fP which is set with \fBpwmd_se .RE .PP -.SH "Enumeration Type Documentation" +.SH "Enumeration Details" .PP .SS "enum \fBpwmd_async_t\fP" .PP @@ -569,7 +569,7 @@ A UNIX domain socket. .TP \fB\fIPWMD_SOCKET_SSH \fP\fP An SSH connection over a TCP socket. -.SH "Function Documentation" +.SH "Function Details" .PP .SS "void* pwmd_calloc (size_t nmemb, size_t size)" .PP @@ -624,9 +624,7 @@ Sends a command to the pwmd server. You should avoid sending the BYE command her .br \fIresult\fP The result of the command when successful which must be freed with \fBpwmd_free()\fP. Note that not all commands return a result. .br -\fIcmd\fP The command to send. -.br -\fI...\fP The arguments to \fIcmd\fP. +\fIcmd\fP The command to send and any following arguments. .RE .PP \fBReturns:\fP @@ -795,7 +793,7 @@ Nothing. .RE .PP -.SS "gpg_error_t pwmd_get_fds (\fBpwm_t\fP * pwm, pwmd_fd_t * fds, int * n_fds)" +.SS "gpg_error_t pwmd_get_fds (\fBpwm_t\fP * pwm, \fBpwmd_fd_t\fP * fds, int * n_fds)" .PP Get the associated file descriptor(s) for a handle. .PP @@ -1263,9 +1261,7 @@ See \fBpwmd_option_t\fP for option specific details. .RS 4 \fIpwm\fP A handle. .br -\fIopt\fP The option. -.br -\fI...\fP The option value. +\fIopt\fP The option and following value. .RE .PP \fBReturns:\fP @@ -1404,9 +1400,7 @@ Like sprintf() but returns an allocated string. .PP \fBParameters:\fP .RS 4 -\fIfmt\fP The formatted string. -.br -\fI...\fP Any format arguments to the string. +\fIfmt\fP The formatted string and any following arguments. .RE .PP \fBReturns:\fP diff --git a/src/libpwmd.h.in b/src/libpwmd.h.in index 990b861f..b8e11ddc 100644 --- a/src/libpwmd.h.in +++ b/src/libpwmd.h.in @@ -162,7 +162,6 @@ extern "C" { #endif /*! \def LIBPWMD_VERSION - * \hideinitializer * * The version of this library. */ @@ -229,8 +228,7 @@ typedef enum { #define PWMD_FD_WRITABLE 0x02 -/*! \typedef pwmd_fd_t - * +/*! * For use with \ref pwmd_get_fds(). */ typedef struct { @@ -648,8 +646,7 @@ gpg_error_t pwmd_pending_line(pwm_t *pwm) * See \ref pwmd_option_t for option specific details. * * \param pwm A handle. - * \param opt The option. - * \param ... The option value. + * \param opt The option and following value. * \return 0 on success or an error code. */ gpg_error_t pwmd_setopt(pwm_t *pwm, pwmd_option_t opt, ...) @@ -831,8 +828,7 @@ gpg_error_t pwmd_save_async(pwm_t *pwm) * \param pwm A handle. * \param[out] result The result of the command when successful which must be * freed with \ref pwmd_free(). Note that not all commands return a result. - * \param cmd The command to send. - * \param ... The arguments to \a cmd. + * \param cmd The command to send and any following arguments. * \return 0 on success or an error code. */ gpg_error_t pwmd_command(pwm_t *pwm, char **result, const char *cmd, ...) @@ -970,8 +966,7 @@ char *pwmd_strdup(const char *str) * * Like sprintf() but returns an allocated string. * - * \param fmt The formatted string. - * \param ... Any format arguments to the string. + * \param fmt The formatted string and any following arguments. * \return A newly allocated character pointer or NULL if there wasn't * enough memory. * \see pwmd_free() -- 2.11.4.GIT