aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorFelix Fietkau <nbd@openwrt.org>2007-12-28 17:04:10 +0000
committerFelix Fietkau <nbd@openwrt.org>2007-12-28 17:04:10 +0000
commit3be5bc2f81ba117ed68d317e9b40f562e39186ec (patch)
tree28e707a1093b2af0a04a88e3b2dd1fa48eca1d70 /docs
parent1f537d73fcb692b5460682acf40c8dc8fa714041 (diff)
downloadupstream-3be5bc2f81ba117ed68d317e9b40f562e39186ec.tar.gz
upstream-3be5bc2f81ba117ed68d317e9b40f562e39186ec.tar.bz2
upstream-3be5bc2f81ba117ed68d317e9b40f562e39186ec.zip
add SubmittingPatches document to docs/
git-svn-id: svn://svn.openwrt.org/openwrt/trunk@9996 3c298f89-4303-0410-b956-a3cf2f4a3e73
Diffstat (limited to 'docs')
-rw-r--r--docs/openwrt.sty2
-rw-r--r--docs/openwrt.tex2
-rw-r--r--docs/submitting-patches.tex53
3 files changed, 56 insertions, 1 deletions
diff --git a/docs/openwrt.sty b/docs/openwrt.sty
index 5a69bcc83d..d73ba43807 100644
--- a/docs/openwrt.sty
+++ b/docs/openwrt.sty
@@ -1,7 +1,7 @@
\ProvidesPackage{openwrt}
\usepackage[latin9]{inputenc}
-\usepackage[bookmarks=true]{hyperref}
+\usepackage[bookmarks=true color=blue colorlinks=true]{hyperref}
\usepackage[T1]{fontenc}
\usepackage{ae,aecompl,aeguill}
\usepackage{fancyvrb}
diff --git a/docs/openwrt.tex b/docs/openwrt.tex
index 767a18d708..378571711c 100644
--- a/docs/openwrt.tex
+++ b/docs/openwrt.tex
@@ -35,4 +35,6 @@
\section{Reporting bugs}
\subsection{Using the Trac ticket system}
\input{bugs}
+ \section{Submitting patches}
+ \input{submitting-patches}
\end{document}
diff --git a/docs/submitting-patches.tex b/docs/submitting-patches.tex
new file mode 100644
index 0000000000..c16aaa9dc1
--- /dev/null
+++ b/docs/submitting-patches.tex
@@ -0,0 +1,53 @@
+\subsection{How to contribute}
+OpenWrt is constantly being improved. We'd like as many people to contribute
+to this as we can get. If you find a change useful, by all means try to get
+it incorporated into the project. This should improve OpenWrt and it should
+help carry your changes forward into future versions
+
+This section tries to lay out a procedure to enable people to submit patches
+in a way that is most effective for all concerned.
+
+It is important to do all these steps repeatedly:
+
+\begin{itemize}
+ \item \textit{listen} to what other people think.
+ \item \textit{talk} explaining what problem you are addressing and your
+ proposed solution.
+ \item \textit{do} write useful patches including documentation.
+ \item \textit{test. test. test.}
+\end{itemize}
+
+\subsection{Where to listen and talk}
+
+\begin{itemize}
+ \item google to find things related to your problem
+ \item Mailing lists: \href{http://lists.openwrt.org/}{http://lists.openwrt.org/}
+ \item Wiki: check the wiki: \href{http://wiki.openwrt.org/OpenWrtDocs}{http://wiki.openwrt.org/OpenWrtDocs}
+ \item Forum: \href{http://forum.openwrt.org/}{http://forum.openwrt.org/}
+ \item IRC: \texttt{irc.freenode.net}, channels \texttt{\#openwrt} and
+ \texttt{\#openwrt-devel}
+ \item TRAC: \href{https://dev.openwrt.org/}{https://dev.openwrt.org/} the issue/bug/change tracking system
+\end{itemize}
+
+It is often best to document what you are doing before you do it. The process
+of documentation often exposes possible improvements. Keep your documentation
+up to date.
+
+\subsection{Patch Submission Process}
+\begin{enumerate}
+ \item Use git or svn to create a patch. Creating patches manually with
+ \textit{diff -urN} also works, but is usually unnecessary.
+ \item Send a mail to openwrt-devel@lists.openwrt.org with the following contents:
+ \begin{enumerate}
+ \item \texttt{[PATCH] <short description>} in the Subject, followed by:
+ \item (optional) a longer description of your patch in the message body
+ \item \texttt{Signed-off-by: Your name <your@email.address>}
+ \item Your actual patch, inline, not word wrapped or whitespace mangled.
+ \end{enumerate}
+ \item Please read \href{http://kerneltrap.org/Linux/Email\_Clients\_and\_Patches}{http://kerneltrap.org/Linux/Email\_Clients\_and\_Patches}
+ to find out how to make sure your email client doesn't destroy your patch.
+ \item Please use your real name and email address in the \texttt{Signed-off-by}
+ line, following the same guidelines as in the \href{http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob;f=Documentation/SubmittingPatches;h=681e2b36195c98ea5271b76383b3a574b190b04f;hb=HEAD}{Linux Kernel patch submission guidelines}
+ \item Example of a properly formatted patch submission: \\
+ \href{http://lists.openwrt.org/pipermail/openwrt-devel/2007-November/001334.html}{http://lists.openwrt.org/pipermail/openwrt-devel/2007-November/001334.html}
+\end{enumerate}