- Wrap long lines in the documentation, so that patches to the .tex files are more readable.

- Fix several typos (see #1163)


git-svn-id: svn://svn.openwrt.org/openwrt/trunk@6018 3c298f89-4303-0410-b956-a3cf2f4a3e73
This commit is contained in:
Felix Fietkau
2007-01-07 16:06:53 +00:00
parent 2202b0ef1e
commit 6b830552a2
3 changed files with 183 additions and 67 deletions

View File

@@ -1,15 +1,19 @@
OpenWrt as an open source software opens its developpment 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 developpers, users and contributors in order to make the whole developpment process much easier and efficient.
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 :
We make distinction between two kinds of people within the Trac system:
\begin{itemize}
\item developpers, able to report, close and fix tickets
\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 :
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
@@ -17,7 +21,7 @@ A reporter might want to open a ticket for the following reasons :
\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 :
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
@@ -25,22 +29,29 @@ Regarding the kind of ticket that is open, a patch is welcome in those cases :
\item new features that can be added by modifying existing OpenWrt files
\end{itemize}
In order to include a patch, you need to produce it, this can be done by using the \textbf{svn diff} command which generates the differences between your local copy (modified) and the version on the OpenWrt repository (unmodified yet). Then attach the patch with a description, using the "Attach" button.
In order to include a patch, you need to produce it, this can be done by using the
\textbf{svn diff} command which generates the differences between your local copy
(modified) and the version on the OpenWrt repository (unmodified yet). Then attach
the patch with a description, using the "Attach" button.
Once the ticket is open, a developper will take care of it, if so, the ticket is marked as "accepted" with the developper name. You can add comments at any time to the ticket, even when it is closed.
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 developper because :
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 developpers know that this bug will be fixed upstream (wontfix)
\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 developpers (worksforme)
\item the problem cannot be reproduced by the developers (worksforme)
\end{itemize}
A 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.
A 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 developper and marked as "fixed", the comment contains the subversion changeset which corrects the bug.
When a ticket is closed by a developer and marked as "fixed", the comment contains
the subversion changeset which corrects the bug.