Difference between revisions of "Bering-uClibc 4.x - Developer Guide - Policies and Guidelines"

From bering-uClibc
Jump to: navigation, search
(Adjusted navigation links for new "Building a Distribution" Section)
(Changed navigation links for new Adding a Kernel Architecture Variant page)
Line 2: Line 2:
 
! colspan="3" align="center" | [[Bering-uClibc 4.x - Developer Guide - Policies and Guidelines|Policies and Guidelines]]
 
! colspan="3" align="center" | [[Bering-uClibc 4.x - Developer Guide - Policies and Guidelines|Policies and Guidelines]]
 
|-
 
|-
| width="20%" align="left"  | [[Bering-uClibc 4.x - Developer Guide - Building a Distribution|Prev]]
+
| width="20%" align="left"  | [[Bering-uClibc 4.x - Developer Guide - Adding a Kernel Architecture Variant|Prev]]
 
! width="60%" align="center" | [[Bering-uClibc 4.x - Developer Guide]]
 
! width="60%" align="center" | [[Bering-uClibc 4.x - Developer Guide]]
 
| width="20%" align="right"  | [[Bering-uClibc 4.x - Developer Guide - Hints and Tips for using Git SCM|Next]]
 
| width="20%" align="right"  | [[Bering-uClibc 4.x - Developer Guide - Hints and Tips for using Git SCM|Next]]
Line 23: Line 23:
 
----
 
----
 
{| summary="Navigation footer" width="100%"
 
{| summary="Navigation footer" width="100%"
| width="40%" align="left"  | [[Bering-uClibc 4.x - Developer Guide - Building a Distribution|Prev]]
+
| width="40%" align="left"  | [[Bering-uClibc 4.x - Developer Guide - Adding a Kernel Architecture Variant|Prev]]
 
| width="20%" align="center" | [[Bering-uClibc 4.x - Developer Guide|Up]]
 
| width="20%" align="center" | [[Bering-uClibc 4.x - Developer Guide|Up]]
 
| width="40%" align="right"  | [[Bering-uClibc 4.x - Developer Guide - Hints and Tips for using Git SCM|Next]]
 
| width="40%" align="right"  | [[Bering-uClibc 4.x - Developer Guide - Hints and Tips for using Git SCM|Next]]

Revision as of 14:13, 29 April 2011

Policies and Guidelines
Prev Bering-uClibc 4.x - Developer Guide Next


The following general Policies and Guidelines should be adopted (if possible / practical) when developing for Bering-uClibc 4.x:

  1. Upload the upstream package source file to the LEAF source code management system and reference it from there within buildtool.cfg.
    • This provides a "local" copy in case the upstream distribution location changes or goes away.
    • This provides an input to the process which creates a downloadable snapshot of all of the source code used for a Bering-uClibc 4.x distribution, which is required to comply with SourceForge terms and conditions. TODO: Add reference to those Ts&Cs.
  2. Store the upstream package source file in unmodified form.
    • Do not change the filename. Retain the original compression scheme (preferably .tar.gz but alternatively .tar.bz2 if that is all that is provided).
    • Make changes by "patching" the unpacked files as part of the build process defined in buildtool.mk.
  3. When adding an extra kernel module to the kmodules source package, check whether there is any accompanying firmware (in /lib/firmware/). If there is, also specify that in the kmodules buildtool.cfg.
    • Refer to the e100 entry as an example.
  4. Do not place kernel Modules into Package .lrp files. Place modules only in moddb.lrp and modules.tgz.



Prev Up Next