diff options
author | Roger Meier <roger@apache.org> | 2014-03-16 21:12:11 +0100 |
---|---|---|
committer | Roger Meier <roger@apache.org> | 2014-03-19 06:47:47 +0100 |
commit | 16fcad0b25f1200db7ec0add08f827c76bf4dd43 (patch) | |
tree | 02e119d494c8c719954c3904cf6fe01ba782f172 | |
parent | 706cb4e4cb7426d25722b1166e0c8b102b20051e (diff) | |
download | thrift-16fcad0b25f1200db7ec0add08f827c76bf4dd43.tar.gz |
THRIFT-2407 use markdown (rename README => README.md)
Patch: Roger Meier
-rwxr-xr-x | Makefile.am | 3 | ||||
-rw-r--r-- | README.md (renamed from README) | 7 | ||||
-rw-r--r-- | compiler/cpp/Makefile.am | 2 | ||||
-rw-r--r-- | compiler/cpp/README.md (renamed from compiler/cpp/README) | 0 | ||||
-rw-r--r-- | compiler/cpp/README_Windows.md (renamed from compiler/cpp/README_Windows.txt) | 0 | ||||
-rw-r--r-- | contrib/Rebus/README.md (renamed from contrib/Rebus/README) | 0 | ||||
-rw-r--r-- | contrib/Stomp/README.md (renamed from contrib/Stomp/README) | 0 | ||||
-rw-r--r-- | contrib/fb303/README.md (renamed from contrib/fb303/README) | 0 | ||||
-rw-r--r-- | contrib/transport-sample/README.md (renamed from contrib/transport-sample/README.txt) | 0 | ||||
-rw-r--r-- | contrib/zeromq/README.md (renamed from contrib/zeromq/README) | 0 | ||||
-rwxr-xr-x | debian/README.md (renamed from debian/README) | 0 | ||||
-rwxr-xr-x | lib/c_glib/Makefile.am | 2 | ||||
-rw-r--r-- | lib/c_glib/README.md (renamed from lib/c_glib/README) | 0 | ||||
-rw-r--r-- | lib/cocoa/README.md (renamed from lib/cocoa/README) | 0 | ||||
-rwxr-xr-x | lib/cpp/Makefile.am | 6 | ||||
-rw-r--r-- | lib/cpp/README.SSL.md (renamed from lib/cpp/README.SSL) | 0 | ||||
-rw-r--r-- | lib/cpp/README.md (renamed from lib/cpp/README) | 0 | ||||
-rw-r--r-- | lib/cpp/README_WINDOWS.md (renamed from lib/cpp/README_WINDOWS) | 0 | ||||
-rw-r--r-- | lib/csharp/README.md (renamed from lib/csharp/README) | 0 | ||||
-rw-r--r-- | lib/d/Makefile.am | 2 | ||||
-rw-r--r-- | lib/d/README.md (renamed from lib/d/README) | 0 | ||||
-rw-r--r-- | lib/delphi/test/codegen/README.md (renamed from lib/delphi/test/codegen/README.txt) | 0 | ||||
-rw-r--r-- | lib/delphi/test/skip/README.md (renamed from lib/delphi/test/skip/README.txt) | 0 | ||||
-rw-r--r-- | lib/erl/README.md (renamed from lib/erl/README) | 0 | ||||
-rw-r--r-- | lib/go/Makefile.am | 4 | ||||
-rw-r--r-- | lib/go/README.md (renamed from lib/go/README) | 0 | ||||
-rw-r--r-- | lib/hs/Makefile.am | 2 | ||||
-rw-r--r-- | lib/hs/README.md (renamed from lib/hs/README) | 0 | ||||
-rw-r--r-- | lib/java/README.md (renamed from lib/java/README) | 0 | ||||
-rw-r--r-- | lib/js/Gruntfile.js | 2 | ||||
-rw-r--r-- | lib/js/README.md (renamed from lib/js/README) | 0 | ||||
-rw-r--r-- | lib/js/test/README.md (renamed from lib/js/test/README) | 0 | ||||
-rw-r--r-- | lib/ocaml/README.md (renamed from lib/ocaml/README) | 0 | ||||
-rw-r--r-- | lib/perl/README.md (renamed from lib/perl/README) | 0 | ||||
-rwxr-xr-x | lib/php/Makefile.am | 2 | ||||
-rw-r--r-- | lib/php/README.apache.md (renamed from lib/php/README.apache) | 0 | ||||
-rw-r--r-- | lib/php/README.md (renamed from lib/php/README) | 0 | ||||
-rw-r--r-- | lib/py/README.md (renamed from lib/py/README) | 0 | ||||
-rw-r--r-- | lib/rb/README.md (renamed from lib/rb/README) | 0 | ||||
-rw-r--r-- | lib/rb/thrift.gemspec | 2 | ||||
-rw-r--r-- | lib/st/README.md (renamed from lib/st/README) | 0 | ||||
-rw-r--r-- | tutorial/README.md (renamed from tutorial/README) | 2 | ||||
-rw-r--r-- | tutorial/erl/README.md (renamed from tutorial/erl/README) | 0 | ||||
-rw-r--r-- | tutorial/java/README.md (renamed from tutorial/java/README) | 0 | ||||
-rw-r--r-- | tutorial/ocaml/README.md (renamed from tutorial/ocaml/README) | 0 |
45 files changed, 19 insertions, 17 deletions
diff --git a/Makefile.am b/Makefile.am index ec0b319e4..6bc87541d 100755 --- a/Makefile.am +++ b/Makefile.am @@ -50,4 +50,5 @@ EXTRA_DIST = \ sonar-project.properties \ LICENSE \ CHANGES \ - NOTICE + NOTICE \ + README.md @@ -1,6 +1,7 @@ Apache Thrift +============= -Last Modified: 2013-Dec-17 +Last Modified: 2014-03-16 License ======= @@ -36,7 +37,7 @@ Thrift is specifically designed to support non-atomic version changes across client and server code. For more details on Thrift's design and implementation, take a gander at -the Thrift whitepaper included in this distribution or at the README files +the Thrift whitepaper included in this distribution or at the README.md files in your particular subdirectory of interest. Hierarchy @@ -134,7 +135,7 @@ Note that some language packages must be installed manually using build tools better suited to those languages (at the time of this writing, this applies to Java, Ruby, PHP). -Look for the README file in the lib/<language>/ folder for more details on the +Look for the README.md file in the lib/<language>/ folder for more details on the installation of each language library package. Testing diff --git a/compiler/cpp/Makefile.am b/compiler/cpp/Makefile.am index 4c0e71d4b..95b78eeca 100644 --- a/compiler/cpp/Makefile.am +++ b/compiler/cpp/Makefile.am @@ -106,7 +106,7 @@ WINDOWS_DIST = \ compiler.sln \ compiler.vcxproj \ compiler.vcxproj.filters \ - README_Windows.txt + README_Windows.md EXTRA_DIST = \ $(WINDOWS_DIST) diff --git a/compiler/cpp/README b/compiler/cpp/README.md index e69de29bb..e69de29bb 100644 --- a/compiler/cpp/README +++ b/compiler/cpp/README.md diff --git a/compiler/cpp/README_Windows.txt b/compiler/cpp/README_Windows.md index a19f83d14..a19f83d14 100644 --- a/compiler/cpp/README_Windows.txt +++ b/compiler/cpp/README_Windows.md diff --git a/contrib/Rebus/README b/contrib/Rebus/README.md index bbb9c496e..bbb9c496e 100644 --- a/contrib/Rebus/README +++ b/contrib/Rebus/README.md diff --git a/contrib/Stomp/README b/contrib/Stomp/README.md index 2e5f21cbf..2e5f21cbf 100644 --- a/contrib/Stomp/README +++ b/contrib/Stomp/README.md diff --git a/contrib/fb303/README b/contrib/fb303/README.md index 8ade560c9..8ade560c9 100644 --- a/contrib/fb303/README +++ b/contrib/fb303/README.md diff --git a/contrib/transport-sample/README.txt b/contrib/transport-sample/README.md index a1dfc0a36..a1dfc0a36 100644 --- a/contrib/transport-sample/README.txt +++ b/contrib/transport-sample/README.md diff --git a/contrib/zeromq/README b/contrib/zeromq/README.md index 9e0b5bd32..9e0b5bd32 100644 --- a/contrib/zeromq/README +++ b/contrib/zeromq/README.md diff --git a/debian/README b/debian/README.md index 98d4da0c1..98d4da0c1 100755 --- a/debian/README +++ b/debian/README.md diff --git a/lib/c_glib/Makefile.am b/lib/c_glib/Makefile.am index 3244f7483..35f111495 100755 --- a/lib/c_glib/Makefile.am +++ b/lib/c_glib/Makefile.am @@ -85,7 +85,7 @@ include_processor_HEADERS = src/thrift/c_glib/processor/thrift_processor.h EXTRA_DIST = \ - README \ + README.md \ test/glib.suppress \ thrift_c_glib.pc.in diff --git a/lib/c_glib/README b/lib/c_glib/README.md index fd70d089c..fd70d089c 100644 --- a/lib/c_glib/README +++ b/lib/c_glib/README.md diff --git a/lib/cocoa/README b/lib/cocoa/README.md index bbe3c934f..bbe3c934f 100644 --- a/lib/cocoa/README +++ b/lib/cocoa/README.md diff --git a/lib/cpp/Makefile.am b/lib/cpp/Makefile.am index 7b879f376..9810745a2 100755 --- a/lib/cpp/Makefile.am +++ b/lib/cpp/Makefile.am @@ -225,7 +225,7 @@ include_qt_HEADERS = \ THRIFT = $(top_builddir)/compiler/cpp/thrift WINDOWS_DIST = \ - README_WINDOWS \ + README_WINDOWS.md \ src/thrift/windows \ thrift.sln \ libthrift.vcxproj \ @@ -234,8 +234,8 @@ WINDOWS_DIST = \ libthriftnb.vcxproj.filters EXTRA_DIST = \ - README \ - README.SSL \ + README.md \ + README.SSL.md \ thrift-nb.pc.in \ thrift.pc.in \ thrift-z.pc.in \ diff --git a/lib/cpp/README.SSL b/lib/cpp/README.SSL.md index a928057dd..a928057dd 100644 --- a/lib/cpp/README.SSL +++ b/lib/cpp/README.SSL.md diff --git a/lib/cpp/README b/lib/cpp/README.md index 576d01702..576d01702 100644 --- a/lib/cpp/README +++ b/lib/cpp/README.md diff --git a/lib/cpp/README_WINDOWS b/lib/cpp/README_WINDOWS.md index f4c887ceb..f4c887ceb 100644 --- a/lib/cpp/README_WINDOWS +++ b/lib/cpp/README_WINDOWS.md diff --git a/lib/csharp/README b/lib/csharp/README.md index b7dc5de32..b7dc5de32 100644 --- a/lib/csharp/README +++ b/lib/csharp/README.md diff --git a/lib/d/Makefile.am b/lib/d/Makefile.am index a4e3188d0..04c06393f 100644 --- a/lib/d/Makefile.am +++ b/lib/d/Makefile.am @@ -180,4 +180,4 @@ TESTS = $(addprefix unittest/debug/, $(d_test_modules)) \ EXTRA_DIST = \ src \ test \ - README + README.md diff --git a/lib/d/README b/lib/d/README.md index 5d37e4fe7..5d37e4fe7 100644 --- a/lib/d/README +++ b/lib/d/README.md diff --git a/lib/delphi/test/codegen/README.txt b/lib/delphi/test/codegen/README.md index d1447a19d..d1447a19d 100644 --- a/lib/delphi/test/codegen/README.txt +++ b/lib/delphi/test/codegen/README.md diff --git a/lib/delphi/test/skip/README.txt b/lib/delphi/test/skip/README.md index 90d5ff510..90d5ff510 100644 --- a/lib/delphi/test/skip/README.txt +++ b/lib/delphi/test/skip/README.md diff --git a/lib/erl/README b/lib/erl/README.md index d7080da13..d7080da13 100644 --- a/lib/erl/README +++ b/lib/erl/README.md diff --git a/lib/go/Makefile.am b/lib/go/Makefile.am index efb58be60..bb386cf48 100644 --- a/lib/go/Makefile.am +++ b/lib/go/Makefile.am @@ -24,7 +24,7 @@ endif install: @echo '##############################################################' @echo '##############################################################' - @echo 'The Go client library should be installed via "go get", please see /lib/go/README' + @echo 'The Go client library should be installed via "go get", please see /lib/go/README.md' @echo '##############################################################' @echo '##############################################################' @@ -34,4 +34,4 @@ check-local: all-local: check-local EXTRA_DIST = \ - thrift
\ No newline at end of file + thrift diff --git a/lib/go/README b/lib/go/README.md index 87ba6f903..87ba6f903 100644 --- a/lib/go/README +++ b/lib/go/README.md diff --git a/lib/hs/Makefile.am b/lib/hs/Makefile.am index 3db1df914..70c51c73b 100644 --- a/lib/hs/Makefile.am +++ b/lib/hs/Makefile.am @@ -19,7 +19,7 @@ EXTRA_DIST = \ LICENSE \ - README \ + README.md \ Setup.lhs \ TODO \ Thrift.cabal \ diff --git a/lib/hs/README b/lib/hs/README.md index fe525bd86..fe525bd86 100644 --- a/lib/hs/README +++ b/lib/hs/README.md diff --git a/lib/java/README b/lib/java/README.md index 12b3afe15..12b3afe15 100644 --- a/lib/java/README +++ b/lib/java/README.md diff --git a/lib/js/Gruntfile.js b/lib/js/Gruntfile.js index 321063f4c..3298d5cf2 100644 --- a/lib/js/Gruntfile.js +++ b/lib/js/Gruntfile.js @@ -20,7 +20,7 @@ module.exports = function(grunt) { }, jsdoc : { dist : { - src: ['src/*.js', './README'], + src: ['src/*.js', './README.md'], options: { destination: 'doc' } diff --git a/lib/js/README b/lib/js/README.md index bb650503f..bb650503f 100644 --- a/lib/js/README +++ b/lib/js/README.md diff --git a/lib/js/test/README b/lib/js/test/README.md index 9ad140edb..9ad140edb 100644 --- a/lib/js/test/README +++ b/lib/js/test/README.md diff --git a/lib/ocaml/README b/lib/ocaml/README.md index 5a47a4247..5a47a4247 100644 --- a/lib/ocaml/README +++ b/lib/ocaml/README.md diff --git a/lib/perl/README b/lib/perl/README.md index 691488b47..691488b47 100644 --- a/lib/perl/README +++ b/lib/perl/README.md diff --git a/lib/php/Makefile.am b/lib/php/Makefile.am index 927de9805..2b6b5fa97 100755 --- a/lib/php/Makefile.am +++ b/lib/php/Makefile.am @@ -119,7 +119,7 @@ EXTRA_DIST = \ src/Thrift.php \ src/TStringUtils.php \ thrift_protocol.ini \ - README.apache + README.apache.md MAINTAINERCLEANFILES = \ Makefile \ diff --git a/lib/php/README.apache b/lib/php/README.apache.md index 5e9258975..5e9258975 100644 --- a/lib/php/README.apache +++ b/lib/php/README.apache.md diff --git a/lib/php/README b/lib/php/README.md index c24ee2c0c..c24ee2c0c 100644 --- a/lib/php/README +++ b/lib/php/README.md diff --git a/lib/py/README b/lib/py/README.md index 29b8c73c4..29b8c73c4 100644 --- a/lib/py/README +++ b/lib/py/README.md diff --git a/lib/rb/README b/lib/rb/README.md index b6e9a0792..b6e9a0792 100644 --- a/lib/rb/README +++ b/lib/rb/README.md diff --git a/lib/rb/thrift.gemspec b/lib/rb/thrift.gemspec index a91ea07c9..43e5a7f6b 100644 --- a/lib/rb/thrift.gemspec +++ b/lib/rb/thrift.gemspec @@ -23,7 +23,7 @@ Gem::Specification.new do |s| s.test_files = Dir.glob("{test,spec,benchmark}/**/*") s.executables = Dir.glob("{bin}/**/*") - s.extra_rdoc_files = %w[README] + Dir.glob("{ext,lib}/**/*.{c,h,rb}") + s.extra_rdoc_files = %w[README.md] + Dir.glob("{ext,lib}/**/*.{c,h,rb}") s.require_paths = %w[lib ext] diff --git a/lib/st/README b/lib/st/README.md index 5b5fdeefc..5b5fdeefc 100644 --- a/lib/st/README +++ b/lib/st/README.md diff --git a/tutorial/README b/tutorial/README.md index a29f977b0..7772bf3e6 100644 --- a/tutorial/README +++ b/tutorial/README.md @@ -25,7 +25,7 @@ Tutorial 1) First things first, you'll need to install the Thrift compiler and the language libraries. Do that using the instructions in the top level - README file. + README.md file. 2) Read tutorial.thrift to learn about the syntax of a Thrift file diff --git a/tutorial/erl/README b/tutorial/erl/README.md index 9d17cd0c5..9d17cd0c5 100644 --- a/tutorial/erl/README +++ b/tutorial/erl/README.md diff --git a/tutorial/java/README b/tutorial/java/README.md index c0811f7f2..c0811f7f2 100644 --- a/tutorial/java/README +++ b/tutorial/java/README.md diff --git a/tutorial/ocaml/README b/tutorial/ocaml/README.md index f68e83525..f68e83525 100644 --- a/tutorial/ocaml/README +++ b/tutorial/ocaml/README.md |