diff options
| -rw-r--r-- | COPYING | 2 | ||||
| -rw-r--r-- | INSTALL | 27 | ||||
| -rw-r--r-- | PACKAGING | 29 |
3 files changed, 18 insertions, 40 deletions
@@ -1,4 +1,4 @@ -Copyright 2011-2014 David Robillard <http://drobilla.net> +Copyright 2011-2015 David Robillard <http://drobilla.net> Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above @@ -8,11 +8,7 @@ Building this software requires only Python. To install with default options: ./waf configure ./waf - ./waf install - -You may need to become root for the install stage, for example: - - sudo ./waf install + ./waf install # or sudo ./waf install Configuration Options --------------------- @@ -40,12 +36,20 @@ invoked: * CPPFLAGS: C preprocessor options * LINKFLAGS: Linker options -Installation Directories ------------------------- +Library Versioning +------------------ + +This library uses semantic versioning <http://semver.org/>. + +Several major versions can be installed in parallel. The shared library name, +include directory, and pkg-config file are suffixed with the major version +number. For example, a library named "foo" at version 1.x.y might install: -The --prefix option (or the PREFIX environment variable) can be used to change -the prefix which all files are installed under. There are also several options -allowing for more fine-tuned control, see the --help output for details. + /usr/include/foo-1/foo/foo.h + /usr/lib/foo-1.so.1.x.y + /usr/lib/pkgconfig/foo-1.pc + +Dependencies can check for the package "foo-1" with pkg-config. Packaging --------- @@ -57,3 +61,6 @@ which adds a prefix to all install paths. For example: ./waf configure --prefix=/usr ./waf ./waf install --destdir=/tmp/package + +Packages should allow parallel installation of several major versions. For +example, the above would be packaged as "foo-1".
\ No newline at end of file diff --git a/PACKAGING b/PACKAGING deleted file mode 100644 index 3eced169..00000000 --- a/PACKAGING +++ /dev/null @@ -1,29 +0,0 @@ -This library is designed to allow parallel installation of different major -versions. To facilitate this, the shared library name, include directory, and -pkg-config file are suffixed with the major version number of the library. - -For example, if this library was named "foo" and at version 1.x.y: - -/usr/include/foo-1/foo/foo.h -/usr/lib/foo-1.so.1.x.y -/usr/lib/pkgconfig/foo-1.pc - -Dependencies check for pkg-config name "foo-1" and will build -against a compatible version 1, regardless any other installed versions. - -*** IMPORTANT GUIDELINES FOR PACKAGERS *** - -Packages should follow the same conventions as above, i.e. include the major -version (and only the major version) in the name of the package. Continuing the -example above, the package(s) would be named foo-1 and foo-1-dev. This way, -if/when version 2 comes out, it may be installed at the same time as version 1 -without breaking anything. - -Please do not create packages of this library that do not follow these -guidelines, you will break things and cause unnecessary headaches. Please do -not use any number as a suffix other than the actual major version number of the -upstream source package. - -Because program and documentation names are not versioned, these should be -included in separate packages which may replace previous versions, since -there is little use in having parallel installations of them.
\ No newline at end of file |