Skip to content

Commit fe0d0ee

Browse files
committed
COMP: Address remote module syntax errors
1 parent 4a98d0c commit fe0d0ee

File tree

2 files changed

+33
-35
lines changed

2 files changed

+33
-35
lines changed

SoftwareGuide/Latex/DevelopmentGuidelines/CreateAModule.tex

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1041,36 +1041,34 @@ \subsection{Procedure for Adding a Remote Module}
10411041
The procedure to publish a new module in ITK is summarized as follows:
10421042
\begin{enumerate}
10431043
\item Publish an open access article describing the module in an online, open
1044-
access journal like The Insight Journal.
1044+
access journal like The Insight Journal.
10451045
\item Submit a Gerrit patch (see Section~\ref{sec:GitRepository} on
1046-
page~\pageref{sec:GitRepository) that adds a file named
1047-
\code{Modules/Remote/<module name>.remote.cmake}. This file must have the
1048-
following:
1049-
\begin{enumerate}
1050-
\item Dashboard maintainer name and email in the comments.
1051-
\item A call to the \code{itk_fetch_module} CMake function (documented in
1052-
\code{CMake/ITKModuleRemote.cmake}) whose arguments are:
1053-
\begin{enumerate}
1054-
\item The name of the remote module. Note that in each
1055-
\code{<remote module name>.remote.cmake}, the first argument of the function
1056-
\code{itk_fetch_module()} is the name of the remote module, and it has to be
1057-
consistent with the module name defined in the corresponding
1058-
\code{<remote module name>.remote.cmake}. To better distinguish the remote
1059-
modules from the internal ITK modules, the names of the remote modules should
1060-
\textbf{NOT} contain the ``ITK'' string prefix.
1061-
\item A short description of the module with the handle to the open access
1062-
article.
1063-
\item URLs describing the location and version of the code to download. The
1064-
version should be a specific hash.
1065-
\end{enumerate}
1066-
\end{enumerate}
1046+
page~\pageref{sec:GitRepository} that adds a file named
1047+
\code{Modules/Remote/<module name>.remote.cmake}. This file must have the
1048+
following:
1049+
\begin{enumerate}
1050+
\item Dashboard maintainer name and email in the comments.
1051+
\item A call to the \code{itk\_fetch\_module} CMake function (documented in
1052+
\code{CMake/ITKModuleRemote.cmake}) whose arguments are:
1053+
\begin{enumerate}
1054+
\item The name of the remote module. Note that in each
1055+
\code{<remote module name>.remote.cmake}, the first argument of the function
1056+
\code{itk\_fetch\_module()} is the name of the remote module, and it has to be
1057+
consistent with the module name defined in the corresponding
1058+
\code{<remote module name>.remote.cmake}. To better distinguish the remote
1059+
modules from the internal ITK modules, the names of the remote modules should
1060+
\textbf{NOT} contain the ``ITK'' string prefix.
1061+
\item A short description of the module with the handle to the open access
1062+
article.
1063+
\item URLs describing the location and version of the code to download. The
1064+
version should be a specific hash.
1065+
\end{enumerate}
1066+
\end{enumerate}
10671067
\end{enumerate}
10681068
10691069
After the Remote Module has experienced sufficient testing, and community
1070-
members express broad interests in the contribution, the submitter can then move
1070+
members express broad interest in the contribution, the submitter can then move
10711071
the contribution into the ITK repository via Gerrit code review.
10721072
10731073
It is possible but not recommended to directly submit a module to Gerrit for
1074-
review without submitting to Insight Journal first. There are no established
1075-
rules on whether a module should be directly merged into the main repository or
1076-
not.
1074+
review without submitting to Insight Journal first.

SoftwareGuide/Latex/Introduction/Installation.tex

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -532,7 +532,7 @@ \subsection{Static and Shared Libraries}
532532
an application. This reduces binary size and ensures that singleton
533533
variables are unique across the application.
534534

535-
A very advanced CMake configuration variable,
535+
An advanced CMake configuration variable,
536536
\code{ITK\_TEMPLATE\_VISIBILITY\_DEFAULT} defines the symbol visibility
537537
attribute on template classes to \textit{default} on systems that require it
538538
to perform \code{dynamic\_cast}'s on pointers passed across binaries. The
@@ -554,7 +554,7 @@ \subsection{Compiling ITK}
554554
and selecting the ``Build'' context menu item.
555555

556556
The build process can take anywhere from 15 minutes to a couple of hours,
557-
depending on the the build configuration and the performance of your
557+
depending on the build configuration and the performance of your
558558
system. If testing is enabled as part of the normal build process,
559559
about 2400 test programs will be compiled. In this case, you will then need
560560
to run \code{ctest} to verify that all the components of ITK have been correctly built
@@ -660,7 +660,7 @@ \section{Using ITK as an External Library}
660660

661661
For a project that uses ITK as an external library, it is recommended to
662662
specify the individual ITK modules in the \code{COMPONENTS} argument in the
663-
\code{find_package} CMake command:
663+
\code{find\_package} CMake command:
664664

665665
\small
666666
\begin{minted}[baselinestretch=1,fontsize=\footnotesize,linenos=false,bgcolor=ltgray]{bash}
@@ -685,7 +685,7 @@ \section{Using ITK as an External Library}
685685
\normalsize
686686

687687
If you would like to use the CMake ExternalProject
688-
Module\footnote{url{https://cmake.org/cmake/help/latest/module/ExternalProject.html}}
688+
Module\footnote{\url{https://cmake.org/cmake/help/latest/module/ExternalProject.html}}
689689
to download ITK source code when building your ITK application (a.k.a.
690690
Superbuild ITK), here is a basic CMake snippet for setting up a Superbuild in
691691
an ITK application project using CMake:
@@ -713,13 +713,13 @@ \section{Using ITK as an External Library}
713713
\normalsize
714714
715715
More exemplary configurations for superbuild ITK projects can be found in:
716-
Slicer\footnote{url{https://github.com/Slicer/Slicer},
717-
BrainsTools\footnote{url{https://github.com/BRAINSia/BRAINSTools}, ITK Wiki
718-
Examples\footnote{url{https://github.com/InsightSoftwareConsortium/ITKWikiExamples},
716+
Slicer\footnote{\url{https://github.com/Slicer/Slicer}},
717+
BrainsTools\footnote{\url{https://github.com/BRAINSia/BRAINSTools}}, ITK Wiki
718+
Examples\footnote{\url{https://github.com/InsightSoftwareConsortium/ITKWikiExamples}},
719719
ITK Sphinx
720-
Examples\footnote{url{https://github.com/InsightSoftwareConsortium/ITKExamples},
720+
Examples\footnote{\url{https://github.com/InsightSoftwareConsortium/ITKExamples}},
721721
and ITK Software
722-
Guide\footnote{url{https://github.com/InsightSoftwareConsortium/ITKSoftwareGuide}.
722+
Guide\footnote{\url{https://github.com/InsightSoftwareConsortium/ITKSoftwareGuide}}.
723723
724724
\subsection{Hello World!}
725725
\label{sec:HelloWorldITK}

0 commit comments

Comments
 (0)