You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@thrift.apache.org by ro...@apache.org on 2012/04/09 21:07:55 UTC
svn commit: r1311374 - in /thrift/site: content/docs/idl.md
content/download.md publish/docs/idl/index.html publish/download/index.html
Author: roger
Date: Mon Apr 9 19:07:55 2012
New Revision: 1311374
URL: http://svn.apache.org/viewvc?rev=1311374&view=rev
Log:
use markup for titles on docs/idl.md
THRIFT-1540 Download page should not link to snapshots / nightly builds
Modified:
thrift/site/content/docs/idl.md
thrift/site/content/download.md
thrift/site/publish/docs/idl/index.html
thrift/site/publish/download/index.html
Modified: thrift/site/content/docs/idl.md
URL: http://svn.apache.org/viewvc/thrift/site/content/docs/idl.md?rev=1311374&r1=1311373&r2=1311374&view=diff
==============================================================================
--- thrift/site/content/docs/idl.md (original)
+++ thrift/site/content/docs/idl.md Mon Apr 9 19:07:55 2012
@@ -12,31 +12,31 @@ The Thrift interface definition language
Here is a description of the Thrift IDL.
-== Document ==
+## Document
Every Thrift document contains 0 or more headers followed by 0 or more definitions.
{{{[1] Document ::= Header* Definition*}}}
-== Header ==
+## Header
A header is either a Thrift include, a C++ include, or a namespace declaration.
{{{[2] Header ::= Include | CppInclude | Namespace}}}
-=== Thrift Include ===
+## Thrift Include
An include makes all the symbols from another file visible (with a prefix) and adds corresponding include statements into the code generated for this Thrift document.
{{{[3] Include ::= 'include' Literal}}}
-=== C++ Include ===
+### C++ Include
A C++ include adds a custom C++ include to the output of the C++ code generator for this Thrift document.
{{{[4] CppInclude ::= 'cpp_include' Literal}}}
-=== Namespace ===
+### Namespace
A namespace declares which namespaces/package/module/etc. the type definitions in this file will be declared in for the target languages. The namespace scope indicates which language the namespace applies to; a scope of '*' indicates that the namespace applies to all target languages.
@@ -55,31 +55,31 @@ NB: The php_namespace directive will be
NB: The xsd_namespace directive has some purpose internal to Facebook but serves no purpose in Thrift itself. Use of this feature is strongly discouraged
-== Definition ==
+## Definition
{{{[7] Definition ::= Const | Typedef | Enum | Senum | Struct | Exception | Service}}}
-=== Const ===
+### Const
{{{[8] Const ::= 'const' FieldType Identifier '=' ConstValue ListSeparator?}}}
-=== Typedef ===
+### Typedef
A typedef creates an alternate name for a type.
{{{[9] Typedef ::= 'typedef' DefinitionType Identifier}}}
-=== Enum ===
+### Enum
An enum creates an enumerated type, with named values. If no constant value is supplied, the value is either 0 for the first element, or one greater than the preceding value for any subsequent element. Any constant value that is supplied must be non-negative.
{{{[10] Enum ::= 'enum' Identifier '{' (Identifier ('=' IntConstant)? ListSeparator?)* '}'}}}
-=== Senum ===
+### Senum
{{{[11] Senum ::= 'senum' Identifier '{' (Literal ListSeparator?)* '}'}}}
-=== Struct ===
+### Struct
Structs are the fundamental compositional type in Thrift. The name of each field must be unique within the struct.
@@ -87,32 +87,32 @@ Structs are the fundamental compositiona
NB: The xsd_all keyword has some purpose internal to Facebook but serves no purpose in Thrift itself. Use of this feature is strongly discouraged
-=== Exception ===
+### Exception
Exceptions are similar to structs except that they are intended to integrate with the native exception handling mechanisms in the target languages. The name of each field must be unique within the exception.
{{{[13] Exception ::= 'exception' Identifier '{' Field* '}' }}}
-=== Service ===
+### Service
A service provides the interface for a set of functionality provided by a Thrift server. The interface is simply a list of functions. A service can extend another service, which simply means that it provides the functions of the extended service in addition to its own.
{{{[14] Service ::= 'service' Identifier ( 'extends' Identifier )? '{' Function* '}'}}}
-== Field ==
+## Field
{{{[15] Field ::= FieldID? FieldReq? FieldType Identifier ('= ConstValue)? XsdFieldOptions ListSeparator?}}}
-=== Field ID ===
+### Field ID
{{{[16] FieldID ::= IntConstant ':'}}}
-=== Field Requiredness ===
+### Field Requiredness
{{{[17] FieldReq ::= 'required' | 'optional'}}}
-=== XSD Options ===
+### XSD Options
NB: These have some internal purpose at Facebook but serve no current purpose in Thrift. Use of these options is strongly discouraged.
@@ -120,7 +120,7 @@ NB: These have some internal purpose at
{{{[19] XsdAttrs ::= 'xsd_attrs' '{' Field* '}'}}}
-== Functions ==
+## Functions
{{{[20] Function ::= 'oneway'? FunctionType Identifier '(' Field* ')' Throws? ListSeparator?}}}
@@ -128,7 +128,7 @@ NB: These have some internal purpose at
{{{[22] Throws ::= 'throws' '(' Field* ')'}}}
-== Types ==
+## Types
{{{[23] FieldType ::= Identifier | BaseType | ContainerType}}}
@@ -147,7 +147,7 @@ NB: These have some internal purpose at
{{{[30] CppType ::= 'cpp_type' Literal}}}
-== Constant Values ==
+## Constant Values
{{{[31] ConstValue ::= IntConstant | DoubleConstant | Literal | Identifier | ConstList | ConstMap}}}
@@ -159,29 +159,29 @@ NB: These have some internal purpose at
{{{[35] ConstMap ::= '{' (ConstValue ':' ConstValue ListSeparator?)* '}'}}}
-== Basic Definitions ==
+## Basic Definitions
-=== Literal ===
+### Literal
{{{[36] Literal ::= ('"' [^"]* '"') | ("'" [^']* "'")}}}
-=== Identifier ===
+### Identifier
{{{[37] Identifier ::= ( Letter | '_' ) ( Letter | Digit | '.' | '_' )*}}}
{{{[38] STIdentifier ::= ( Letter | '_' ) ( Letter | Digit | '.' | '_' | '-' )*}}}
-=== List Separator ===
+### List Separator
{{{[39] ListSeparator ::= ',' | ';'}}}
-=== Letters and Digits ===
+### Letters and Digits
{{{[40] Letter ::= ['A'-'Z'] | ['a'-'z']}}}
{{{[41] Digit ::= ['0'-'9']}}}
-= Examples =
+# Examples
Here are some examples of Thrift definitions, using the Thrift IDL:
* [[http://svn.apache.org/repos/asf/thrift/trunk/test/ThriftTest.thrift | ThriftTest.thrift]] used by the Thrift TestFramework
@@ -190,7 +190,7 @@ Here are some examples of Thrift definit
* [[http://cassandra.apache.org/ | Apache Cassandra's]] Thrift IDL: [[http://svn.apache.org/viewvc/cassandra/trunk/interface/cassandra.thrift?view=co | cassandra.thrift]]
* [[http://www.evernote.com/about/developer/api/ | Evernote API]]
-= To Do/Questions =
+# To Do/Questions
Initialization of Base Types for all Languages?
* Do all Languages initialize them to 0, bool=false and string=""? or null, undefined?
Modified: thrift/site/content/download.md
URL: http://svn.apache.org/viewvc/thrift/site/content/download.md?rev=1311374&r1=1311373&r2=1311374&view=diff
==============================================================================
--- thrift/site/content/download.md (original)
+++ thrift/site/content/download.md Mon Apr 9 19:07:55 2012
@@ -19,17 +19,6 @@ The latest stable release of Thrift is <
When downloading from a mirror, please be sure to [verify](http://www.apache.org/info/verification.html) the checksums and signature (see the MD5 and PGP links above). The [KEYS](http://www.apache.org/dist/thrift/KEYS) file contains the public key(s) used for signing releases.
----
-
-## Snapshot Releases
-The snapshot releases are built by [Thrift Continuous Integration](https://builds.apache.org/hudson/view/S-Z/view/Thrift/) server running on Apache Jenkins instance.
-
-* [thrift-x.x.x.tar.gz](https://builds.apache.org/hudson/job/Thrift/lastSuccessfulBuild/artifact/thrift/) - Latest successful build (make dist)
-* [Thrift compiler for Windows (thrift.exe)](https://builds.apache.org/hudson/job/Thrift-Compiler-Windows/lastSuccessfulBuild/artifact/thrift/thrift.exe) - Latest successful build
-* [Thrift javadoc](https://builds.apache.org/hudson/job/Thrift/javadoc/) - Latest successful build
-
-#### NOTE: These developer snapshots are not certified releases and we recommend that users use the stable release above.
-
---
## Incubator Releases
Modified: thrift/site/publish/docs/idl/index.html
URL: http://svn.apache.org/viewvc/thrift/site/publish/docs/idl/index.html?rev=1311374&r1=1311373&r2=1311374&view=diff
==============================================================================
--- thrift/site/publish/docs/idl/index.html (original)
+++ thrift/site/publish/docs/idl/index.html Mon Apr 9 19:07:55 2012
@@ -73,31 +73,31 @@
<p>Here is a description of the Thrift IDL.</p>
-<p>== Document ==</p>
+<h2>Document</h2>
<p>Every Thrift document contains 0 or more headers followed by 0 or more definitions.</p>
<p>{{{[1] Document ::= Header* Definition*}}}</p>
-<p>== Header ==</p>
+<h2>Header</h2>
<p>A header is either a Thrift include, a C++ include, or a namespace declaration.</p>
<p>{{{[2] Header ::= Include | CppInclude | Namespace}}}</p>
-<p>=== Thrift Include ===</p>
+<h2>Thrift Include</h2>
<p>An include makes all the symbols from another file visible (with a prefix) and adds corresponding include statements into the code generated for this Thrift document.</p>
<p>{{{[3] Include ::= 'include' Literal}}}</p>
-<p>=== C++ Include ===</p>
+<h3>C++ Include</h3>
<p>A C++ include adds a custom C++ include to the output of the C++ code generator for this Thrift document. </p>
<p>{{{[4] CppInclude ::= 'cpp_include' Literal}}}</p>
-<p>=== Namespace ===</p>
+<h3>Namespace</h3>
<p>A namespace declares which namespaces/package/module/etc. the type definitions in this file will be declared in for the target languages. The namespace scope indicates which language the namespace applies to; a scope of '*' indicates that the namespace applies to all target languages.</p>
@@ -116,31 +116,31 @@
<p>NB: The xsd_namespace directive has some purpose internal to Facebook but serves no purpose in Thrift itself. Use of this feature is strongly discouraged</p>
-<p>== Definition ==</p>
+<h2>Definition</h2>
<p>{{{[7] Definition ::= Const | Typedef | Enum | Senum | Struct | Exception | Service}}}</p>
-<p>=== Const ===</p>
+<h3>Const</h3>
<p>{{{[8] Const ::= 'const' FieldType Identifier '=' ConstValue ListSeparator?}}}</p>
-<p>=== Typedef ===</p>
+<h3>Typedef</h3>
<p>A typedef creates an alternate name for a type.</p>
<p>{{{[9] Typedef ::= 'typedef' DefinitionType Identifier}}}</p>
-<p>=== Enum ===</p>
+<h3>Enum</h3>
<p>An enum creates an enumerated type, with named values. If no constant value is supplied, the value is either 0 for the first element, or one greater than the preceding value for any subsequent element. Any constant value that is supplied must be non-negative.</p>
<p>{{{[10] Enum ::= 'enum' Identifier '{' (Identifier ('=' IntConstant)? ListSeparator?)* '}'}}}</p>
-<p>=== Senum ===</p>
+<h3>Senum</h3>
<p>{{{[11] Senum ::= 'senum' Identifier '{' (Literal ListSeparator?)* '}'}}}</p>
-<p>=== Struct ===</p>
+<h3>Struct</h3>
<p>Structs are the fundamental compositional type in Thrift. The name of each field must be unique within the struct.</p>
@@ -148,31 +148,31 @@
<p>NB: The xsd_all keyword has some purpose internal to Facebook but serves no purpose in Thrift itself. Use of this feature is strongly discouraged</p>
-<p>=== Exception ===</p>
+<h3>Exception</h3>
<p>Exceptions are similar to structs except that they are intended to integrate with the native exception handling mechanisms in the target languages. The name of each field must be unique within the exception.</p>
<p>{{{[13] Exception ::= 'exception' Identifier '{' Field* '}' }}}</p>
-<p>=== Service ===</p>
+<h3>Service</h3>
<p>A service provides the interface for a set of functionality provided by a Thrift server. The interface is simply a list of functions. A service can extend another service, which simply means that it provides the functions of the extended service in addition to its own.</p>
<p>{{{[14] Service ::= 'service' Identifier ( 'extends' Identifier )? '{' Function* '}'}}}</p>
-<p>== Field ==</p>
+<h2>Field</h2>
<p>{{{[15] Field ::= FieldID? FieldReq? FieldType Identifier ('= ConstValue)? XsdFieldOptions ListSeparator?}}}</p>
-<p>=== Field ID ===</p>
+<h3>Field ID</h3>
<p>{{{[16] FieldID ::= IntConstant ':'}}}</p>
-<p>=== Field Requiredness ===</p>
+<h3>Field Requiredness</h3>
<p>{{{[17] FieldReq ::= 'required' | 'optional'}}}</p>
-<p>=== XSD Options ===</p>
+<h3>XSD Options</h3>
<p>NB: These have some internal purpose at Facebook but serve no current purpose in Thrift. Use of these options is strongly discouraged.</p>
@@ -180,7 +180,7 @@
<p>{{{[19] XsdAttrs ::= 'xsd_attrs' '{' Field* '}'}}}</p>
-<p>== Functions ==</p>
+<h2>Functions</h2>
<p>{{{[20] Function ::= 'oneway'? FunctionType Identifier '(' Field* ')' Throws? ListSeparator?}}}</p>
@@ -188,7 +188,7 @@
<p>{{{[22] Throws ::= 'throws' '(' Field* ')'}}}</p>
-<p>== Types ==</p>
+<h2>Types</h2>
<p>{{{[23] FieldType ::= Identifier | BaseType | ContainerType}}}</p>
@@ -207,7 +207,7 @@
<p>{{{[30] CppType ::= 'cpp_type' Literal}}}</p>
-<p>== Constant Values ==</p>
+<h2>Constant Values</h2>
<p>{{{[31] ConstValue ::= IntConstant | DoubleConstant | Literal | Identifier | ConstList | ConstMap}}}</p>
@@ -219,29 +219,29 @@
<p>{{{[35] ConstMap ::= '{' (ConstValue ':' ConstValue ListSeparator?)* '}'}}}</p>
-<p>== Basic Definitions ==</p>
+<h2>Basic Definitions</h2>
-<p>=== Literal ===</p>
+<h3>Literal</h3>
<p>{{{[36] Literal ::= ('â' [^â]* 'â') | (â'â [^']* â'â)}}}</p>
-<p>=== Identifier ===</p>
+<h3>Identifier</h3>
<p>{{{[37] Identifier ::= ( Letter | '<em>' ) ( Letter | Digit | '.' | '</em>' )*}}}</p>
<p>{{{[38] STIdentifier ::= ( Letter | '<em>' ) ( Letter | Digit | '.' | '</em>' | '-' )*}}}</p>
-<p>=== List Separator ===</p>
+<h3>List Separator</h3>
<p>{{{[39] ListSeparator ::= ',' | ';'}}}</p>
-<p>=== Letters and Digits ===</p>
+<h3>Letters and Digits</h3>
<p>{{{[40] Letter ::= ['A'-'Z'] | ['a'-'z']}}}</p>
<p>{{{[41] Digit ::= ['0'-'9']}}}</p>
-<p>= Examples =</p>
+<h1>Examples</h1>
<p>Here are some examples of Thrift definitions, using the Thrift IDL:
* [[http://svn.apache.org/repos/asf/thrift/trunk/test/ThriftTest.thrift | ThriftTest.thrift]] used by the Thrift TestFramework
@@ -250,8 +250,9 @@
* [[http://cassandra.apache.org/ | Apache Cassandra's]] Thrift IDL: [[http://svn.apache.org/viewvc/cassandra/trunk/interface/cassandra.thrift?view=co | cassandra.thrift]]
* [[http://www.evernote.com/about/developer/api/ | Evernote API]]</p>
-<p>= To Do/Questions =
-Initialization of Base Types for all Languages?
+<h1>To Do/Questions</h1>
+
+<p>Initialization of Base Types for all Languages?
* Do all Languages initialize them to 0, bool=false and string=ââ? or null, undefined?</p>
<p>Why does position of {{{CppType}}} vary between {{{SetType}}} and {{{ListType}}}?
Modified: thrift/site/publish/download/index.html
URL: http://svn.apache.org/viewvc/thrift/site/publish/download/index.html?rev=1311374&r1=1311373&r2=1311374&view=diff
==============================================================================
--- thrift/site/publish/download/index.html (original)
+++ thrift/site/publish/download/index.html Mon Apr 9 19:07:55 2012
@@ -85,19 +85,6 @@
<p>When downloading from a mirror, please be sure to <a href="http://www.apache.org/info/verification.html">verify</a> the checksums and signature (see the MD5 and PGP links above). The <a href="http://www.apache.org/dist/thrift/KEYS">KEYS</a> file contains the public key(s) used for signing releases.</p>
-<hr><h2>Snapshot Releases</h2>
-
-<p>The snapshot releases are built by <a href="https://builds.apache.org/hudson/view/S-Z/view/Thrift/">Thrift Continuous Integration</a> server running on Apache Jenkins instance.</p>
-
-<ul>
-<li>
-<a href="https://builds.apache.org/hudson/job/Thrift/lastSuccessfulBuild/artifact/thrift/">thrift-x.x.x.tar.gz</a> - Latest successful build (make dist)</li>
-<li>
-<a href="https://builds.apache.org/hudson/job/Thrift-Compiler-Windows/lastSuccessfulBuild/artifact/thrift/thrift.exe">Thrift compiler for Windows (thrift.exe)</a> - Latest successful build</li>
-<li>
-<a href="https://builds.apache.org/hudson/job/Thrift/javadoc/">Thrift javadoc</a> - Latest successful build</li>
-</ul><h4>NOTE: These developer snapshots are not certified releases and we recommend that users use the stable release above.</h4>
-
<hr><h2>Incubator Releases</h2>
<p>Releases from the incubator ( less than 0.6.0 ) are available at the <a href="http://archive.apache.org/dist/incubator/thrift/">Thrift Incubator Archive</a></p>