Skip to content

Commit

Permalink
docs: fix broken links
Browse files Browse the repository at this point in the history
Problem: there are a lot of broken links in our docs.

Fix them.
  • Loading branch information
wihobbs committed Oct 23, 2024
1 parent 38d4612 commit a01a440
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 9 deletions.
4 changes: 4 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -367,3 +367,7 @@ def setup(app):
objname="configuration value",
indextemplate="pair: %s; configuration value",
)

linkcheck_ignore = [
r'https://github.com/flux-framework/flux-core\?tab\=readme-ov-file\#build-requirements'
]
2 changes: 1 addition & 1 deletion faqs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ may help improve efficiency and throughput:
- If scripting ``flux submit`` commands, avoid the pattern of one command
per job as each command invocation has a startup cost. Instead try to
combine similar job submissions with ``flux submit --cc=IDSET``
or :core:man1:`flux-builksubmit`.
or :core:man1:`flux-bulksubmit`.
- By default ``flux submit --cc=IDSET`` and ``flux bulksubmit``
will exit once all jobs have been submitted. To wait for all jobs to
complete before proceeding, use the ``--wait`` or ``--watch`` options to
Expand Down
6 changes: 3 additions & 3 deletions jobs/batch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Batch Jobs

In Flux, a batch job is a script submitted along
with a request for resources. When resources become
available, the script is run as the
`initial program <https://flux-framework.readthedocs.io/projects/flux-rfc/en/latest/spec_8.html#initial-program-program-1>`_ of a new single-user instance of Flux,
with the batch user as `instance owner <https://flux-framework.readthedocs.io/projects/flux-rfc/en/latest/spec_8.html#terminology>`_.
available, the script is run as the initial program
of a new single-user instance of Flux,
with the batch user as instance owner.
Thus, in contrast to a traditional batch scheduler, a Flux batch job
has access to fully featured resource manager instance, and may not only
serially execute work on allocated resources, but load custom modules
Expand Down
8 changes: 4 additions & 4 deletions jobs/debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Debugging Jobs

Debugging Flux jobs has been tested with Rogue Wave Software (RWS)'s
`TotalView parallel debugger <https://totalview.io>`_ and
Linaro `DDT <https://www.linaroforge.com/linaroDdt/>`_. More detailed
Linaro `DDT <https://www.linaroforge.com/linaro-ddt/>`_. More detailed
instructions for specific debuggers are included in the sections below.

----------------------------------
Expand Down Expand Up @@ -102,15 +102,15 @@ Parallel Debugging with DDT

While at this time DDT does not have native support for Flux, small to
medium size jobs can be debugged with DDT using a combination of the
:core:man1:`flux job` :command:`hostpids` command and the :command:`ddt
:core:man1:`flux-job` :command:`hostpids` command and the :command:`ddt
--attach` option. For example, to attach :command:`ddt` to the previous
job

.. code-block:: console
$ ddt --attach=$(flux job hostpids $(flux job last))
Flux can launch jobs with every task stopped in :linux:man2:`exec` by
Flux can launch jobs with every task stopped in :linux:man3:`exec` by
providing the ``stop-tasks-in-exec`` job shell option. Thus, launching a
job under control of DDT can be simulated by something like:

Expand All @@ -121,7 +121,7 @@ job under control of DDT can be simulated by something like:
The :command:`flux job hostpids` command will block until the job has started
running and the process IDs for all tasks are available, and therfore
:command:`ddt` will not launch until the job has started and is ready
for debugger attach. Since tasks have been stopped in :linux:man2:`exec`,
for debugger attach. Since tasks have been stopped in :linux:man3:`exec`,
the debugger will have control of job tasks before execution begins.

.. note::
Expand Down
2 changes: 1 addition & 1 deletion quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ Manual Installation
Recommended for developers and contributors

Ensure the latest list of requirements are installed. The
current list of build requirements are detailed `here <https://github.com/flux-framework/flux-core#readme>`_.
current list of build requirements are detailed `here <https://github.com/flux-framework/flux-core?tab=readme-ov-file#build-requirements>`_.

Clone current flux-core master:

Expand Down

0 comments on commit a01a440

Please sign in to comment.