Re: [avr-llvm-devel] new directory structure and documentation suggestion [RFC]

[Josef E. <za...@za...>]

FYI: directory structure changed according to variant 1 with one
exception: the docs folder is located in llvm/trunk/docs not
website/trunk/docs. website/trunk/docs is not used anymore in the llvm
repo and will be removed in the future.

Josef

Josef Eisl wrote:
> Hello,
> 
> I would like to suggest another change (hopefully the last one) to our
> svn structure.
> 
> Sooner or later we will need do customize either the llvm-gcc or the
> clang front-end (or both) and I think we should prepare the svn
> structure now. The new structure should be similar to the llvm svn
> repository to make things easier.
> 
> Variant 1: just move the current structure into a new llvm subfolder and
> create folders for the front-ends.
> 
> variant1
> |-- cfe
> |   |-- branches
> |   |-- tags
> |   `-- trunk
> |-- llvm
> |   |-- branches
> |   |-- tags
> |   `-- trunk
> |       |-- AVR
> |       |-- patches
> |       `-- testcases
> |-- llvm-gcc-4.2
> |   |-- branches
> |   |-- tags
> |   `-- trunk
> `-- website
>     |-- branches
>     |-- tags
>     `-- trunk
>         `-- docs
> 
> The second variant is very similar but the AVR folder is moved to
> trunk/lib/Target/AVR. The path is getting a little bit longer but it is
> more obvious where the AVR folder fits in into the llvm source tree.
> 
> variant2
> |-- cfe
> |   |-- branches
> |   |-- tags
> |   `-- trunk
> |-- llvm
> |   |-- branches
> |   |-- tags
> |   `-- trunk
> |       |-- lib
> |       |   `-- Target
> |       |       `-- AVR
> |       |-- patches
> |       `-- testcases
> |-- llvm-gcc-4.2
> |   |-- branches
> |   |-- tags
> |   `-- trunk
> `-- website
>     |-- branches
>     |-- tags
>     `-- trunk
>         `-- docs
> 
> 
> The other idea is about documentation. Like in LLVM we could create a
> website folder and use html files for documentation and maybe put them
> on http://avr-llvm.sourceforge.net.
> I am thinking of docs about:
> 
> - Getting Started: how to prepare the llvm source tree and compile llvm
> with avr support
> - Developer Guide: Commit rules, Coding Standards, etc
> - Testing: test cases, test framework, etc
> 
> And maybe a front page with links to the ML and the other documents.
> 
> I've some early drafts for these documents and will post the for
> discussion if we decide to go this way.
> 
> All comments are very welcome.
> 
> BR
> Josef
> 
> ------------------------------------------------------------------------------
> Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day 
> trial. Simplify your report design, integration and deployment - and focus on 
> what you do best, core application coding. Discover what's new with
> Crystal Reports now.  http://p.sf.net/sfu/bobj-july
> _______________________________________________
> avr-llvm-devel mailing list
> avr...@li...
> https://lists.sourceforge.net/lists/listinfo/avr-llvm-devel
>