Re: Bug#652423: Acknowledgement (ITP: v3c -- C/C++/sh/make/automake/Debian utility toolkit)

[Philip Ashmore <contact@philipashmore.com>]

On 17/12/11 15:29, David Prévot wrote:
> Le 17/12/2011 08:59, Reinhard Tartler a écrit :
> > On Sa, Dez 17, 2011 at 12:35:15 (CET), Philip Ashmore wrote:
> >
> > > Long description:
> > >   utility C/C++ include files
> > >   libv3c - a C/C++ library
> > >   v3c - a utility program meant to be used in scripts or from the command
> > > line
> > >   makefile includes - see v3c's client projects "makefile" for examples
> > >   automake/aclocal m4 macros - see v3c's client projects for examples
> > This description fails to explain what this package is intended for and
> > how it relates and is better to alternatives in Debian. After reading
> > the package description, the reader should be able to decide if the
> > package satisfies the user's requirements.
> >
> > cf. http://mdcc.cx/debian/descriptions.html and many other guidelines on
> > the internet.
> Please prefer the up to date developers' reference:
>
> http://www.debian.org/doc/manuals/developers-reference/best-pkging-practices#bpp-desc-basics
> www.debian.org/doc/manuals/developers-reference/best-pkging-practices#bpp-pkg-synopsis
> www.debian.org/doc/manuals/developers-reference/best-pkging-practices#bpp-pkg-desc
>
> Regards
>
> David
package_description: automake wrapper + utility toolkit
package_long_description:
 Highlights:
 = "make" wrapper =
   make - configures + builds the package (debug mode by default - see 
below)
   make dist - builds a distribution tar ball
   make check - runs the packages automake checks
   make distcheck - builds a distribution tar ball, installs and "make 
check"s it
   make install - installs the package - may require elevated (root) 
privileges
 .
 = GIT version control =
   make git branch=master - build the "master" branch
   make git tag=test1.2.3 - build the branch locally tagged as "test1.2.3"
 .
 = Debian/Ubuntu packages =
   make debian - runs "make distcheck", then builds Debian/Ubuntu packages
 .
 = build modes =
 You can choose several configurations using "build modes" - "debug" 
and "release"
 are available by default, and "debug" is the default build mode.
   make debian (optimizations off unless "release" was the last build 
mode used)
   make release debian (optimizations on)
   make git tag=new2 debug distcheck
 The build system remembers your last build mode, so
   make release
   ...tests+edits
   make (uses the last build mode - release in this case)
   ...tests+edits
   make debug
   ...tests+edits
   make install
   ...tests+edits
   make uninstall
 This gives you a relatively quick turnaround for testing/debugging.
 .
 = libv3c = - a C/C++ utility library
 .
 = doxygen documentation integration =
   make doxygen-doc - generates html documentation from the packages 
source files
   make install-doxygen-doc - installs it
 .
 = v3c = - a utility program for use in scripts or the command line
 The "v3c" build system uses this extensively.
 .
 = lots of examples/tests =
 Run "make check" to see more.

Please let me know what you think.

Regards,
Philip Ashmore