From: Akos Kiss <akiss@inf.u-szeged.hu>
Date: Mon, 5 Oct 2020 14:21:51 +0000 (+0200)
Subject: Update/fix manual
X-Git-Tag: v1.7~13^2
X-Git-Url: https://git.htl-mechatronik.at/public/?a=commitdiff_plain;h=2f136017314453ff9ce9a80b108e939e48a334d9;p=sx%2Fsimavr.git

Update/fix manual

- Updated GitHub repository links.
- Removed the requirement for a German babel language definition
  file.
- Commented out missing references (citations of external manual
  and references to non-existing sections).
- Added a .gitignore file to the directory of the manual to help
  git disregard temporary latex files.
---

diff --git a/doc/manual/.gitignore b/doc/manual/.gitignore
new file mode 100644
index 0000000..68134e5
--- /dev/null
+++ b/doc/manual/.gitignore
@@ -0,0 +1,7 @@
+*.aux
+*.fdb_latexmk
+*.fls
+*.log
+*.out
+*.synctex.gz
+*.toc
diff --git a/doc/manual/manual.pdf b/doc/manual/manual.pdf
index 40f9932..a2694ab 100644
Binary files a/doc/manual/manual.pdf and b/doc/manual/manual.pdf differ
diff --git a/doc/manual/manual.tex b/doc/manual/manual.tex
index 6b6e6d2..3d3d5c5 100644
--- a/doc/manual/manual.tex
+++ b/doc/manual/manual.tex
@@ -3,7 +3,7 @@
 \usepackage{graphicx}                       % includegraphics-command
 \usepackage{fancyheadings}
 \usepackage[pdfborder={0 0 0}]{hyperref}
-\usepackage[english,germanb]{babel}
+\usepackage[english]{babel}
 \usepackage[latin1]{inputenc}               % Support direct writing of German Umlauts
 \usepackage{dcolumn}                        % Decimal column formatting
 \usepackage[usenames,dvipsnames]{color}
diff --git a/doc/manual/setupguide.tex b/doc/manual/setupguide.tex
index 194297d..9c408bd 100644
--- a/doc/manual/setupguide.tex
+++ b/doc/manual/setupguide.tex
@@ -7,13 +7,13 @@ This section provides instructions on how to retrieve, compile and install
 
 \subsection{Getting the source code}
 
-The official home of \simavr is \url{https://github.com/buserror-uk/simavr}.
+The official home of \simavr is \url{https://github.com/buserror/simavr}.
 Stable releases are published as git repository tags (direct downloads are
-available at \url{https://github.com/buserror-uk/simavr/tags}). To clone a local
+available at \url{https://github.com/buserror/simavr/tags}). To clone a local
 copy of the repository, run
 
 \begin{verbatim}
-git clone git://github.com/buserror-uk/simavr.git
+git clone git://github.com/buserror/simavr.git
 \end{verbatim}
 
 \subsection{Software Dependencies}
diff --git a/doc/manual/simavr.tex b/doc/manual/simavr.tex
index fc40521..1286dfb 100644
--- a/doc/manual/simavr.tex
+++ b/doc/manual/simavr.tex
@@ -454,7 +454,8 @@ int main() {
 
 Usually, UART0 is used for this purpose. The simplest debug output can be achieved
 by binding \lstinline|stdout| to \lstinline|UART0| as described by the avr-libc
-documentation \cite{libc}, and then using \lstinline|printf| and similar functions.
+documentation, % FIXME: missing citation \cite{libc},
+and then using \lstinline|printf| and similar functions.
 This alternate console output is provided in case using UART0 is not possible or desired.
 
 
@@ -478,7 +479,7 @@ uint32_t opcode = (avr->flash[avr->pc + 1] << 8) | avr->flash[avr->pc];
 As we have seen, \lstinline|avr->pc| represents the byte address in flash memory.
 Therefore, the next instruction is located at \lstinline|avr->pc + 2|. This
 default new program counter may still be altered in the course of processing
-in case of jumps, branches, calls and larger opcodes such as STS\cite{instructionset}.
+in case of jumps, branches, calls and larger opcodes such as STS. % FIXME: missing citation \cite{instructionset}.
 
 Note also that the \ac{AVR} flash addresses are usually represented as word addresses
 (\lstinline|avr->pc >> 1|).
@@ -710,14 +711,16 @@ We have covered how to enable \ac{GDB} support in section
 \ref{subsection:avr_t_initialization}, and when \ac{GDB} handler functions are
 called during the main loop in section \ref{section:mainloop}. In the following,
 we will explain further the methods \simavr employs to communicate with
-\ac{GDB} and how breakpoints and data watchpoints are implemented. For
-a short guide to debugging \ac{AVR} programs with \ac{GDB}, see section
-\ref{section:debugging}
+\ac{GDB} and how breakpoints and data watchpoints are implemented.
+% FIXME: missing reference \ref{section:debugging}
+% For
+% a short guide to debugging \ac{AVR} programs with \ac{GDB}, see section
+% \ref{section:debugging}
 
 \simavr has a fully featured implementation of the \ac{GDB} Remote Serial Protocol,
 which allows it to communicate with \emph{avr-gdb}. A complete reference of
-the protocol can be obtained from the \ac{GDB} manual \cite{gdb}. Essentially,
-communication boils down to packets of the format \lstinline|$packet-data#checksum|.
+the protocol can be obtained from the \ac{GDB} manual. % FIXME: missing citation \cite{gdb}.
+Essentially, communication boils down to packets of the format \lstinline|$packet-data#checksum|.
 The packet data itself consists of a command and its arguments. The syntax of
 all commands supported by \simavr is as follows: