Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix "cylc cat-log" documentation. #2030

Merged
merged 2 commits into from
Oct 11, 2016
Merged

Fix "cylc cat-log" documentation. #2030

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fe1d047
Changing `cylc log` to `cylc cat-log` in two files which affect the r…
Oct 10, 2016
9e54784
Undoing spurious changes to doc/siterc.tex.
Oct 11, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions doc/cug.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1223,11 +1223,11 @@ \subsection{Job Submission: How Tasks Are Executed}
printed to the terminal:
\lstset{language=transcript}
\begin{lstlisting}
shell$ cylc log tut.oneoff.basic hello.1
shell$ cylc cat-log tut.oneoff.basic hello.1
\end{lstlisting}
This command can also print the suite log (and stdout and stderr for suites
in daemon mode) and task stdout and stderr logs (see
\lstinline=cylc log --help=).
\lstinline=cylc cat-log --help=).
A new job script can also be generated on the fly for inspection:
\lstset{language=transcript}
\begin{lstlisting}
Expand Down Expand Up @@ -1334,17 +1334,17 @@ \subsection{Locating Suite And Task Output}
Task job logs can be viewed by right-clicking on tasks in the gcylc
GUI (so long as the task proxy is live in the suite), manually
accessed from the log directory (of course), or printed to the terminal
with the \lstinline=cylc log= command:
with the \lstinline=cylc cat-log= command:
\lstset{language=transcript}
\begin{lstlisting}
# suite logs:
shell$ cylc log tut.oneoff.basic # suite event log
shell$ cylc log -o tut.oneoff.basic # suite stdout log
shell$ cylc log -e tut.oneoff.basic # suite stderr log
shell$ cylc cat-log tut.oneoff.basic # suite event log
shell$ cylc cat-log -o tut.oneoff.basic # suite stdout log
shell$ cylc cat-log -e tut.oneoff.basic # suite stderr log
# task logs:
shell$ cylc log tut.oneoff.basic hello.1 # task job script
shell$ cylc log -o tut.oneoff.basic hello.1 # task stdout log
shell$ cylc log -e tut.oneoff.basic hello.1 # task stderr log
shell$ cylc cat-log tut.oneoff.basic hello.1 # task job script
shell$ cylc cat-log -o tut.oneoff.basic hello.1 # task stdout log
shell$ cylc cat-log -e tut.oneoff.basic hello.1 # task stderr log
\end{lstlisting}
\begin{myitemize}
\item For a web-based interface to suite and task logs (and much more),
Expand Down Expand Up @@ -1533,7 +1533,7 @@ \subsection{Task Triggering}
\begin{lstlisting}
shell$ cat ~/cylc-run/tut.oneoff.goodbye/log/job/1/goodbye/01/job.out
# or
shell$ cylc log -o tut.oneoff.goodbye goodbye.1
shell$ cylc cat-log -o tut.oneoff.goodbye goodbye.1
JOB SCRIPT STARTING
cylc (scheduler - 2014-08-14T15:09:30+12): goodbye.1 started at 2014-08-14T15:09:30+12
cylc Suite and Task Identity:
Expand Down Expand Up @@ -5445,7 +5445,7 @@ \subsection{Task Job Scripts}
As shown in the Tutorial (\ref{RunningSuitesCLI}) job scripts are
saved to the suite run directory; the commands used to submit them are
printed to stdout by cylc in debug mode; and they can be printed with the
\lstinline=cylc log= command or new ones generated and printed with the
\lstinline=cylc cat-log= command or new ones generated and printed with the
\lstinline=cylc jobscript= command. Take a look at one to see exactly
how cylc wraps and runs your tasks.

Expand Down Expand Up @@ -5738,7 +5738,7 @@ \subsection{Task stdout And stderr Logs}
Some job submission methods, such as \lstinline=pbs=, redirect a job's stdout
and stderr streams to a separate cache area while the job is running. The
contents are only copied to the normal locations when the job completes. This
means that \lstinline=cylc log= or the gcylc GUI will be unable to find the
means that \lstinline=cylc cat-log= or the gcylc GUI will be unable to find the
job's stdout and stderr streams while the job is running. Some sites with these
job submission methods are known to provide commands for viewing and/or
tail-follow a job's stdout and stderr streams that are redirected to these
Expand Down
4 changes: 2 additions & 2 deletions doc/siterc.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,7 +620,7 @@ \subsection{[hosts]}
\label{local-tail-template}

A template (with \lstinline=%(filename)s= substitution) for the command used to
tail-follow local job logs, used by the gcylc log viewer and
tail-follow local job logs, used by the gcylc cat-log viewer and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overzealous search-and-replace: this should remain "gcylc log viewer".

\lstinline=cylc cat-log --tail=. You are unlikely to need to override this.

\begin{myitemize}
Expand All @@ -632,7 +632,7 @@ \subsection{[hosts]}
\label{remote-tail-template}

A template (with \lstinline=%(filename)s= substitution) for the command used
to tail-follow remote job logs, used by the gcylc log viewer and
to tail-follow remote job logs, used by the gcylc cat-log viewer and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto.

\lstinline=cylc cat-log --tail=. The remote tail command needs to be told to
die when its parent process exits. You may need to override this command for
task hosts where the default \lstinline=tail= or \lstinline=ps= commands are
Expand Down