Regularize references to examples, so that we can link them on the web
authorPhil Miller <mille121@illinois.edu>
Fri, 3 Aug 2012 19:56:29 +0000 (14:56 -0500)
committerPhil Miller <mille121@illinois.edu>
Fri, 3 Aug 2012 19:56:29 +0000 (14:56 -0500)
doc/charm++/advancedarrays.tex
doc/charm++/arrays.tex
doc/charm++/callbacks.tex
doc/charm++/chares.tex
doc/charm++/commlib.tex
doc/charm++/groups.tex
doc/charm++/loadb.tex
doc/charm++/readonly.tex
doc/charm++/sdag.tex
doc/charm++/threaded.tex
doc/pplmanual.tex

index 423a43164858242ab62be80c1dfb988717abf7d8..b0151e88fa6fc95a2b7c30eb4e8c6e15fd4ca733 100644 (file)
@@ -24,10 +24,8 @@ then, to either avoid \kw{ckLocal} or else call \kw{ckLocal}
 each time the element may have migrated; e.g., at the start 
 of each entry method.
 
-An example of this usage is available in matmul3d:
-\begin{alltt}
-examples/charm++/topology/matmul3d
-\end{alltt}
+An example of this usage is available
+in \exampleref{examples/charm++/topology/matmul3d}.
 
 \section{Advanced Array Creation}
 \label{advanced array create}
@@ -81,10 +79,8 @@ will be significantly more efficient in the number of messages
 required than inserting each element individually, which will require
 one message send per element.
 
-Examples of bulk construction are commonplace, see:
-\begin{alltt}
-examples/charm++/jacobi3d-sdag
-\end{alltt}
+Examples of bulk construction are commonplace, see
+\exampleref{examples/charm++/jacobi3d-sdag}
 for a demonstration of the slightly more complicated case of
 multidimensional chare array bulk construction.
 
@@ -165,15 +161,11 @@ For example, if you've declared a map object named ``BlockMap'':
   a1=CProxy_A1::ckNew(\uw{parameters},opts);
 \end{alltt}
 
-An example which contructs one element per physical node may be found here: 
-\begin{alltt}
-examples/charm++/pupDisk
-\end{alltt}
+An example which contructs one element per physical node may be found in
+\exampleref{examples/charm++/pupDisk}
 
-Other 3D Torus network oriented map examples are in:
-\begin{alltt}
-examples/charm++/topology
-\end{alltt}
+Other 3D Torus network oriented map examples are in
+\exampleref{examples/charm++/topology}
 
 \subsection{Initial Elements}
 \index{array initial}
@@ -305,10 +297,8 @@ private:
 \};
 \end{alltt}
 
-A demonstration of bound arrays can be found in startupTest
-\begin{alltt}
-test/charm++/startupTest
-\end{alltt}
+A demonstration of bound arrays can be found in
+\exampleref{tests/charm++/startupTest}
 
 
 \subsection{Dynamic Insertion}
@@ -372,9 +362,7 @@ If you do not specify one, the system will choose a processor to
 create an array element on based on the current map object.
 
 A demonstration of dynamic insertion is available:
-\begin{alltt}
-examples/charm++/hello/fancyarray
-\end{alltt}
+\exampleref{examples/charm++/hello/fancyarray}
 
 \subsection{Demand Creation}
 
@@ -398,9 +386,7 @@ classic entry methods; and demand-created and normally
 created elements. 
 
 A simple example of demand creation
-\begin{alltt}
-tests/charm++/demand\_creation
-\end{alltt}
+\exampleref{tests/charm++/demand\_creation}
 
 \section{User-defined Array Indices}
 \label{user-defined array index type}
@@ -483,10 +469,8 @@ AF::AF()
 \}
 \end{alltt}
 
-A demonstration of user defined indices available:
-\begin{alltt}
-examples/charm++/hello/fancyarray
-\end{alltt}
+A demonstration of user defined indices can be seen in
+\exampleref{examples/charm++/hello/fancyarray}
 
 %\section{Load Balancing Chare Arrays}
 %see section~\ref{lbFramework}
index f0c9417e9c7ab7d2f2ca6b2a19d78fffab222792..d0c627743a0c6470340ab31ecda4f466980f3ac2 100644 (file)
@@ -15,7 +15,7 @@ properly. Array elements can be migrated at any time, allowing arrays to be
 efficiently load balanced. A chare array (or a subset of array elements) can
 receive a broadcast/multicast or contribute to a reduction.
 
-An example program can be found here: \kw{examples/charm++/array/}.
+An example program can be found here: \exampleref{examples/charm++/array/}.
 
 \section{Declaring a One-dimensional Array}
 
@@ -323,7 +323,7 @@ In all cases, the result of the reduction operation is passed to the {\em reduct
 client}.  Many different kinds of reduction clients can be used, as
 explained in Section~\ref{reductionClients}.
 
-Please refer to examples/charm++/typed\_reduction for a working example of
+Please refer to \exampleref{examples/charm++/typed\_reduction} for a working example of
 reductions in Charm++.
 
 Note that the reduction will complete properly even if chare array elements are {\em migrated}
index bf7f79da7c0b23d4c686324f2de1d7d2b6c18925..45915a50d7c673f6296f89d0b77dbc67dd757f0f 100644 (file)
@@ -148,9 +148,8 @@ As an alternative to ``send'', the callback can be used in a {\em
 ``send'' method on the callback when the contribute operation has
 finished.
 
-For examples of how to use the various callback types, please see {\tt
-callback.C} in the {\tt tests/charm++/megatest} directory in your
-\charmpp{} distribution. 
+For examples of how to use the various callback types, please
+see \exampleref{tests/charm++/megatest/callback.C}
 
 \section{Synchronous Execution with CkCallbackResumeThread}
 
index 2a60abc36a0a0d3135eebe8c82c394a2a8f08242..1e98d18ea33823257459b54521f904d9b8aa08c7 100644 (file)
@@ -128,7 +128,7 @@ processor and return a proxy to that chare:}
 \end{enumerate}
 
 For an example of chare creation in a full application, see
-{\tt examples/charm++/fib} in the \charmpp software distribution, which
+\exampleref{examples/charm++/fib} in the \charmpp software distribution, which
 calculates fibonacci numbers in parallel.
 
 \subsection{Method Invocation on Chares}
index 8902612dc45fa026d24496860906ad7607a97a3c..8d50deb53863735972567825b74cbda6fa3c37bd 100644 (file)
@@ -34,7 +34,7 @@ information has to be kept, either the CProxy or the ComlibInstanceHandle, and
 this can be done in readonly variables, or as internal variables of the objects.
 
 An example on how to use commlib can be found in the charm distribution, under
-``examples/charm++/commlib/multicast/ '', where the proxies are associated in the
+\exampleref{examples/charm++/commlib/multicast/}, where the proxies are associated in the
 chare arrays.
 
 
@@ -452,7 +452,7 @@ sequence the destinations of the multicast to minimize contention on a network.
 
 In order to use these strategies, the message sent must inherit from class
 {\textrm{CkMcastBaseMsg}}. (For an example see
-``examples/charm++/commlib/multicast/'').
+\exampleref{examples/charm++/commlib/multicast/}).
 
 These are the subclass strategies that are available:
 
index 06e52e4f1161314b4f9a0b4910594375b5e34ca7..992a5d93c3fc92ddb9216ab6bdb4db8cb23321d7 100644 (file)
@@ -169,9 +169,9 @@ When all the chares on a PE have finished their work, the local branch
 can send single a message to the main chare.  This reduces the number of messages
 sent to the mainchare from the number of chares created, to the number of processors. 
 
-For a more concrete example on how to use groups, please refer to the {\tt
-histogram\_group} example in the {\tt examples/charm++} directory in your
-\charmpp{} distribution. It presents a parallel histogramming operation in
-which chare array elements funnel their bin counts through a group, instead of
-contributing directly to a reduction across all chares. 
+For a more concrete example on how to use groups, please refer to
+\exampleref{examples/charm++/histogram\_group}. It presents a parallel
+histogramming operation in which chare array elements funnel their bin counts
+through a group, instead of contributing directly to a reduction across all
+chares.
 
index 16abd9bffd8136ef2270f49b82b2d2bbdfe73f2f..3fc4a9502642894adc2e640f5ec8c844b04406ec 100644 (file)
@@ -35,8 +35,8 @@ baseline load balancing is provided by migration strategies, but in each
 iteration one also spawns off work in the form of chares that can run on any
 processor. The seed balancer will handle such work as it arises.
 
-Examples are in {\tt examples/charm++/load\_balancing} and {\tt
-  tests/charm++/load\_balancing}
+Examples are in \exampleref{examples/charm++/load\_balancing} and
+\exampleref{tests/charm++/load\_balancing}
 
 \section{Measurement-based Object Migration Strategies}
 \label{lbFramework}
@@ -465,7 +465,7 @@ migrate it.
 %previous subsection perform the task of moving chares during work to achieve
 %load balance.
 Depending on the movement strategy, several seed load balancers are available now.
-Examples can be found {\tt examples/charm++/NQueen}.
+Examples can be found \exampleref{examples/charm++/NQueen}.
 \begin{enumerate}
 \item {\em random}\\  
  A strategy that places seeds randomly when they are created and does
index 78ad344c34f7ecd377156fd984b536c643e4131f..a2e5a0e212b02ebde8ae436e55bc79ee158bdb77 100644 (file)
@@ -60,5 +60,7 @@ Similar declarations preceded by \kw{extern} would appear in the {\tt
 assignments to read-only variables.  The user must make sure that no
 assignments occur in the program outside of the mainchare constructor.
 
-For concrete examples for using read-only variables, please refer to Travelling Salesman Problem (TSP) in examples/state\_space\_searchengine/TSP\_SE, and
-GaussSeidel elimination in examples/gaussSeidel3D. 
+For concrete examples for using read-only variables, please refer to Travelling
+Salesman Problem (TSP) in
+\exampleref{examples/state\_space\_searchengine/TSP\_SE}, and GaussSeidel
+elimination in \exampleref{examples/charm++/gaussSeidel3D}.
index f34d66017f272d51a8d448311e43eca530a4f8be..e83ced04f32fcae938e873fc53d80336536e70e7 100644 (file)
@@ -246,7 +246,7 @@ number in square brackets between the entry method name and its parameter list.
 That expression will be compared for equality with the entry method's first
 argument, or with the reference number field of an explicit message
 (\S~\ref{messages}). Matching is used in the loop example below, and in
-{\tt examples/charm++/jacobi2d-sdag/jacobi2d.ci}. Multiple {\tt when} triggers for
+\exampleref{examples/charm++/jacobi2d-sdag/jacobi2d.ci}. Multiple {\tt when} triggers for
 an entry method with different matching reference numbers will not conflict - each
 will receive only corresponding messages.
 
@@ -411,7 +411,7 @@ forall [IDENT] (MIN:MAX,STRIDE) BODY
 \end{center}
 The range from MIN to MAX is inclusive. Its use is demonstrated through
 distributed parallel matrix-matrix multiply shown in
-{\tt examples/charm++/matmul/matmul.ci}.
+\exampleref{examples/charm++/matmul/matmul.ci}.
 
 
 \section{Usage Notes}
@@ -622,7 +622,6 @@ SDAG constructs of the following kinds:
 
 \sdag{} code can be inserted into the .ci file for any array, group, or chare's entry methods.
 
-For more details regarding \sdag{}, look at the example located in the 
-{\tt examples/charm++/hello/sdag} directory in the \charmpp\ distribution.
+For more details regarding \sdag{}, look at \exampleref{examples/charm++/hello/sdag}
 }
 
index c43d9d68e114210a3d4c287d13fffede6aecbb4b..ea33cd1ac61e2097758dfd2e5eae83bce72f165a 100644 (file)
@@ -14,4 +14,5 @@ operations or explicitly suspend themselves, which is necessary to use some
 
 For details on the threads API available to threaded entry methods, see chapter
 3 of the Converse programming manual. The use of threaded entry methods is
-demonstrated in an example program located in examples/charm++/threaded\_ring.
+demonstrated in an example program located in
+\exampleref{examples/charm++/threaded\_ring}.
index 17cfcac398d653a9f98dcf771b2b4e4c14b97e91..f918efa1025177061eb0b33fe7861bfeada888b0 100644 (file)
@@ -57,4 +57,6 @@
 % to I (and again conflict with part 1).
 \renewcommand{\thepart}{\Roman{part}}
 
+\newcommand{\exampleref}[1]{{\tt #1}}
+
 \makeindex