Projects/KDevelop4/Ruby - Revision history

Mssola at 10:49, 12 October 2012

2012-10-12T10:49:40Z

2012-10-12T10:49:03Z

‎Testing using Guard

2012-10-12T09:54:18Z

‎Testing manually

2012-10-07T17:08:43Z

2012-10-07T17:07:45Z

‎Testing

2012-10-07T16:19:20Z

‎How to compile

2012-10-07T16:19:02Z

‎How to compile

2012-10-07T16:16:39Z

‎Generating the documentation

2012-10-07T16:16:10Z

‎Generating the documentation

2012-10-06T20:41:56Z

‎How to compile

← Older revision		Revision as of 10:49, 12 October 2012
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
−	~~{{Remember\|2=Important\|1=Hi there! I'm sorry to tell you that this page is still under construction. The responsible for this mess is Miquel (mssola on IRC).}}~~

	= How to compile =		= How to compile =

@@ Line 34: / Line 34: @@
 === Testing using Guard ===
-To do.
+All this process can be automated by using the guard gem. Note that there is a Gemfile in the source code of this plugin. So, to get guard and its dependencies, you may want to run the <code>bundle</code> command. And finally, in the root of the source tree you will have to execute the following command:
 = Generating the documentation =

@@ Line 22: / Line 22: @@
 === Testing manually ===
-To do.
+First of all, go to your build directory, all the testing has to be done in this directory. Now, there are two mechanisms to test this plugin: RSpec and QtTest. RSpec is used to test the parser, and QtTest to test everything else. If you want to test the parser, you'll have to run the following commands:
 === Testing using Guard ===

← Older revision		Revision as of 17:08, 7 October 2012
Line 1:		Line 1:
		+	__NOTOC__
	{{Remember\|2=Important\|1=Hi there! I'm sorry to tell you that this page is still under construction. The responsible for this mess is Miquel (mssola on IRC).}}		{{Remember\|2=Important\|1=Hi there! I'm sorry to tell you that this page is still under construction. The responsible for this mess is Miquel (mssola on IRC).}}

@@ Line 3: / Line 3: @@
 = How to compile =
-First of all, you need to compile KDevelop and KDevPlatform. There're instructions on how to do this here: [[KDevelop4/HowToCompile]]. If you have succeeded in installing KDevelop and KDevPlatform, you can install the Ruby plugin in pretty much the same way. First, download the source code:
+First of all, you need to compile KDevelop and KDevPlatform. There are instructions on how to do this here: [[KDevelop4/HowToCompile]]. If you have succeeded in installing KDevelop and KDevPlatform, you can install the Ruby plugin in pretty much the same way. First, download the source code:
      git clone git://anongit.kde.org/kdev-ruby

← Older revision		Revision as of 16:16, 7 October 2012
Line 33:		Line 33:
	ruby kdevruby_doc.rb /absolute/path/to/the/ruby/source/code builtins.rb		ruby kdevruby_doc.rb /absolute/path/to/the/ruby/source/code builtins.rb

−	Note that this process can take a while. After this, ~~the~~ we'll have a brand new builtins.rb file.	+	Note that this process can take a while. After this, we'll have a brand new builtins.rb file.

← Older revision		Revision as of 16:16, 7 October 2012
Line 23:		Line 23:
	= Generating the documentation =		= Generating the documentation =

−	~~To do~~.	+	This plugin needs to have a file with all the Ruby built-in modules, classes, constants, etc. This file is called builtins.rb and you can find it in the documentation/ directory. This file will always be available, but if you want to generate it again, you have to follow some simple steps. First of all, you need to get the Ruby source code (the MRI implementation). You can download it [http://www.ruby-lang.org/en/downloads/ here] or, alternatively, you can use svn or git like this:
		+
		+	svn co http://svn.ruby-lang.org/repos/ruby/trunk ruby
		+	git clone https://github.com/ruby/ruby.git
		+
		+	This is a necessary step because the documentation/kdevruby_doc.rb script needs the path of the Ruby source code as the first parameter. The second parameter to be passed to this script will be the name of the output file. Therefore, to generate the builtins.rb file we just have to execute:
		+
		+	cd documentation
		+	ruby kdevruby_doc.rb /absolute/path/to/the/ruby/source/code builtins.rb
		+
		+	Note that this process can take a while. After this, the we'll have a brand new builtins.rb file.

@@ Line 7: / Line 7: @@
      git clone git://anongit.kde.org/kdev-ruby
-Then you will compile it by doing the following:
+Then you can compile it by doing the following:
      mkdir build