summaryrefslogtreecommitdiff
path: root/misc/pres_best_en.tex
diff options
context:
space:
mode:
authorJohn Ogness <john.ogness@linutronix.de>2017-12-19 10:46:32 +0100
committerJohn Ogness <john.ogness@linutronix.de>2017-12-19 10:46:32 +0100
commit0f172d0b022f1a2ec3d7465eb7272828ee083f6e (patch)
tree7e7aded1388eaa61097f9e1c2c2b22cc2f60d0ef /misc/pres_best_en.tex
parentc30d3680a48c7966f860262ac4ec2398bd52ae8d (diff)
import presentations from devel/jogness
Several presentations are available only in devel/jogness. Add them to master to allow easy access to any trainer. misc/pres_best_en: best practice guidelines misc/pres_ipc_en: overview of linux ipc mechanisms misc/pres_minicoredumper_en: minicoredumper features misc/pres_zynq_en: describe the zynq architecture Signed-off-by: John Ogness <john.ogness@linutronix.de>
Diffstat (limited to 'misc/pres_best_en.tex')
-rw-r--r--misc/pres_best_en.tex72
1 files changed, 72 insertions, 0 deletions
diff --git a/misc/pres_best_en.tex b/misc/pres_best_en.tex
new file mode 100644
index 0000000..fc97825
--- /dev/null
+++ b/misc/pres_best_en.tex
@@ -0,0 +1,72 @@
+\input{configpres}
+
+\section{Best Practices}
+
+\title{Best Practices}
+\maketitle
+
+\subsection{Best Practices}
+
+\begin{frame}
+\frametitle{Source Code Management}
+\begin{itemize}
+\item repository
+\item maintainer
+\item patches (submit, review, acknowledge role)
+\item separate development branches (maintainer merged)
+\item useful commit messages (explain why)
+\item open opt-in communication (mailing lists)
+\item release tags
+\item backups
+\end{itemize}
+\end{frame}
+
+\begin{frame}
+\frametitle{Code Implementation}
+\begin{itemize}
+\item useful comments (explain why)
+\item think architecture independent (big/little endian, 32/64 bit)
+\item UNIX principle (separate well-defined tasks, do it well)
+\item separate interface and workcode (client/server model thinking)
+\end{itemize}
+\end{frame}
+
+\begin{frame}
+\frametitle{Bug Tracking}
+\begin{itemize}
+\item track all bugs
+\item close/reopen bugs if necessary
+\item include repository commit information when closing
+\end{itemize}
+\end{frame}
+
+\begin{frame}
+\frametitle{Reproducible Software}
+\begin{itemize}
+\item release tags
+\item official build environment
+\item reproducible build environment
+\end{itemize}
+\end{frame}
+
+\begin{frame}
+\frametitle{Release Testing}
+\begin{itemize}
+\item use official software (debug symbols available offline)
+\item leak / electric fence testing
+\item regression testing (using archived scripts/programs)
+\item open bugs
+\item document test results (from tags)
+\end{itemize}
+\end{frame}
+
+\begin{frame}
+\frametitle{Releases}
+\begin{itemize}
+\item archive release binaries
+\item archive debug information (matching BuildID!)
+\item capture crash data
+\end{itemize}
+\end{frame}
+
+\input{tailpres}