MobileRead Forums - View Single Post

jharker · 11-17-2008, 12:16 AM

Today I finished uploading the source code and other resources to the iLiad OS svn server, hosted from the MobileRead Dev Hub.

You can browse the SVN repository via the Trac (https://dev.mobileread.com/trac/iliados/browser) or SVN (https://dev.mobileread.com/svn/iliados/) source browsers.

Note that these are very plain ways to browse the code. If you want to browse the code to learn about its structure, use Hansel's web site (http://iliad.hpelbers.org/), which uses dOxygen to provide more information and analysis of classes etc.

I spent quite a while trying to figure out a good structure for the tree. Here's what I finally came up with:

tags - standard SVN tags folder
branches - standard SVN branches folder
upstream - source codes for all externally maintained utilities and libraries (busybox, X, etc.)
trunk - all iLiad-specific files
- filesystem - This will always hold a copy of the current development filesystem.
  - /usr
  - /bin
  - /home
  - and so on...
- src - Source code for all iRex-supplied iLiad-specific programs and libraries
  - connectionMgr
  - contentLister
  - displayMgr
  - etc....
- kernel - kernel and iRex modules
  - iRex - sources for iRex kernel modules
  - linux-2.4.19 - kernel source for iLiad, with all patches applied including the latest (v2.11)

I would welcome any comments or suggestions about ways to improve this structure.

The entire repository is very large, as it necessarily includes complete kernel source code (>100MB!) and the sources for several very large upstream libraries.

Anyone can check out a copy from the SVN server. You don't need to be registered or anything. I recommend only taking out a specific folder, not the whole trunk. For example, if you want to work on the ContentLister, you can get a copy of the latest source code with the command:

Code:

svn co https://dev.mobileread.com:8080/svn/iliados/trunk/src/contentLister

For the moment, I would like all proposed patches to be funneled through either myself or Adam, and we will review and test them before including them in SVN. Please submit patches for any issue or feature! Of course, we'll be giving priority to changes that come early in the roadmap, but you should submit anything you've got working. Please try to submit good patches with clean code and no bugs... you know the drill.

I'll write more later. Tomorrow evening I plan to add the formal roadmap to Trac, along with a number of new tickets covering all the roadmap goals. Then interested folks can take ownership for tickets they're interested in, and can submit patches for specific tickets, etc. I also plan to add some wiki pages covering how to set up the toolchains, how to compile things, guidelines for submissions, and more about how to use (and administer) the SVN server.

That's it for now... Comments, questions, suggestions, critiques?

11-17-2008, 12:16 AM	#18
jharker Developer Posts: 345 Karma: 3473 Join Date: Apr 2007 Location: Brooklyn, NY, USA Device: iRex iLiad v1, Blackberry Tour, Kindle DX, iPad.	Today I finished uploading the source code and other resources to the iLiad OS svn server, hosted from the MobileRead Dev Hub. You can browse the SVN repository via the Trac (https://dev.mobileread.com/trac/iliados/browser) or SVN (https://dev.mobileread.com/svn/iliados/) source browsers. Note that these are very plain ways to browse the code. If you want to browse the code to learn about its structure, use Hansel's web site (http://iliad.hpelbers.org/), which uses dOxygen to provide more information and analysis of classes etc. I spent quite a while trying to figure out a good structure for the tree. Here's what I finally came up with: tags - standard SVN tags folder branches - standard SVN branches folder upstream - source codes for all externally maintained utilities and libraries (busybox, X, etc.) trunk - all iLiad-specific files filesystem - This will always hold a copy of the current development filesystem. /usr /bin /home and so on... src - Source code for all iRex-supplied iLiad-specific programs and libraries connectionMgr contentLister displayMgr etc.... kernel - kernel and iRex modules iRex - sources for iRex kernel modules linux-2.4.19 - kernel source for iLiad, with all patches applied including the latest (v2.11) I would welcome any comments or suggestions about ways to improve this structure. The entire repository is very large, as it necessarily includes complete kernel source code (>100MB!) and the sources for several very large upstream libraries. Anyone can check out a copy from the SVN server. You don't need to be registered or anything. I recommend only taking out a specific folder, not the whole trunk. For example, if you want to work on the ContentLister, you can get a copy of the latest source code with the command: Code: svn co https://dev.mobileread.com:8080/svn/iliados/trunk/src/contentLister For the moment, I would like all proposed patches to be funneled through either myself or Adam, and we will review and test them before including them in SVN. Please submit patches for any issue or feature! Of course, we'll be giving priority to changes that come early in the roadmap, but you should submit anything you've got working. Please try to submit good patches with clean code and no bugs... you know the drill. I'll write more later. Tomorrow evening I plan to add the formal roadmap to Trac, along with a number of new tickets covering all the roadmap goals. Then interested folks can take ownership for tickets they're interested in, and can submit patches for specific tickets, etc. I also plan to add some wiki pages covering how to set up the toolchains, how to compile things, guidelines for submissions, and more about how to use (and administer) the SVN server. That's it for now... Comments, questions, suggestions, critiques? Last edited by jharker; 11-17-2008 at 02:19 AM. Reason: Minor edit.