Re: help needed to improve the libhkl package control file
PICCA Frédéric-Emmanuel wrote:
> Before asking for inclusion into Debian I would like to have your opinion about the attached control file.
> I prefer to have a proper control file before starting asking for upload.
Okay, patch and modified version attached, commentary below.
> -Homepage: http://not.yet
> +Homepage: http://www.hkl.gov.my/content/deptintro.php?Did=17
Only joking. I gather "hkl" has something to do with calculating
"h, k, and l values", and normal users won't care.
> -Description: library for diffraction calculation and diffractometer control.
> +Description: diffractometer control library
No need for a final full stop. I've moved some of this into the
long description so that all the other packages in the family have
got room to use this basic text plus an addendum.
> - The hkl library is dedicate to diffractometer control. It deals with different
> - kind of diffractometer geometries: eulerian 4 circles, eulerian 6 circles,
> - kappa 4 circles, kappa 6 circles and z-axis geometry. For each of thoses
> - geometry it provides different kind of modes (bissector, constant omega, ...).
> - It is heavily used at the SOLEIL synchrotron.
> + The hkl library is a framework for diffraction computation and
> + diffractometer control, heavily used at the SOLEIL synchrotron. It
> + supports various types of diffractometer geometry: Eulerian 4-circle,
> + Eulerian 6-circle, kappa 4-circle, kappa 6-circle, and z-axis
> + geometry. For each of these it provides multiple modes, including
> + bisector and constant omega.
I've pretty much just ripped it to pieces and put it back together
again. Google tells me there really is such an expression as
"(Eulerian) 4-circle geometry", so hopefully this will be
intelligible to the relevant specialists...
> .
> - This package contain the runtime hkl library.
> + This package provides the runtime hkl library.
Just changing the word while I'm changing the agreement.
> Package: libhkl-dev
[...]
> -Description: libhkl development package
> +Description: diffractometer control library - development files
Reusing the standard synopsis plus difference. Packages don't need
to be labelled as packages in the short description!
> - libhkl is a framework for diffraction computation and diffractometer control
> + The hkl library is a framework for diffraction computation and
> + diffractometer control, heavily used at the SOLEIL synchrotron. It
> + supports various types of diffractometer geometry: Eulerian 4-circle,
> + Eulerian 6-circle, kappa 4-circle, kappa 6-circle, and z-axis
> + geometry. For each of these it provides multiple modes, including
> + bisector and constant omega.
Reusing boilerplate.
> .
> - This package contains everything which is needed to link against libhkl4.
> + This package provides everything needed to link against hkl.
I thought taking the number out might be more futureproof, given
that it isn't called libhkl4-dev, but I may be wrong.
> Package: libhkl-dbg
[...]
> Package: libhkl-doc
[...]
Similar changes.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
Source: libhkl
Section: libs
Priority: optional
Maintainer: Picca Frédéric-Emmanuel <picca@synchrotron-soleil.fr>
Dm-Upload-Allowed: yes
Homepage: http://not.yet
Standards-Version: 3.8.4
Vcs-Browser: http://repo.or.cz/w/hkl.git
Vcs-Git: git://repo.or.cz/hkl.git
Build-Depends: debhelper (>= 7.0.50), libgsl0-dev
Package: libhkl4
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Suggests: libhkl-doc
Description: diffractometer control library
The hkl library is a framework for diffraction computation and
diffractometer control, heavily used at the SOLEIL synchrotron. It
supports various types of diffractometer geometry: Eulerian 4-circle,
Eulerian 6-circle, kappa 4-circle, kappa 6-circle, and z-axis
geometry. For each of these it provides multiple modes, including
bisector and constant omega.
.
This package provides the runtime hkl library.
Package: libhkl-dev
Section: libdevel
Architecture: any
Depends: ${misc:Depends}, libhkl4 (= ${binary:Version}), libgsl0-dev, dpkg (>= 1.15.4) | install-info
Description: diffractometer control library - development files
The hkl library is a framework for diffraction computation and
diffractometer control, heavily used at the SOLEIL synchrotron. It
supports various types of diffractometer geometry: Eulerian 4-circle,
Eulerian 6-circle, kappa 4-circle, kappa 6-circle, and z-axis
geometry. For each of these it provides multiple modes, including
bisector and constant omega.
.
This package provides everything needed to link against hkl.
Package: libhkl-dbg
Section: debug
Priority: extra
Architecture: any
Depends: ${misc:Depends}, libhkl4 (= ${binary:Version})
Description: diffractometer control library - debug symbols
The hkl library is a framework for diffraction computation and
diffractometer control, heavily used at the SOLEIL synchrotron. It
supports various types of diffractometer geometry: Eulerian 4-circle,
Eulerian 6-circle, kappa 4-circle, kappa 6-circle, and z-axis
geometry. For each of these it provides multiple modes, including
bisector and constant omega.
.
This package provides the debug files for hkl.
Package: libhkl-doc
Section: doc
Architecture: all
Depends: ${misc:Depends}
Description: diffractometer control library - documentation
The hkl library is a framework for diffraction computation and
diffractometer control, heavily used at the SOLEIL synchrotron. It
supports various types of diffractometer geometry: Eulerian 4-circle,
Eulerian 6-circle, kappa 4-circle, kappa 6-circle, and z-axis
geometry. For each of these it provides multiple modes, including
bisector and constant omega.
.
This package provides the documentation for hkl.
--- control.orig 2010-02-09 16:40:19.000000000 +0000
+++ control 2010-02-09 17:37:17.000000000 +0000
@@ -13,39 +13,55 @@
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Suggests: libhkl-doc
-Description: library for diffraction calculation and diffractometer control.
- The hkl library is dedicate to diffractometer control. It deals with different
- kind of diffractometer geometries: eulerian 4 circles, eulerian 6 circles,
- kappa 4 circles, kappa 6 circles and z-axis geometry. For each of thoses
- geometry it provides different kind of modes (bissector, constant omega, ...).
- It is heavily used at the SOLEIL synchrotron.
+Description: diffractometer control library
+ The hkl library is a framework for diffraction computation and
+ diffractometer control, heavily used at the SOLEIL synchrotron. It
+ supports various types of diffractometer geometry: Eulerian 4-circle,
+ Eulerian 6-circle, kappa 4-circle, kappa 6-circle, and z-axis
+ geometry. For each of these it provides multiple modes, including
+ bisector and constant omega.
.
- This package contain the runtime hkl library.
+ This package provides the runtime hkl library.
Package: libhkl-dev
Section: libdevel
Architecture: any
Depends: ${misc:Depends}, libhkl4 (= ${binary:Version}), libgsl0-dev, dpkg (>= 1.15.4) | install-info
-Description: libhkl development package
- libhkl is a framework for diffraction computation and diffractometer control
+Description: diffractometer control library - development files
+ The hkl library is a framework for diffraction computation and
+ diffractometer control, heavily used at the SOLEIL synchrotron. It
+ supports various types of diffractometer geometry: Eulerian 4-circle,
+ Eulerian 6-circle, kappa 4-circle, kappa 6-circle, and z-axis
+ geometry. For each of these it provides multiple modes, including
+ bisector and constant omega.
.
- This package contains everything which is needed to link against libhkl4.
+ This package provides everything needed to link against hkl.
Package: libhkl-dbg
Section: debug
Priority: extra
Architecture: any
Depends: ${misc:Depends}, libhkl4 (= ${binary:Version})
-Description: libhkl debug symbols package
- libhkl is a framework for diffraction computation and diffractometer control
+Description: diffractometer control library - debug symbols
+ The hkl library is a framework for diffraction computation and
+ diffractometer control, heavily used at the SOLEIL synchrotron. It
+ supports various types of diffractometer geometry: Eulerian 4-circle,
+ Eulerian 6-circle, kappa 4-circle, kappa 6-circle, and z-axis
+ geometry. For each of these it provides multiple modes, including
+ bisector and constant omega.
.
- This package contains the debug files.
+ This package provides the debug files for hkl.
Package: libhkl-doc
Section: doc
Architecture: all
Depends: ${misc:Depends}
-Description: libhkl documentation
- libhkl is a framework for diffraction computation and diffractometer control
+Description: diffractometer control library - documentation
+ The hkl library is a framework for diffraction computation and
+ diffractometer control, heavily used at the SOLEIL synchrotron. It
+ supports various types of diffractometer geometry: Eulerian 4-circle,
+ Eulerian 6-circle, kappa 4-circle, kappa 6-circle, and z-axis
+ geometry. For each of these it provides multiple modes, including
+ bisector and constant omega.
.
- This package contains the documentation of the libhkl library.
+ This package provides the documentation for hkl.
Reply to: