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

[Weddington, E. <Eri...@at...>]

Excellent!

I'm good with the Coding Standards.

I have two small suggestions for the Commit Guidelines:

- There is this line:
$ patch -p0 < ../avr-llvm/trunk/patches/XXX.diff  # apply patches
Can we explicitly list the patch files? Like what is done in the "Getting Started" section. I always worry when I see stuff like "XXX" and it is not explained anywhere what that means.

- Small nit on English. This sentence:
"If the working copy does not compile the changes must be in repository for any reason whatsoever I suggest creating a branch, ..."
Should be:
"If the working copy does not compile and the changes must be in repository for any reason whatsoever, then we suggest creating a branch, ..."
Note that the "I" is changed to "we" because we are speaking as a group of developers for any newcomers to development.

Other than those two small things, it all looks great!

Now I need to go actually try and build the tools... ;-)

Eric Weddington

> -----Original Message-----
> From: Josef Eisl [mailto:za...@za...] 
> Sent: Tuesday, December 01, 2009 8:56 AM
> To: Weddington, Eric
> Cc: avr...@li...
> Subject: Re: [avr-llvm-devel] new directory structure and 
> documentationsuggestion [RFC]
> 
> Weddington, Eric wrote:
> > Regarding documentation: Again, I'm not attached to any 
> particular layout or method. I do think that you should post 
> your early drafts; they don't have to be perfect in order to 
> have something that we can all work with. My only 
> recommendation is to not spend a whole lot of time on the 
> formatting of the documentation. Most of our documentation 
> should be eventually migrated upstream to the LLVM project.
> 
> I've attached an archive with my drafts for a Getting Started and a
> Development Guidelines document.
> 
> The content is up for discussion.
> 
> Josef
>