Skip to content

Commit 215212c

Browse files
committed
STYLE: Add % to the end of section and subsection titles
Prevent LaTeX line breaks that may cause a \label or \index to be referenced in the wrong place for page references. Delete this space to maintain correct pagereferences. Found with `chktex` latex linting tool
1 parent 3568e80 commit 215212c

33 files changed

+626
-645
lines changed

SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex

Lines changed: 98 additions & 98 deletions
Large diffs are not rendered by default.

SoftwareGuide/Latex/Appendices/GitWorkflow.tex

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ \chapter{ITK Git Workflow}
66
and flexible model to develop modern software.
77

88

9-
\section{Git Setup}
9+
\section{Git Setup}%
1010
\label{sec:Git Setup}
1111

1212
Visit the main \href{https://www.git-scm.com/download}{Git download site}, and
1313
depending on your operating system, follow the guidelines.
1414

1515

16-
\subsection{Windows}
16+
\subsection{Windows}%
1717
\label{subsec:Windows}
1818

1919
Git comes in two flavors on Windows:
@@ -28,7 +28,7 @@ \subsection{Windows}
2828
work tree is not unless \code{core.filemode} is false).
2929

3030

31-
\subsubsection{Git for Windows}
31+
\subsubsection{Git for Windows}%
3232
\label{subsubsec:GitForWindows}
3333

3434
Download the ``git for windows'' executable from the
@@ -46,7 +46,7 @@ \subsubsection{Git for Windows}
4646
get a command line shell with Git.
4747

4848

49-
\subsubsection{Cygwin}
49+
\subsubsection{Cygwin}%
5050
\label{subsubsec:Cygwin}
5151

5252
Install the following packages:
@@ -59,10 +59,10 @@ \subsubsection{Cygwin}
5959
Launch a Cygwin command prompt to get a command line shell with Git.
6060

6161

62-
\subsection{macOS}
62+
\subsection{macOS}%
6363
\label{subsec:macOS}
6464

65-
\subsubsection{Xcode 4}
65+
\subsubsection{Xcode 4}%
6666
\label{subsubsec:Xcode4}
6767

6868
If you have Xcode 4 installed, you already have git installed.
@@ -79,14 +79,14 @@ \subsubsection{Xcode 4}
7979
\end{minted}
8080

8181

82-
\subsubsection{OS X Installer}
82+
\subsubsection{OS X Installer}%
8383
\label{subsubsec:OSXInstaller}
8484

8585
Download an installer from
8686
\href{https://code.google.com/archive/p/git-osx-installer/}{code.google.com}.
8787

8888

89-
\subsubsection{MacPorts}
89+
\subsubsection{MacPorts}%
9090
\label{subsubsec:MacPorts}
9191

9292
Enter these commands:
@@ -97,7 +97,7 @@ \subsubsection{MacPorts}
9797
\end{minted}
9898

9999

100-
\subsection{Linux}
100+
\subsection{Linux}%
101101
\label{subsec:Linux}
102102

103103
Popular Linux distributions already come with packages for Git. Typically the packages are called:
@@ -108,10 +108,10 @@ \subsection{Linux}
108108
\end{itemize}
109109

110110

111-
\section{Workflow}
111+
\section{Workflow}%
112112
\label{sec:Workflow}
113113

114-
\subsection{A Primer}
114+
\subsection{A Primer}%
115115
\label{subsec:APrimer}
116116

117117
This primer details a possible workflow for using Git and ITK. There are many
@@ -165,14 +165,14 @@ \subsection{A Primer}
165165
\end{quote}
166166

167167

168-
\subsection{A Topic}
168+
\subsection{A Topic}%
169169
\label{subsec:ATopic}
170170

171171
This workflow is based on the branchy development workflow documented by
172172
\href{https://git-scm.com/docs/gitworkflows}{Git help workflows}.
173173

174174

175-
\subsubsection{Motivation}
175+
\subsubsection{Motivation}%
176176
\label{subsubsec:Motivation}
177177

178178
The primary goal of this workflow is to make release preparation and maintenance
@@ -190,7 +190,7 @@ \subsubsection{Motivation}
190190
\end{itemize}
191191

192192

193-
\subsubsection{Design}
193+
\subsubsection{Design}%
194194
\label{subsubsec:Design}
195195

196196
The design of this workflow is based on the observation that meeting the
@@ -217,7 +217,7 @@ \subsubsection{Design}
217217
\end{itemize}
218218

219219

220-
\subsubsection{Notation}
220+
\subsubsection{Notation}%
221221
\label{subsubsec:Notation}
222222

223223
This chapter uses Git Directed Acyclic Graphs (DAG) to depict commit history:
@@ -302,7 +302,7 @@ \subsubsection{Notation}
302302
\end{figure}
303303

304304

305-
\subsubsection{Published Branches}
305+
\subsubsection{Published Branches}%
306306
\label{subsubsec:PublishedBranches}
307307

308308
We publish an \textit{integration} branch for each stage of development:
@@ -317,7 +317,7 @@ \subsubsection{Published Branches}
317317
developer's local repositories.
318318

319319

320-
\subsubsection{Development}
320+
\subsubsection{Development}%
321321
\label{subsubsec:Development}
322322

323323
We cover below the steps to take during each phase of development.
@@ -1146,7 +1146,7 @@ \subsubsection{Development}
11461146
Section~\ref{subpar:NonFastForward} on page~\pageref{subpar:NonFastForward} to
11471147
resolve any conflict that may arise when publishing the change.
11481148

1149-
\subsubsection{Discussion}
1149+
\subsubsection{Discussion}%
11501150
\label{subpar:Discussion}
11511151

11521152
\paragraph{History Shape}
@@ -1348,7 +1348,7 @@ \subsubsection{Discussion}
13481348
first. Never merge \textbf{release} into a topic under any circumstances!!!
13491349

13501350

1351-
\subsubsection{Troubleshooting}
1351+
\subsubsection{Troubleshooting}%
13521352
\label{subsubsec:Troubleshooting}
13531353

13541354
Here we document problems one might encounter while following the workflow
@@ -2009,7 +2009,7 @@ \subsubsection{Troubleshooting}
20092009
%pre-commit hook. The fix was to add "--no-ff" arg when merging the topic.
20102010

20112011

2012-
\subsubsection{Conflicts}
2012+
\subsubsection{Conflicts}%
20132013
\label{subsubsec:Conflicts}
20142014

20152015
This section documents conflict resolution in a topic-based branchy workflow.
@@ -2727,11 +2727,11 @@ \subsubsection{Conflicts}
27272727
\end{figure}
27282728

27292729

2730-
\subsection{Publish}
2730+
\subsection{Publish}%
27312731
\label{subsec:Publish}
27322732

27332733

2734-
\subsubsection{Push Access}
2734+
\subsubsection{Push Access}%
27352735
\label{subsubsec:PushAccess}
27362736

27372737
Authorized developers may publish work directly to a \href{public.kitware.com}
@@ -2854,7 +2854,7 @@ \subsubsection{Push Access}
28542854
Section~\ref{subsec:Hooks} on page~\pageref{subsec:Hooks}.
28552855

28562856

2857-
\subsubsection{Patches}
2857+
\subsubsection{Patches}%
28582858
\label{subsubsec:Patches}
28592859

28602860
Git allows anyone to be a first-class developer on any published project. One
@@ -2967,10 +2967,10 @@ \subsubsection{Patches}
29672967
\end{minted}
29682968

29692969

2970-
\subsection{Hooks}
2970+
\subsection{Hooks}%
29712971
\label{subsec:Hooks}
29722972

2973-
\subsubsection{Setup}
2973+
\subsubsection{Setup}%
29742974
\label{subsubsec:Setup}
29752975

29762976
The \code{git commit} command creates local commits. A separate \code{git push}
@@ -3029,7 +3029,7 @@ \subsubsection{Setup}
30293029
where \code{<repo>.git} is the name of your project repository.
30303030

30313031

3032-
\subsubsection{Local}
3032+
\subsubsection{Local}%
30333033
\label{subsubsec:Local}
30343034

30353035
The above sequences maintain the following local \code{hooks} in your
@@ -3153,7 +3153,7 @@ \subsubsection{Local}
31533153
the commit to complete and then fix it with \code{git commit --amend}.
31543154

31553155

3156-
\subsubsection{Server}
3156+
\subsubsection{Server}%
31573157
\label{subsubsec:Server}
31583158

31593159
Many \url{public.kitware.com} repositories have server-side \code{hooks}.
@@ -3179,10 +3179,10 @@ \subsubsection{Server}
31793179
pushed.
31803180
\end{itemize}
31813181

3182-
\subsection{TipsAndTricks}
3182+
\subsection{TipsAndTricks}%
31833183
\label{subsec:TipsAndTricks}
31843184

3185-
\subsubsection{Editor support}
3185+
\subsubsection{Editor support}%
31863186
\label{subsubsec:EditorSupport}
31873187

31883188
Emacs users: if you put this line in your \code{.emacs} file:
@@ -3195,7 +3195,7 @@ \subsubsection{Editor support}
31953195
etiquette requires.
31963196

31973197

3198-
\subsubsection{Shell Customization}
3198+
\subsubsection{Shell Customization}%
31993199
\label{subsubsec:ShellCustomization}
32003200

32013201
\paragraph{Bash Completion}

SoftwareGuide/Latex/Appendices/Licenses.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
\chapter{Licenses}
22

3-
\section{Insight Toolkit License}
3+
\section{Insight Toolkit License}%
44
\label{sec:InsightToolkitLicense}
55
\verbatiminput{\ITKSOURCEDIR/LICENSE}
66

0 commit comments

Comments
 (0)