Repository: qpid-proton Updated Branches: refs/heads/master cac0fc437 -> 951dcb4e1
NO-JIRA: go: note C dependency prominently on entry-point docs. Project: http://git-wip-us.apache.org/repos/asf/qpid-proton/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-proton/commit/951dcb4e Tree: http://git-wip-us.apache.org/repos/asf/qpid-proton/tree/951dcb4e Diff: http://git-wip-us.apache.org/repos/asf/qpid-proton/diff/951dcb4e Branch: refs/heads/master Commit: 951dcb4e130613f16cab6bd7c24093423dc552d8 Parents: cac0fc4 Author: Alan Conway <[email protected]> Authored: Mon Jan 9 10:16:20 2017 -0500 Committer: Alan Conway <[email protected]> Committed: Mon Jan 9 10:20:53 2017 -0500 ---------------------------------------------------------------------- proton-c/bindings/go/src/qpid.apache.org/README.md | 5 +++++ proton-c/bindings/go/src/qpid.apache.org/amqp/doc.go | 2 ++ proton-c/bindings/go/src/qpid.apache.org/electron/doc.go | 2 ++ proton-c/bindings/go/src/qpid.apache.org/proton/doc.go | 2 ++ 4 files changed, 11 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/951dcb4e/proton-c/bindings/go/src/qpid.apache.org/README.md ---------------------------------------------------------------------- diff --git a/proton-c/bindings/go/src/qpid.apache.org/README.md b/proton-c/bindings/go/src/qpid.apache.org/README.md index ffd67f8..7415929 100644 --- a/proton-c/bindings/go/src/qpid.apache.org/README.md +++ b/proton-c/bindings/go/src/qpid.apache.org/README.md @@ -4,6 +4,11 @@ These packages provide [Go](http://golang.org) support for sending and receiving AMQP messages in client or server applications. Reference documentation is available at: <http://godoc.org/?q=qpid.apache.org> +They require the [proton-C library](http://qpid.apache.org/proton) to be installed. +On many platforms it is avaialable pre-packaged, for example on Fedora + + yum install qpid-proton-c-devel + There are 3 packages: [qpid.apache.org/amqp](http://godoc.org/qpid.apache.org/amqp) provides functions http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/951dcb4e/proton-c/bindings/go/src/qpid.apache.org/amqp/doc.go ---------------------------------------------------------------------- diff --git a/proton-c/bindings/go/src/qpid.apache.org/amqp/doc.go b/proton-c/bindings/go/src/qpid.apache.org/amqp/doc.go index 97051a5..701af55 100644 --- a/proton-c/bindings/go/src/qpid.apache.org/amqp/doc.go +++ b/proton-c/bindings/go/src/qpid.apache.org/amqp/doc.go @@ -24,6 +24,8 @@ It follows the standard 'encoding' libraries pattern. The mapping between AMQP and Go types is described in the documentation of the Marshal and Unmarshal functions. +This package requires the [proton-C library](http://qpid.apache.org/proton) to be installed. + Package 'electron' is a full AMQP 1.0 client/server toolkit using this package. AMQP 1.0 is an open standard for inter-operable message exchange, see <http://www.amqp.org/> http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/951dcb4e/proton-c/bindings/go/src/qpid.apache.org/electron/doc.go ---------------------------------------------------------------------- diff --git a/proton-c/bindings/go/src/qpid.apache.org/electron/doc.go b/proton-c/bindings/go/src/qpid.apache.org/electron/doc.go index bc2c589..f4baa31 100644 --- a/proton-c/bindings/go/src/qpid.apache.org/electron/doc.go +++ b/proton-c/bindings/go/src/qpid.apache.org/electron/doc.go @@ -20,6 +20,8 @@ under the License. /* Package electron lets you write concurrent AMQP 1.0 messaging clients and servers. +This package requires the [proton-C library](http://qpid.apache.org/proton) to be installed. + Start by creating a Container with NewContainer. An AMQP Container represents a single AMQP "application" and can contain client and server connections. http://git-wip-us.apache.org/repos/asf/qpid-proton/blob/951dcb4e/proton-c/bindings/go/src/qpid.apache.org/proton/doc.go ---------------------------------------------------------------------- diff --git a/proton-c/bindings/go/src/qpid.apache.org/proton/doc.go b/proton-c/bindings/go/src/qpid.apache.org/proton/doc.go index 083f701..1049e71 100644 --- a/proton-c/bindings/go/src/qpid.apache.org/proton/doc.go +++ b/proton-c/bindings/go/src/qpid.apache.org/proton/doc.go @@ -21,6 +21,8 @@ under the License. Package proton wraps Proton-C, an event-driven, concurrent-unsafe AMQP 1.0 C library (package 'electron' is more "Go-like" and concurrent-safe) +This package requires the [proton-C library](http://qpid.apache.org/proton) to be installed. + Consult the C API documentation at http://qpid.apache.org/proton for more information about the types here. There is a 1-1 correspondence between C type pn_foo_t and Go type proton.Foo, and between C function --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
