Menu
▾
▴
avr-llvm-devel
|
From: Josef E. <za...@za...> - 2009-11-29 14:59:22
|
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
|
|
From: John M. <ato...@gm...> - 2009-11-29 18:38:45
|
I vote for using varient1. sourceforge has hosted apps like MediaWiki which could be used for documentation. I've never used any of them so I don't know if it would be any easier/better to use. On Sun, Nov 29, 2009 at 6:59 AM, Josef Eisl <za...@za...> 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 > |
|
From: Josef E. <za...@za...> - 2009-11-30 13:24:35
|
John Myers wrote: > I vote for using varient1. > sourceforge has hosted apps like MediaWiki which could be used for > documentation. > I've never used any of them so I don't know if it would be any > easier/better to use. I also thought about a wiki software (actually about Trac..) but I rejected that idea: *) If we use a wiki the documentation is not distributed with the source code. So we would need to write some basic instructions e.g. a README and that would be redundant. *) If the documentations uses a different system that the source it is very likely to forget to edit the docs (e.g. if a new patch is added, path were changed, etc.) *) LLVM uses HTML so migration would be easier. *) With HTML files we are independent from sourceforge. *) I believe most of us know some basic HTML constructs. With a wiki we would need to learn new formating syntax. Although wikis are great software but as long as our user base is pretty much the same as our developer base I think we are better off with html. > > On Sun, Nov 29, 2009 at 6:59 AM, Josef Eisl <za...@za...> 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... > <mailto:avr...@li...> > https://lists.sourceforge.net/lists/listinfo/avr-llvm-devel > > |
|
From: Weddington, E. <Eri...@at...> - 2009-11-30 02:34:17
|
Regarding directory structure: I'm not attached to any particular structure. However, I would like to make sure that we make it easy on ourselves when we merge upstream to LLVM. I trust that you'll make the right decisions regarding the structure. So just feel free to make the changes as you see fit. 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. Thanks for taking the time to do all of this. It's really appreciated. Eric > -----Original Message----- > From: Josef Eisl [mailto:za...@za...] > Sent: Sunday, November 29, 2009 7:59 AM > To: avr...@li... > Subject: [avr-llvm-devel] new directory structure and > documentationsuggestion [RFC] > > 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 > |
|
From: Josef E. <za...@za...> - 2009-12-01 15:55:54
Attachments:
avr-llvm-docs.tar.gz
|
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 |
|
From: Weddington, E. <Eri...@at...> - 2009-12-01 16:12:15
|
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 > |
|
From: Josef E. <za...@za...> - 2009-12-01 23:40:42
|
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 |
|
From: Josef E. <za...@za...> - 2009-12-02 21:24:33
|
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 > |
×
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X