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

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

Weddington, Eric wrote:
> 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!

Thanks for the input. I've committed the updated files to trunk/docs.
Lets try to keep these docs up-to-date (patches, etc.).

Josef