summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Steinert <mike.steinert@gmail.com>2012-05-15 17:53:29 -0600
committerMichael Steinert <mike.steinert@gmail.com>2012-05-17 11:44:45 -0600
commitea8656460d3ec9a287eed2928204a33d84f13c90 (patch)
tree926fb77e9efd3b5300e95eace8336964c9faae59
parent80e63e0a3fb4c9518b992ee332bd5100e404e353 (diff)
downloadrabbitmq-c-github-ask-ea8656460d3ec9a287eed2928204a33d84f13c90.tar.gz
Remove unnecessary files
Signed-off-by: Michael Steinert <mike.steinert@gmail.com>
-rw-r--r--COPYING1
-rw-r--r--ChangeLog0
-rw-r--r--INSTALL291
-rw-r--r--NEWS0
-rw-r--r--README137
-rw-r--r--[l---------]README.md138
6 files changed, 137 insertions, 430 deletions
diff --git a/COPYING b/COPYING
deleted file mode 100644
index f5997d4..0000000
--- a/COPYING
+++ /dev/null
@@ -1 +0,0 @@
-See LICENSE-MIT.
diff --git a/ChangeLog b/ChangeLog
deleted file mode 100644
index e69de29..0000000
--- a/ChangeLog
+++ /dev/null
diff --git a/INSTALL b/INSTALL
deleted file mode 100644
index 8b82ade..0000000
--- a/INSTALL
+++ /dev/null
@@ -1,291 +0,0 @@
-Installation Instructions
-*************************
-
-Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
-2006, 2007, 2008 Free Software Foundation, Inc.
-
- This file is free documentation; the Free Software Foundation gives
-unlimited permission to copy, distribute and modify it.
-
-Basic Installation
-==================
-
- Briefly, the shell commands `./configure; make; make install' should
-configure, build, and install this package. The following
-more-detailed instructions are generic; see the `README' file for
-instructions specific to this package.
-
- The `configure' shell script attempts to guess correct values for
-various system-dependent variables used during compilation. It uses
-those values to create a `Makefile' in each directory of the package.
-It may also create one or more `.h' files containing system-dependent
-definitions. Finally, it creates a shell script `config.status' that
-you can run in the future to recreate the current configuration, and a
-file `config.log' containing compiler output (useful mainly for
-debugging `configure').
-
- It can also use an optional file (typically called `config.cache'
-and enabled with `--cache-file=config.cache' or simply `-C') that saves
-the results of its tests to speed up reconfiguring. Caching is
-disabled by default to prevent problems with accidental use of stale
-cache files.
-
- If you need to do unusual things to compile the package, please try
-to figure out how `configure' could check whether to do them, and mail
-diffs or instructions to the address given in the `README' so they can
-be considered for the next release. If you are using the cache, and at
-some point `config.cache' contains results you don't want to keep, you
-may remove or edit it.
-
- The file `configure.ac' (or `configure.in') is used to create
-`configure' by a program called `autoconf'. You need `configure.ac' if
-you want to change it or regenerate `configure' using a newer version
-of `autoconf'.
-
-The simplest way to compile this package is:
-
- 1. `cd' to the directory containing the package's source code and type
- `./configure' to configure the package for your system.
-
- Running `configure' might take a while. While running, it prints
- some messages telling which features it is checking for.
-
- 2. Type `make' to compile the package.
-
- 3. Optionally, type `make check' to run any self-tests that come with
- the package.
-
- 4. Type `make install' to install the programs and any data files and
- documentation.
-
- 5. You can remove the program binaries and object files from the
- source code directory by typing `make clean'. To also remove the
- files that `configure' created (so you can compile the package for
- a different kind of computer), type `make distclean'. There is
- also a `make maintainer-clean' target, but that is intended mainly
- for the package's developers. If you use it, you may have to get
- all sorts of other programs in order to regenerate files that came
- with the distribution.
-
- 6. Often, you can also type `make uninstall' to remove the installed
- files again.
-
-Compilers and Options
-=====================
-
- Some systems require unusual options for compilation or linking that
-the `configure' script does not know about. Run `./configure --help'
-for details on some of the pertinent environment variables.
-
- You can give `configure' initial values for configuration parameters
-by setting variables in the command line or in the environment. Here
-is an example:
-
- ./configure CC=c99 CFLAGS=-g LIBS=-lposix
-
- *Note Defining Variables::, for more details.
-
-Compiling For Multiple Architectures
-====================================
-
- You can compile the package for more than one kind of computer at the
-same time, by placing the object files for each architecture in their
-own directory. To do this, you can use GNU `make'. `cd' to the
-directory where you want the object files and executables to go and run
-the `configure' script. `configure' automatically checks for the
-source code in the directory that `configure' is in and in `..'.
-
- With a non-GNU `make', it is safer to compile the package for one
-architecture at a time in the source code directory. After you have
-installed the package for one architecture, use `make distclean' before
-reconfiguring for another architecture.
-
- On MacOS X 10.5 and later systems, you can create libraries and
-executables that work on multiple system types--known as "fat" or
-"universal" binaries--by specifying multiple `-arch' options to the
-compiler but only a single `-arch' option to the preprocessor. Like
-this:
-
- ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
- CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \
- CPP="gcc -E" CXXCPP="g++ -E"
-
- This is not guaranteed to produce working output in all cases, you
-may have to build one architecture at a time and combine the results
-using the `lipo' tool if you have problems.
-
-Installation Names
-==================
-
- By default, `make install' installs the package's commands under
-`/usr/local/bin', include files under `/usr/local/include', etc. You
-can specify an installation prefix other than `/usr/local' by giving
-`configure' the option `--prefix=PREFIX'.
-
- You can specify separate installation prefixes for
-architecture-specific files and architecture-independent files. If you
-pass the option `--exec-prefix=PREFIX' to `configure', the package uses
-PREFIX as the prefix for installing programs and libraries.
-Documentation and other data files still use the regular prefix.
-
- In addition, if you use an unusual directory layout you can give
-options like `--bindir=DIR' to specify different values for particular
-kinds of files. Run `configure --help' for a list of the directories
-you can set and what kinds of files go in them.
-
- If the package supports it, you can cause programs to be installed
-with an extra prefix or suffix on their names by giving `configure' the
-option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
-
-Optional Features
-=================
-
- Some packages pay attention to `--enable-FEATURE' options to
-`configure', where FEATURE indicates an optional part of the package.
-They may also pay attention to `--with-PACKAGE' options, where PACKAGE
-is something like `gnu-as' or `x' (for the X Window System). The
-`README' should mention any `--enable-' and `--with-' options that the
-package recognizes.
-
- For packages that use the X Window System, `configure' can usually
-find the X include and library files automatically, but if it doesn't,
-you can use the `configure' options `--x-includes=DIR' and
-`--x-libraries=DIR' to specify their locations.
-
-Particular systems
-==================
-
- On HP-UX, the default C compiler is not ANSI C compatible. If GNU
-CC is not installed, it is recommended to use the following options in
-order to use an ANSI C compiler:
-
- ./configure CC="cc -Ae"
-
-and if that doesn't work, install pre-built binaries of GCC for HP-UX.
-
- On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot
-parse its `<wchar.h>' header file. The option `-nodtk' can be used as
-a workaround. If GNU CC is not installed, it is therefore recommended
-to try
-
- ./configure CC="cc"
-
-and if that doesn't work, try
-
- ./configure CC="cc -nodtk"
-
-Specifying the System Type
-==========================
-
- There may be some features `configure' cannot figure out
-automatically, but needs to determine by the type of machine the package
-will run on. Usually, assuming the package is built to be run on the
-_same_ architectures, `configure' can figure that out, but if it prints
-a message saying it cannot guess the machine type, give it the
-`--build=TYPE' option. TYPE can either be a short name for the system
-type, such as `sun4', or a canonical name which has the form:
-
- CPU-COMPANY-SYSTEM
-
-where SYSTEM can have one of these forms:
-
- OS KERNEL-OS
-
- See the file `config.sub' for the possible values of each field. If
-`config.sub' isn't included in this package, then this package doesn't
-need to know the machine type.
-
- If you are _building_ compiler tools for cross-compiling, you should
-use the option `--target=TYPE' to select the type of system they will
-produce code for.
-
- If you want to _use_ a cross compiler, that generates code for a
-platform different from the build platform, you should specify the
-"host" platform (i.e., that on which the generated programs will
-eventually be run) with `--host=TYPE'.
-
-Sharing Defaults
-================
-
- If you want to set default values for `configure' scripts to share,
-you can create a site shell script called `config.site' that gives
-default values for variables like `CC', `cache_file', and `prefix'.
-`configure' looks for `PREFIX/share/config.site' if it exists, then
-`PREFIX/etc/config.site' if it exists. Or, you can set the
-`CONFIG_SITE' environment variable to the location of the site script.
-A warning: not all `configure' scripts look for a site script.
-
-Defining Variables
-==================
-
- Variables not defined in a site shell script can be set in the
-environment passed to `configure'. However, some packages may run
-configure again during the build, and the customized values of these
-variables may be lost. In order to avoid this problem, you should set
-them in the `configure' command line, using `VAR=value'. For example:
-
- ./configure CC=/usr/local2/bin/gcc
-
-causes the specified `gcc' to be used as the C compiler (unless it is
-overridden in the site shell script).
-
-Unfortunately, this technique does not work for `CONFIG_SHELL' due to
-an Autoconf bug. Until the bug is fixed you can use this workaround:
-
- CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
-
-`configure' Invocation
-======================
-
- `configure' recognizes the following options to control how it
-operates.
-
-`--help'
-`-h'
- Print a summary of all of the options to `configure', and exit.
-
-`--help=short'
-`--help=recursive'
- Print a summary of the options unique to this package's
- `configure', and exit. The `short' variant lists options used
- only in the top level, while the `recursive' variant lists options
- also present in any nested packages.
-
-`--version'
-`-V'
- Print the version of Autoconf used to generate the `configure'
- script, and exit.
-
-`--cache-file=FILE'
- Enable the cache: use and save the results of the tests in FILE,
- traditionally `config.cache'. FILE defaults to `/dev/null' to
- disable caching.
-
-`--config-cache'
-`-C'
- Alias for `--cache-file=config.cache'.
-
-`--quiet'
-`--silent'
-`-q'
- Do not print messages saying which checks are being made. To
- suppress all normal output, redirect it to `/dev/null' (any error
- messages will still be shown).
-
-`--srcdir=DIR'
- Look for the package's source code in directory DIR. Usually
- `configure' can determine that directory automatically.
-
-`--prefix=DIR'
- Use DIR as the installation prefix. *Note Installation Names::
- for more details, including other options available for fine-tuning
- the installation locations.
-
-`--no-create'
-`-n'
- Run the configure checks, but stop before creating any output
- files.
-
-`configure' also accepts some other, not widely useful, options. Run
-`configure --help' for more details.
-
diff --git a/NEWS b/NEWS
deleted file mode 100644
index e69de29..0000000
--- a/NEWS
+++ /dev/null
diff --git a/README b/README
deleted file mode 100644
index c5974e3..0000000
--- a/README
+++ /dev/null
@@ -1,137 +0,0 @@
-# RabbitMQ C AMQP client library
-
-## Introduction
-
-This is a C-language AMQP client library for use with AMQP servers
-speaking protocol versions 0-9-1.
-
- - <http://www.rabbitmq.com/>
- - <http://www.amqp.org/>
- - <http://hg.rabbitmq.com/rabbitmq-c>
-
-Announcements regarding the library are periodically made on the
-RabbitMQ mailing list and on the RabbitMQ blog.
-
- - <http://lists.rabbitmq.com/cgi-bin/mailman/listinfo/rabbitmq-discuss>
- - <http://www.rabbitmq.com/blog/>
-
-## Retrieving the code
-
-In addition to the source code for this library, you will require a
-copy of `rabbitmq-codegen`. Here is a short `sh` script for retrieving
-the necessary pieces:
-
- git clone https://github.com/rabbitmq/rabbitmq-codegen/
- git clone https://github.com/alanxz/rabbitmq-c
-
-You will also need a recent python with the simplejson module
-installed, and the GNU autotools (autoconf, automake, libtool etc)
-or as an alternative CMake
-
-## Building the code
-
-# Using autoconf
-
-Once you have all the prerequisites, change to the `rabbitmq-c`
-directory and run
-
- autoreconf -i
-
-to run the GNU autotools and generate the configure script, followed
-by
-
- ./configure
- make
-
-to build the `librabbitmq` library and the example programs.
-
-# Using cmake
-
-You will need CMake: http://cmake.org/
-
-You will need a working python install in your path.
-
-If you would like the build system to fetch the rabbitmq-codegen
-automatically you will need to have a working git install in your
-path. Otherwise you will need to checkout the rabbitmq-codegen as
-stated above.
-
-Create a binary directory in a sibling directory from the directory
-you cloned the rabbitmq-c repository
-
- mkdir bin-rabbitmq-c
-
-Run CMake in the binary directory
-
- cmake /path/to/source/directory
-
-Build it:
-
-* On linux: `make`
-* On win32: `nmake` or `msbuild`, or open it in visual studio and
- build from there
-
-Things you can pass to cmake to change the build:
-
-* `-DRABBITMQ_CODEGEN_DIR=/path/to/rabbitmq-codegen/checkout` - if you
- have your codegen directory in a different place [Default is
- sibiling directory to source]
-* `-DFETCH_CODEGEN_FROM_GIT=ON` - if you want cmake to fetch the
- rabbitmq-codegen from https://github.com/rabbitmq/rabbitmq-codegen
- at build time. If this option is selected `-DRABBITMQ_CODEGEN_DIR`
- will be ignored [Default is off]
-* `-DCODEGEN_GIT_TAG=rabbitmq_v2_5_1` - specifies the tag to check out
- if using the `-DFETCH_CODEGEN_FROM_GIT` option above. [Default is
- `rabbitmq_v2_5_1`]
-* `-DBUILD_TOOLS=OFF` build the programs in the tools directory
- [Default is ON if the POPT library can be found]
-
-Other interesting flags to pass to CMake (see cmake docs for more info)
-
-* `-DCMAKE_BUILD_TYPE` - specify the type of build (Debug or Release)
-* `-DCMAKE_INSTALL_PREFIX` - specify where the install target puts files
-
-## Running the examples
-
-Arrange for a RabbitMQ or other AMQP server to be running on
-`localhost` at TCP port number 5672.
-
-In one terminal, run
-
- ./examples/amqp_listen localhost 5672 amq.direct test
-
-In another terminal,
-
- ./examples/amqp_sendstring localhost 5672 amq.direct test "hello world"
-
-You should see output similar to the following in the listener's
-terminal window:
-
- Result 1
- Frame type 1, channel 1
- Method AMQP_BASIC_DELIVER_METHOD
- Delivery 1, exchange amq.direct routingkey test
- Content-type: text/plain
- ----
- 00000000: 68 65 6C 6C 6F 20 77 6F : 72 6C 64 hello world
- 0000000B:
-
-## Writing applications using `librabbitmq`
-
-Please see the `examples` directory for short examples of the use of
-the `librabbitmq` library.
-
-### Threading
-
-You cannot share a socket, an `amqp_connection_state_t`, or a channel
-between threads using `librabbitmq`. The `librabbitmq` library is
-built with event-driven, single-threaded applications in mind, and
-does not yet cater to any of the requirements of `pthread`ed
-applications.
-
-Your applications instead should open an AMQP connection (and an
-associated socket, of course) per thread. If your program needs to
-access an AMQP connection or any of its channels from more than one
-thread, it is entirely responsible for designing and implementing an
-appropriate locking scheme. It will generally be much simpler to have
-a connection exclusive to each thread that needs AMQP service.
diff --git a/README.md b/README.md
index 100b938..c5974e3 120000..100644
--- a/README.md
+++ b/README.md
@@ -1 +1,137 @@
-README \ No newline at end of file
+# RabbitMQ C AMQP client library
+
+## Introduction
+
+This is a C-language AMQP client library for use with AMQP servers
+speaking protocol versions 0-9-1.
+
+ - <http://www.rabbitmq.com/>
+ - <http://www.amqp.org/>
+ - <http://hg.rabbitmq.com/rabbitmq-c>
+
+Announcements regarding the library are periodically made on the
+RabbitMQ mailing list and on the RabbitMQ blog.
+
+ - <http://lists.rabbitmq.com/cgi-bin/mailman/listinfo/rabbitmq-discuss>
+ - <http://www.rabbitmq.com/blog/>
+
+## Retrieving the code
+
+In addition to the source code for this library, you will require a
+copy of `rabbitmq-codegen`. Here is a short `sh` script for retrieving
+the necessary pieces:
+
+ git clone https://github.com/rabbitmq/rabbitmq-codegen/
+ git clone https://github.com/alanxz/rabbitmq-c
+
+You will also need a recent python with the simplejson module
+installed, and the GNU autotools (autoconf, automake, libtool etc)
+or as an alternative CMake
+
+## Building the code
+
+# Using autoconf
+
+Once you have all the prerequisites, change to the `rabbitmq-c`
+directory and run
+
+ autoreconf -i
+
+to run the GNU autotools and generate the configure script, followed
+by
+
+ ./configure
+ make
+
+to build the `librabbitmq` library and the example programs.
+
+# Using cmake
+
+You will need CMake: http://cmake.org/
+
+You will need a working python install in your path.
+
+If you would like the build system to fetch the rabbitmq-codegen
+automatically you will need to have a working git install in your
+path. Otherwise you will need to checkout the rabbitmq-codegen as
+stated above.
+
+Create a binary directory in a sibling directory from the directory
+you cloned the rabbitmq-c repository
+
+ mkdir bin-rabbitmq-c
+
+Run CMake in the binary directory
+
+ cmake /path/to/source/directory
+
+Build it:
+
+* On linux: `make`
+* On win32: `nmake` or `msbuild`, or open it in visual studio and
+ build from there
+
+Things you can pass to cmake to change the build:
+
+* `-DRABBITMQ_CODEGEN_DIR=/path/to/rabbitmq-codegen/checkout` - if you
+ have your codegen directory in a different place [Default is
+ sibiling directory to source]
+* `-DFETCH_CODEGEN_FROM_GIT=ON` - if you want cmake to fetch the
+ rabbitmq-codegen from https://github.com/rabbitmq/rabbitmq-codegen
+ at build time. If this option is selected `-DRABBITMQ_CODEGEN_DIR`
+ will be ignored [Default is off]
+* `-DCODEGEN_GIT_TAG=rabbitmq_v2_5_1` - specifies the tag to check out
+ if using the `-DFETCH_CODEGEN_FROM_GIT` option above. [Default is
+ `rabbitmq_v2_5_1`]
+* `-DBUILD_TOOLS=OFF` build the programs in the tools directory
+ [Default is ON if the POPT library can be found]
+
+Other interesting flags to pass to CMake (see cmake docs for more info)
+
+* `-DCMAKE_BUILD_TYPE` - specify the type of build (Debug or Release)
+* `-DCMAKE_INSTALL_PREFIX` - specify where the install target puts files
+
+## Running the examples
+
+Arrange for a RabbitMQ or other AMQP server to be running on
+`localhost` at TCP port number 5672.
+
+In one terminal, run
+
+ ./examples/amqp_listen localhost 5672 amq.direct test
+
+In another terminal,
+
+ ./examples/amqp_sendstring localhost 5672 amq.direct test "hello world"
+
+You should see output similar to the following in the listener's
+terminal window:
+
+ Result 1
+ Frame type 1, channel 1
+ Method AMQP_BASIC_DELIVER_METHOD
+ Delivery 1, exchange amq.direct routingkey test
+ Content-type: text/plain
+ ----
+ 00000000: 68 65 6C 6C 6F 20 77 6F : 72 6C 64 hello world
+ 0000000B:
+
+## Writing applications using `librabbitmq`
+
+Please see the `examples` directory for short examples of the use of
+the `librabbitmq` library.
+
+### Threading
+
+You cannot share a socket, an `amqp_connection_state_t`, or a channel
+between threads using `librabbitmq`. The `librabbitmq` library is
+built with event-driven, single-threaded applications in mind, and
+does not yet cater to any of the requirements of `pthread`ed
+applications.
+
+Your applications instead should open an AMQP connection (and an
+associated socket, of course) per thread. If your program needs to
+access an AMQP connection or any of its channels from more than one
+thread, it is entirely responsible for designing and implementing an
+appropriate locking scheme. It will generally be much simpler to have
+a connection exclusive to each thread that needs AMQP service.