[LLVMdev] Creating an LLVM Project

[John Criswell]

Dan Gohman wrote:
> On Jan 3, 2009, at 10:20 AM, Martin Geisse wrote:
>   
>> 2. The line
>>
>> AutoRegen.sh
>>
>> ("Create a Project from the Sample Project", step 5) should be
>> changed to
>>
>> ./AutoRegen.sh
>>
>> so it will work if . is not in the path.
>>     
>
> Fixed.
>
>   
>> 3. In "Create a Project from the Sample Project", step 6 the
>> arguments are used to "tell your project where the LLVM source/object
>> tree is located. The tutorial doesn't really give a good hint which
>> directory is meant. For example, the source is located partly in the
>> lib/ and partly in the tools/ subdirectory of the main llvm
>> directory. It might also refer to the main llvm directory, but the
>> simple fact that the source and object directories - which are both
>> within the main llvm directory -- must be specified separately
>> suggests that this is not the case. In general, it left me (and
>> probably others) clueless which path to specify.
>>     
>
> It seems pretty intuitive to people already familiar with
> autoconf-style srcdir!=objdir builds. Can you sugggest a
> better wording?
>   
Hrm.  The projects document assumes that the reader is already familiar
with other LLVM build system issues.  It would be better if that were
clarified.

I suppose we could do one of two things:

1) Point back to the Getting Started Guide where srcdir and objdir are
more clearly defined.
2) Add a note in the beginning of the document explaining what
prerequisite material is needed and where to read it.

Thoughts on which would be better?  Is the srcdir/objdir issue the only
unclear bit in that document?

-- John T.


> Thanks,
>
> Dan
>
> _______________________________________________
> LLVM Developers mailing list
> LLVMdev at cs.uiuc.edu         http://llvm.cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
>