You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2013/07/11 20:37:57 UTC
docs commit: [CB-4138] Updated Readme for deps. on ruby 1.8.7 and
nokogiri 1.5.2
Updated Branches:
refs/heads/master 8b7d6042f -> 8d59aba98
[CB-4138] Updated Readme for deps. on ruby 1.8.7 and nokogiri 1.5.2
Project: http://git-wip-us.apache.org/repos/asf/cordova-docs/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-docs/commit/8d59aba9
Tree: http://git-wip-us.apache.org/repos/asf/cordova-docs/tree/8d59aba9
Diff: http://git-wip-us.apache.org/repos/asf/cordova-docs/diff/8d59aba9
Branch: refs/heads/master
Commit: 8d59aba982881a9cdb82052b08cc8da84c5c2afd
Parents: 8b7d604
Author: Carlos Santana <cs...@gmail.com>
Authored: Tue Jul 9 17:35:08 2013 -0400
Committer: Andrew Grieve <ag...@chromium.org>
Committed: Thu Jul 11 14:37:36 2013 -0400
----------------------------------------------------------------------
Gemfile | 22 ++++++++++++++++++++++
Gemfile.lock | 12 ++++++++++++
README.md | 22 ++++++++++++++++++----
3 files changed, 52 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/8d59aba9/Gemfile
----------------------------------------------------------------------
diff --git a/Gemfile b/Gemfile
new file mode 100644
index 0000000..e385e61
--- /dev/null
+++ b/Gemfile
@@ -0,0 +1,22 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+source "https://rubygems.org"
+
+ruby '1.8.7'
+gem 'nokogiri', '1.5.2'
+gem 'json'
+
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/8d59aba9/Gemfile.lock
----------------------------------------------------------------------
diff --git a/Gemfile.lock b/Gemfile.lock
new file mode 100644
index 0000000..b56940a
--- /dev/null
+++ b/Gemfile.lock
@@ -0,0 +1,12 @@
+GEM
+ remote: https://rubygems.org/
+ specs:
+ json (1.8.0)
+ nokogiri (1.5.2)
+
+PLATFORMS
+ ruby
+
+DEPENDENCIES
+ json
+ nokogiri (= 1.5.2)
http://git-wip-us.apache.org/repos/asf/cordova-docs/blob/8d59aba9/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index dc736e4..c456eab 100644
--- a/README.md
+++ b/README.md
@@ -102,13 +102,13 @@ Currently, a Ruby script and [joDoc](http://github.com/davebalmer/jodoc) are use
- Clone [joDoc](http://github.com/davebalmer/jodoc)
git clone http://github.com/davebalmer/joDoc.git
-
+
- Add joDoc/ to your path
-
+
Open `~/.bashrc` or `~/.profile` (or whatever you use)
export PATH=$PATH:~/path/to/joDoc/
-
+
- Install markdown
# Use your package manager
@@ -131,7 +131,7 @@ If all you want to generate is edge/English, then
bin/generate --edge
### Problems
-
+
Generated a Version Release
---------------------------
@@ -164,3 +164,17 @@ You may need to add the following line to the joDoc script:
For more details, see the [Issue #590](https://issues.apache.org/jira/browse/CB-590).
+### Error with ruby and nokogiri versions
+
+If you get the following error:
+
+ custom_require.rb:36:in `require': /lib/cordova/jodoc.rb:28: syntax error, unexpected tCONSTANT, expecting ']' (SyntaxError)
+ @template_directories = [ File.join TEMPLATE_PATH, 'default' ]
+ ^
+- You may need to downgrade the version of ruby to 1.8.7 and nokogiri to 1.5.2
+ Use rvm and the Gemfile provided to install the dependencies
+
+ rvm install 1.8.7
+ rvm use 1.8.7
+ bundle install
+