[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#654334: Please rewrite package description



Package: liboauth0
Version: 0.9.4-3+b1
Severity: wishlist
Tags: patch
X-Debbugs-CC: debian-l10n-english@lists.debian.org

Dear Maintainer,
to me the description of liboauth0 is quite useless as it does not say, what
OAuth can do for me.

  Description: C library for implementing OAuth 1.0
   liboauth is a collection of C functions implementing the
   OAuth Core 1.0 standard API.
   .
   This package contains the shared libraries

liboauth-dev gives more information, but still does not explain what OAuth is
about.

  Description: C library for implementing OAuth 1.0 (development files)
   liboauth is a collection of C functions implementing the
   OAuth Core 1.0 standard API. liboauth provides basic functions to escape
   and encode parameters according to OAuth specs and offers high-level
   functions to sign requests or verify signatures.
   .
   This package contains the development files.

It would be nice to have the boilerplate from ~-dev be available in liboauth
as well. As I believe that libraries provide some functions in most cases I
would like to suggest alternate package descriptions:

Package: liboauth-dev
Section: libdevel
Architecture: any
Depends: liboauth0 (= ${binary:Version}), libcurl4-nss-dev, ${misc:Depends}
Description: C library implementing the OAuth 1.0 API (development files)
 liboauth provides basic functions to escape and encode parameters
 according to OAuth specs and offers high-level functions to sign
 requests or verify signatures.

Package: liboauth0
Architecture: any
Pre-Depends: ${misc:Pre-Depends}
Depends: ${misc:Depends}, ${shlibs:Depends}
Multi-Arch: same
Description: C library implementing the OAuth 1.0 API (runtime)

Perhaps one could even copy and paste from RFC 5849 (1):

    The OAuth 1.0 Protocol

 Abstract

   OAuth provides a method for clients to access server resources on
   behalf of a resource owner (such as a different client or an end-
   user).  It also provides a process for end-users to authorize third-
   party access to their server resources without sharing their
   credentials (typically, a username and password pair), using user-
   agent redirections.

Kind regards,
   Martin

1: http://tools.ietf.org/html/rfc5849



Reply to: