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.

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

Fix "cylc cat-log" documentation. #2030

Merged
merged 2 commits into from
Oct 11, 2016
Merged

Fix "cylc cat-log" documentation. #2030

merged 2 commits into from
Oct 11, 2016

Conversation

jonnyhtw
Copy link
Contributor

@jonnyhtw jonnyhtw commented Oct 10, 2016

Minor changes to doc/cug.tex and doc/siterc.tex to change cylc log to cylc cat-log to remove ambiguity in searching the online Cylc user guide.

Close #2029

@hjoliver hjoliver changed the title Close #2029 Fix "cylc cat-log" documentation. Oct 10, 2016
@hjoliver hjoliver added this to the next release milestone Oct 10, 2016
@hjoliver
Copy link
Member

hjoliver commented Oct 10, 2016

@jonnyhtw - the changes look good, but you could clean up the history on this branch - it appears that you made the change on top of a git test branch of some kind with ~16 dummy commits that we don't really need in the cylc history. It should really contain just the relevant changes on a new branch off current master. (going offline with instructions...)

@jonnyhtw
Copy link
Contributor Author

Thanks @hjoliver

I did try to do this using a clean git clone but I guess the untidy dummy commit were in my forked master whereas I should have forked off the 'master master' branch...

Cheers

@matthewrmshin
Copy link
Contributor

@jonnyhtw You should do git rebase -i master on your branch. Squash all changesets except the 1st one. Push the change up to your Github fork with git push -f origin HEAD.

…endering of the cylc user guide online.
@@ -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".

@@ -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.

@hjoliver
Copy link
Member

@jonnyhtw - just two minor changes required.

@jonnyhtw
Copy link
Contributor Author

Hi @hjoliver

I have made those changes as requested and pushed them back to my branch on GitHub.

Cheers

@hjoliver
Copy link
Member

Thanks, got it, just waiting on the Travis build to complete (entirely unnecessary in this case!).

@hjoliver
Copy link
Member

No second review required - this is a straightforward small docs-only change.

@hjoliver hjoliver merged commit 754890c into cylc:master Oct 11, 2016
@hjoliver hjoliver added the bug label Oct 12, 2016
@jonnyhtw jonnyhtw deleted the cylc-cat-log-documentation-change branch November 29, 2016 02:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants