cannam@85: This library is designed to allow parallel installation of different major
cannam@85: versions.  To facilitate this, the shared library name, include directory, and
cannam@85: pkg-config file are suffixed with the major version number of the library.
cannam@85: 
cannam@85: For example, if this library was named "foo" and at version 1.x.y:
cannam@85: 
cannam@85: /usr/include/foo-1/foo/foo.h
cannam@85: /usr/lib/foo-1.so.1.x.y
cannam@85: /usr/lib/pkgconfig/foo-1.pc
cannam@85: 
cannam@85: Dependencies check for pkg-config name "foo-1" and will build
cannam@85: against a compatible version 1, regardless any other installed versions.
cannam@85: 
cannam@85: *** IMPORTANT GUIDELINES FOR PACKAGERS ***
cannam@85: 
cannam@85: Packages should follow the same conventions as above, i.e. include the major
cannam@85: version (and only the major version) in the name of the package.  Continuing the
cannam@85: example above, the package(s) would be named foo-1 and foo-1-dev.  This way,
cannam@85: if/when version 2 comes out, it may be installed at the same time as version 1
cannam@85: without breaking anything.
cannam@85: 
cannam@85: Please do not create packages of this library that do not follow these
cannam@85: guidelines, you will break things and cause unnecessary headaches.  Please do
cannam@85: not use any number as a suffix other than the actual major version number of the
cannam@85: upstream source package.
cannam@85: 
cannam@85: Because program and documentation names are not versioned, these should be
cannam@85: included in separate packages which may replace previous versions, since
cannam@85: there is little use in having parallel installations of them.