llvm dev - Feb 2010 - [LLVMdev] Changes in FunctionPassManager constructor

>> Also note that the documentation is unintentionally misleading.
It's very confusing for http://llvm.org/docs/tutorial/LangImpl4.html to show
"Last modified: $Date: 2007-10-17 11:05:13 -0700 (Wed, 17 Oct 2007) $"
at the bottom, as if nothing had changed since then, when the code it displays
is actually less than a week old... I guess the source code snippets are updated
automagically. As a result, the code shown there as an example will NOT compile
on anything but a most recent LLVM, i.e. it will not work if you install LLVM
with apt-get or MacPorts. I don't think that's desirable.
> 
> That's the docs for trunk; to get docs for a specific release, try,
> for example, http://llvm.org/releases/2.6/docs/tutorial/LangImpl4.html
These are the docs I get by default if I click on "documentation" then
"Tutorial" then ... or if I use Google. How is a poor schmuck trying
to build his first LLVM tool supposed to figure out that the documentation is
not "the right one"?

Christophe

On Wed, Feb 3, 2010 at 9:34 AM, Christophe de Dinechin
<christophe at taodyne.com> wrote:
>
>>> Also note that the documentation is unintentionally misleading.
It's very confusing for http://llvm.org/docs/tutorial/LangImpl4.html to show
"Last modified: $Date: 2007-10-17 11:05:13 -0700 (Wed, 17 Oct 2007) $"
at the bottom, as if nothing had changed since then, when the code it displays
is actually less than a week old... I guess the source code snippets are updated
automagically. As a result, the code shown there as an example will NOT compile
on anything but a most recent LLVM, i.e. it will not work if you install LLVM
with apt-get or MacPorts. I don't think that's desirable.
>>
>> That's the docs for trunk; to get docs for a specific release, try,
>> for example, http://llvm.org/releases/2.6/docs/tutorial/LangImpl4.html
>
> These are the docs I get by default if I click on "documentation"
then "Tutorial" then ... or if I use Google. How is a poor schmuck
trying to build his first LLVM tool supposed to figure out that the
documentation is not "the right one"?
>
Yep. I just added a warning like this to
http://llvm.org/docs/ReleaseNotes.html, but we should have one on the
top-level documentation. And quite possibly, the main website link
should be to the most recent release's documentation rather than to
trunk's documentation. I'll write a patch for the first problem.
Someone with cvs access will need to fix the website.

On Wed, Feb 3, 2010 at 9:55 AM, Jeffrey Yasskin <jyasskin at google.com>
wrote:
> On Wed, Feb 3, 2010 at 9:34 AM, Christophe de Dinechin
> <christophe at taodyne.com> wrote:
>>
>>>> Also note that the documentation is unintentionally misleading.
It's very confusing for http://llvm.org/docs/tutorial/LangImpl4.html to show
"Last modified: $Date: 2007-10-17 11:05:13 -0700 (Wed, 17 Oct 2007) $"
at the bottom, as if nothing had changed since then, when the code it displays
is actually less than a week old... I guess the source code snippets are updated
automagically. As a result, the code shown there as an example will NOT compile
on anything but a most recent LLVM, i.e. it will not work if you install LLVM
with apt-get or MacPorts. I don't think that's desirable.
>>>
>>> That's the docs for trunk; to get docs for a specific release,
try,
>>> for example,
http://llvm.org/releases/2.6/docs/tutorial/LangImpl4.html
>>
>> These are the docs I get by default if I click on
"documentation" then "Tutorial" then ... or if I use Google.
How is a poor schmuck trying to build his first LLVM tool supposed to figure out
that the documentation is not "the right one"?
>>
>
> Yep. I just added a warning like this to
> http://llvm.org/docs/ReleaseNotes.html, but we should have one on the
> top-level documentation. And quite possibly, the main website link
> should be to the most recent release's documentation rather than to
> trunk's documentation. I'll write a patch for the first problem.
> Someone with cvs access will need to fix the website.
This patch is in: http://llvm.org/docs/. Hopefully fewer people will
get confused about what version of the docs they're reading now.