Skip to content

Commit

Permalink
#672: docs: fix a bunch of incorrect \subpage vs. \ref
Browse files Browse the repository at this point in the history
lifflander committed Jun 22, 2020
1 parent ca19a9d commit 6399425
Showing 7 changed files with 12 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/md/active-messenger.md
Original file line number Diff line number Diff line change
@@ -15,7 +15,7 @@ serializing the message (depending on whether the serialize overload is
present), and then using `MPI_Isend` to asynchronously transfer the bytes to the
destination node. On the receive side, the active messenger is always probing
for an incoming message and begins a transfer when it discovers one. The \vt
\subpage scheduler polls the active messenger to make progress on any incoming
\ref scheduler polls the active messenger to make progress on any incoming
messages.

\section am-simple-example Sending a message
8 changes: 4 additions & 4 deletions docs/md/collection.md
Original file line number Diff line number Diff line change
@@ -6,14 +6,14 @@ The virtual context collection component
a core VT component that manages multi-dimensional collections of *virtual
context* (or a migratable C++ object registered with \vt) elements. It manages
the creation, deletion, and messaging across elements at runtime supporting
dense, sparse, on-demand, and staged insert modes. It utilizes the \subpage
dense, sparse, on-demand, and staged insert modes. It utilizes the \ref
location to manage the location of these elements to efficiently deliver
messages. It also utilizes the \subpage group to build a spanning tree across
messages. It also utilizes the \ref group to build a spanning tree across
the nodes that the collection is currently mapped to. This group makes
broadcasts efficient and allows reductions to make progress without waiting for
nodes that do not have collection elements. The \subpage proc-stats component
nodes that do not have collection elements. The \ref proc-stats component
stores the statistics for live collections that then passes the instrumented
data to the \subpage lb-manager component to apply load balancing strategies.
data to the \ref lb-manager component to apply load balancing strategies.

\section rooted-hello-world-collection Hello World 1D Dense Collection (Rooted)
\snippet examples/hello_world/hello_world_collection.cc Hello world collection
2 changes: 1 addition & 1 deletion docs/md/memory-usage.md
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@

The memory usage component `vt::util::memory::MemoryUsage`, accessed via
`vt::theMemUsage()` is an optional VT component that tracks memory usage over
time. It can be used with the \subpage trace component to write memory usage to
time. It can be used with the \ref trace component to write memory usage to
Projections log files to track usage after each registered function executes. It
can be configured to report usage after each LB phase is reached. This component
is backed by a wide range of different reporters---everything from trapping
2 changes: 1 addition & 1 deletion docs/md/proc-stats.md
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ manages instrumentation data from objects in a collection. It holds data per
node on the timing of these objects and communication between them demarcated by
phase and subphase.

When LB is invoked in \vt, the \subpage lb-manager passes the processor
When LB is invoked in \vt, the \ref lb-manager passes the processor
statistics to the various LB strategies to run the load balancer. The processor
statistics component can also dump the statistic data it holds to files, which
can be read externally. The LBAF (Load Balancing Analysis Framework) can also
6 changes: 3 additions & 3 deletions docs/md/registry.md
Original file line number Diff line number Diff line change
@@ -5,9 +5,9 @@ The registry component `vt::registry::Registry`, accessed via
`vt::theRegistry()` holds type-safe active handlers for execution across a
distributed machine.

- The \subpage active-messenger uses the registry to store/dispatch active
- The \ref active-messenger uses the registry to store/dispatch active
function and active functor handlers.
- The \subpage objgroup uses the registry to store/dispatch active member
- The \ref objgroup uses the registry to store/dispatch active member
functions
- The \subpage collection uses the registry to store/dispatch active functions
- The \ref collection uses the registry to store/dispatch active functions
with the object pointer and active members.
2 changes: 1 addition & 1 deletion docs/md/scheduler.md
Original file line number Diff line number Diff line change
@@ -26,7 +26,7 @@ conditions) is met, it is recommended that `runSchedulerWhile` be invoked:

\section higher-level-calls Higher-level Calls to Wait for Completion

If work is enclosed in an "epoch", the \subpage term can be used to track its
If work is enclosed in an "epoch", the \ref term can be used to track its
distributed completion. In this case, instead of calling the scheduler directly,
built-in higher-level functions can be used to advance the scheduler until this
work is complete/terminated.
3 changes: 1 addition & 2 deletions docs/md/vt.md
Original file line number Diff line number Diff line change
@@ -67,8 +67,7 @@ management.

\section how-to-build-intro How to build

\vt can be built with cmake or inside a docker container. Learn \subpage
vt-build
\vt can be built with cmake or inside a docker container. Learn \ref vt-build

\section vt-hello-world Hello World Example

0 comments on commit 6399425

Please sign in to comment.