# Problem creating appdoc documentation

**URL:** <https://www.ruby-forum.com/t/problem-creating-appdoc-documentation/53871>\
**Category:** Rails\
**Created:** [February 15, 2006, 7:17pm UTC](https://www.ruby-forum.com/t/problem-creating-appdoc-documentation/53871 "2006-02-15T19:17:27Z")\
**Posts on this page:** 6\
**Page:** 1

<div class="post-metadata">

**Author:** ![Radek\_Hnilica](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/8dc957/32.png) [@Radek\_Hnilica](https://www.ruby-forum.com/u/Radek_Hnilica)\
**Post date:** [February 15, 2006, 7:17pm UTC](https://www.ruby-forum.com/t/problem-creating-appdoc-documentation/53871/1 "2006-02-15T19:17:27Z")

</div>

Hello, can anyone help me.

After a few weeks I returned to the rails to play with it. But I  
recognize that I’m now not abble to build appdoc. The same thing that  
few weeks ago worked without an problem now give me an error:  
unrecognized option `–line-numbers --inline-source’

$ rake --trace --verbose reappdoc  
(in /home/radek/src/firma/giga-net/ncc/work)  
\*\* Invoke reappdoc (first\_time)  
\*\* Invoke clobber\_appdoc (first\_time)  
\*\* Execute clobber\_appdoc  
rm -r doc/app  
rm -r doc/app  
\*\* Invoke appdoc (first\_time)  
\*\* Invoke doc/app/index.html (first\_time)  
\*\* Invoke doc/README\_FOR\_APP (first\_time, not\_needed)  
\*\* Invoke app/controllers/application.rb (first\_time, not\_needed)  
\*\* Invoke app/helpers/application\_helper.rb (first\_time, not\_needed)  
\*\* Invoke Rakefile (first\_time, not\_needed)  
\*\* Invoke TODO.rd (first\_time, not\_needed)  
\*\* Execute doc/app/index.html  
rm -r doc/app

unrecognized option `–line-numbers --inline-source’

For help on options, try ‘rdoc --help’

rake aborted!  
exit

The appdoc.rake file:  
desc “Generate documentation for the application”  
Rake::RDocTask.new(“appdoc”) { |rdoc|  
rdoc.rdoc\_dir = ‘doc/app’  
rdoc.title = “NCC Application Documentation”  
rdoc.options \<\< ‘–line-numbers --inline-source -c iso-8859-2’  
rdoc.rdoc\_files.include(‘doc/README\_FOR\_APP’)  
rdoc.rdoc\_files.include(‘app/\*\*/_.rb’)  
rdoc.rdoc\_files.include('doc/_.rd’)  
rdoc.rdoc\_files.include(‘\*.rd’)  
}

# – Radek Hnilica [http://www.hnilica.cz](http://www.hnilica.cz)

No matter how far down the wrong road you’ve gone, turn back.  
Turkish proverb  
… so turn back … Now!

---

<div class="post-metadata">

**Author:** ![Radek\_Hnilica](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/8dc957/32.png) [@Radek\_Hnilica](https://www.ruby-forum.com/u/Radek_Hnilica)\
**Post date:** [February 15, 2006, 9:21pm UTC](https://www.ruby-forum.com/t/problem-creating-appdoc-documentation/53871/2 "2006-02-15T21:21:54Z")

</div>

I’m having the exact same problem with my rails environment running on  
OS X 10.4

---

<div class="post-metadata">

**Author:** ![Radek\_Hnilica](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/8dc957/32.png) [@Radek\_Hnilica](https://www.ruby-forum.com/u/Radek_Hnilica)\
**Post date:** [February 16, 2006, 12:30am UTC](https://www.ruby-forum.com/t/problem-creating-appdoc-documentation/53871/3 "2006-02-16T00:30:41Z")

</div>

As did I. I changed the line in /vendor/rails/railties/lib/tasks/  
documentation.rake from rdoc.options \<\< ‘–line-numbers --inline-  
source’ (or similar) to rdoc.options \<\< ‘-SN’.

---

<div class="post-metadata">

**Author:** ![Radek\_Hnilica](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/8dc957/32.png) [@Radek\_Hnilica](https://www.ruby-forum.com/u/Radek_Hnilica)\
**Post date:** [February 16, 2006, 2:06pm UTC](https://www.ruby-forum.com/t/problem-creating-appdoc-documentation/53871/4 "2006-02-16T14:06:06Z")

</div>

Radek Hnilica wrote:

> After a few weeks I returned to the rails to play with it. But I  
> recognize that I’m now not abble to build appdoc. The same thing that  
> few weeks ago worked without an problem now give me an error:  
> unrecognized option `–line-numbers --inline-source’

This is a known bug, with a patch available:  
[http://dev.rubyonrails.org/ticket/3757](http://dev.rubyonrails.org/ticket/3757)

As a workaround you can simply copy the line that rake outputs and run  
it manually.

---

<div class="post-metadata">

**Author:** ![Radek\_Hnilica](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/8dc957/32.png) [@Radek\_Hnilica](https://www.ruby-forum.com/u/Radek_Hnilica)\
**Post date:** [February 16, 2006, 9:46am UTC](https://www.ruby-forum.com/t/problem-creating-appdoc-documentation/53871/5 "2006-02-16T09:46:17Z")

</div>

On Wed, Feb 15, 2006 at 11:30:10PM +0000, Oliver L. wrote:

> As did I. I changed the line in /vendor/rails/railties/lib/tasks/  
> documentation.rake from rdoc.options \<\< ‘–line-numbers --inline-  
> source’ (or similar) to rdoc.options \<\< ‘-SN’.

Ok, I try to modify the rails gem in place and recognize that I do not  
underestand anything.

yoda:/usr/lib/ruby/gems/1.8/gems/rails-1.0.0/lib/tasks# diff -u  
documentation.rake.orig documentation.rake  
yoda:/usr/lib/ruby/gems/1.8/gems/rails-1.0.0/lib/tasks# diff -u  
documentation.rake.orig documentation.rake  
— documentation.rake.orig 2006-02-16 09:01:23.000000000 +0100  
+++ documentation.rake 2006-02-16 09:16:43.000000000 +0100  
@@ -2,7 +2,7 @@  
Rake::RDocTask.new(“appdoc”) { |rdoc|  
rdoc.rdoc\_dir = ‘doc/app’  
rdoc.title = “Rails Application Documentation”

- rdoc.options \<\< ‘–line-numbers --inline-source’

- rdoc.options \<\< ‘-SN’  
rdoc.rdoc\_files.include(‘doc/README\_FOR\_APP’)  
rdoc.rdoc\_files.include(‘app/\*\*/\*.rb’)  
}

After this modification, my thinks still do not work. Yes, I can  
build my documentation but not properly.

I think, there is something in rake, that adds ‘–’ in options which  
stopped me adding my own options.

My lib/tasks/appdoc.rake file:  
desc “Generate documentation for the application”  
Rake::RDocTask.new(“appdoc”) { |rdoc|  
rdoc.rdoc\_dir = ‘doc/app’  
rdoc.title = “NCC Application Documentation”  
rdoc.options \<\< ’ -c iso-8859-2’ # ← this do not work  
rdoc.rdoc\_files.include(‘doc/README\_FOR\_APP’)  
rdoc.rdoc\_files.include(‘app/\*\*/_.rb’)  
rdoc.rdoc\_files.include('doc/_.rd’)  
rdoc.rdoc\_files.include(‘\*.rd’)  
}  
#EOF

I got:  
File not found: -c iso-8859-2  
rake aborted!  
exit

# – Radek Hnilica \<Radek.Hnilica at Moraviapress dot CZ\> \<Radek.Hnilica at Giga-NET dot CZ [http://www.hnilica.cz](http://www.hnilica.cz)

No matter how far down the wrong road you’ve gone, turn back.  
Turkish proverb  
… so turn back … Now!

---

<div class="post-metadata">

**Author:** ![Radek\_Hnilica](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/8dc957/32.png) [@Radek\_Hnilica](https://www.ruby-forum.com/u/Radek_Hnilica)\
**Post date:** [February 16, 2006, 2:27pm UTC](https://www.ruby-forum.com/t/problem-creating-appdoc-documentation/53871/6 "2006-02-16T14:27:23Z")

</div>

On Thu, Feb 16, 2006 at 02:05:07PM +0100, Jakob S. wrote:

> This is a known bug, with a patch available:  
> [http://dev.rubyonrails.org/ticket/3757](http://dev.rubyonrails.org/ticket/3757)
> 
> As a workaround you can simply copy the line that rake outputs and run  
> it manually.

Thanks, this was very helpfull. I patch the rails and use the patch  
as a guideline to modify my own task. Now it works like I need it,  
including my own options.

# – Radek Hnilica [http://www.hnilica.cz](http://www.hnilica.cz)

No matter how far down the wrong road you’ve gone, turn back.  
Turkish proverb  
… so turn back … Now!