From ff1526ea043fb92aa16a9a520aa58da004929da9 Mon Sep 17 00:00:00 2001 From: Joseph Wayne Norton Date: Fri, 3 Aug 2012 00:36:57 +0900 Subject: [PATCH] UBF User's Guide (v0.3.7) --- ubf-user-guide.en.html | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/ubf-user-guide.en.html b/ubf-user-guide.en.html index 79d137b..d2a5254 100644 --- a/ubf-user-guide.en.html +++ b/ubf-user-guide.en.html @@ -1,6 +1,6 @@ -UBF User’s Guide 1st DRAFT

UBF User’s Guide 1st DRAFT

Revision History
Revision 0.3.62012/07/30

Table of Contents

1. Preface
2. Introduction
3. Specifications
3.1. UBF(a)
3.2. UBF(b)
3.3. UBF(c)
4. Contracts & Plugins
4.1. Contract
4.2. Plugin
4.3. Importing Types
4.4. Compilation Errors
4.5. Miscellaneous
5. Transports
5.1. TCP/IP
5.2. HTTP
5.3. Miscellaneous
6. Servers
6.1. Stateless
6.2. Stateful
7. Clients
7.1. Erlang
7.2. Python
7.3. Java
8. Miscellaneous
8.1. Testing
8.2. Utilities
9. Building UBF from Source - Option 1
10. Building UBF from Source - Option 2
10.1. Download
10.2. Build - Mandatory
10.3. Build - Optional
10.4. UBF Documentation
10.5. Erlang/OTP System
10.6. GitHub - Forking Your Own Repositories
11. Reference
12. Appendix
12.1. Acknowledgments
12.2. ABNF Definition

1. Preface

UBF is a framework that permits the Erlang to talk to the outside +UBF User’s Guide 1st DRAFT

UBF User’s Guide 1st DRAFT

Revision History
Revision 0.3.72012/08/02

Table of Contents

1. Preface
2. Introduction
3. Specifications
3.1. UBF(a)
3.2. UBF(b)
3.3. UBF(c)
4. Contracts & Plugins
4.1. Contract
4.2. Plugin
4.3. Importing Types
4.4. Compilation Errors
4.5. Miscellaneous
5. Transports
5.1. TCP/IP
5.2. HTTP
5.3. Miscellaneous
6. Servers
6.1. Stateless
6.2. Stateful
7. Clients
7.1. Erlang
7.2. Python
7.3. Java
8. Miscellaneous
8.1. Testing
8.2. Utilities
9. Building UBF from Source - Option 1
10. Building UBF from Source - Option 2
10.1. Download
10.2. Build - Mandatory
10.3. Build - Optional
10.4. UBF Documentation
10.5. Erlang/OTP System
10.6. GitHub - Forking Your Own Repositories
11. Reference
12. Appendix
12.1. Acknowledgments
12.2. ABNF Definition

1. Preface

UBF is a framework that permits the Erlang to talk to the outside world [UBFPAPER]. The acronym "UBF" stands for "Universal Binary Format", designed and implemented by Joe Armstrong.

This document and the corresponding open-source code repositories hosted on github [UBF] are based on Joe Armstrong’s original UBF @@ -855,7 +855,7 @@ this purpose. For JSON-RPC (and JSF indirectly), the jsf_utils:ubf_contract/{1,2} functions are available for this purpose.

9. Building UBF from Source - Option 1

To download, build, and test the UBF application in one shot, please follow this recipe:

$ mkdir working-directory-name
 $ cd working-directory-name
-$ git clone git://github.com/ubf/ubf.git ubf
+$ git clone https://github.com/ubf/ubf.git ubf
 $ cd ubf
 $ ./rebar get-deps
 $ ./rebar compile
@@ -949,7 +949,7 @@ $ chmod a+x ~/bin/repo

  • Create working directory 

    $ mkdir working-directory-name
 $ cd working-directory-name
-$ repo init -u git://github.com/ubf/manifests.git -m ubf-default.xml
    [Note]

    Your "Git" identity is needed during the init step. Please +$ repo init -u https://github.com/ubf/manifests.git -m ubf-default.xml

    [Note]

    Your "Git" identity is needed during the init step. Please enter the name and email of your GitHub account if you have one. Team members having read-write access are recommended to use "repo init -u git@github.com:ubf/manifests.git -m ubf-default-rw.xml".

    [Tip]

    If you want to checkout the latest development version of UBF, @@ -993,11 +993,11 @@ $ make

    10.4. UBF Documentation

    This section is the first step to download and to build your own UBF documentation.

    1. Building UBF’s "Guides" basic recipe -

      $ cd working-directory-name/lib/ubf/priv/doc/src/ubf
+
      $ cd working-directory-name/deps/ubf/priv/doc/src/ubf
 $ make clean -OR- make realclean
 $ make

    2. Building UBF’s "Website" basic recipe -

      $ cd working-directory-name/lib/ubf/priv/doc/src/ubf/website
+
      $ cd working-directory-name/deps/ubf/priv/doc/src/ubf/website
 $ make clean -OR- make realclean
 $ make
      [Note]
      HTML documentation is written in the "./public_html" directory.

    UBF’s documentation is authored using AsciiDoc and a few auxillary tools: