aboutsummaryrefslogtreecommitdiffstats
path: root/readme.txt
blob: 016a661ae204caf394865235a90914f0912f59df (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
Directories structure:

./readme.txt        - This file.
./license.txt       - GPL3 license file.
./src/              - ChibiOS/RT portable kernel source files.
./src/include/      - ChibiOS/RT include files.
./src/templates/    - ChibiOS/RT non portable source templates, new ports are
                      started by copying the templates into a new directory
                      under ./demos/.
./ports/            - Architecture/compiler specific portable files.
./demos/            - Demo programs for specific archtectures/boards.
./docs/doxifile     - Doxigen project file.
./docs/index.html   - ChibiOS/RT documentation (after running doxigen).

Current ports under ./demos:

Win32-MinGW         - ChibiOS/RT simulator and demo into a WIN32 process,
                      MinGW version.
Win32-MSVS          - ChibiOS/RT simulator and demo into a WIN32 process,
                      Visual Studio 7 or any later version should work.
LPC214x-GCC         - ChibiOS/RT port for ARM7 LPC2148, the demo targets the
                      Olimex LPC-P2148 board. This port can be easily modified
                      for any processor into the LPC2000 family or other
                      boards. The demo can be compiled using YAGARTO or any
                      other GCC-based ARM toolchain.
ighlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
OpenWrt as an open source software opens its development to the community by
having a publicly browseable subversion repository. The Trac software which
comes along with a Subversion frontend,  a Wiki and a ticket reporting system 
is used as an interface between developers, users and contributors in order to 
make the whole development process much easier and efficient.

We make distinction between two kinds of people within the Trac system:

\begin{itemize}
\item developers, able to report, close and fix tickets
\item reporters, able to add a comment, patch, or request ticket status
\end{itemize}

\subsubsection{Opening a ticket}

A reporter might want to open a ticket for the following reasons:

\begin{itemize}
\item a bug affects a specific hardware and/or software and needs to be fixed
\item a specific software package would be seen as part of the official OpenWrt repository
\item a feature should be added or removed from OpenWrt
\end{itemize}

Regarding the kind of ticket that is open, a patch is welcome in those cases:

\begin{itemize}
\item new package to be included in OpenWrt
\item fix for a bug that works for the reporter and has no known side effect
\item new features that can be added by modifying existing OpenWrt files
\end{itemize}

Once the ticket is open, a developer will take care of it, if so, the ticket is marked
as "accepted" with the developer name. You can add comments at any time to the ticket,
even when it is closed.

\subsubsection{Closing a ticket}

A ticket might be closed by a developer because:

\begin{itemize}
\item the problem is already fixed (wontfix)
\item the problem described is not judged as valid, and comes along with an explanation why (invalid)
\item the developers know that this bug will be fixed upstream (wontfix)
\item the problem is very similar to something that has already been reported (duplicate)
\item the problem cannot be reproduced by the developers (worksforme)
\end{itemize}

At the same time, the reporter may want to get the ticket closed since he is not 
longer able to trigger the bug, or found it invalid by himself.

When a ticket is closed by a developer and marked as "fixed", the comment contains 
the subversion changeset which corrects the bug.