Clarify install target docs. - #7315
Draft
hjoliver wants to merge 2 commits into
Draft
Conversation
1 task
MetRonnie
reviewed
May 21, 2026
Member
There was a problem hiding this comment.
Base branch should be 8.6.x, also lint failing currently.
Also I would be tempted to also do this to avoid confusion:
diff --git a/etc/conf/global.cylc b/etc/conf/global.cylc
index d02870936..14e644846 100644
--- a/etc/conf/global.cylc
+++ b/etc/conf/global.cylc
@@ -9,3 +9,3 @@
hosts = _remote_background_indep_tcp
- install target = _remote_background_indep_tcp
+ install target = indep
#[[_remote_background_indep_ssh]]
@@ -14,3 +14,3 @@
# hosts = _remote_background_indep_tcp
- # install target = _remote_background_indep_tcp
+ # install target = indep
# communication method = ssh
@@ -20,6 +20,6 @@
hosts = _remote_background_indep_tcp
- install target = _remote_background_indep_tcp
+ install target = indep
[[_remote_background_indep_poll]]
hosts = _remote_background_indep_poll
- install target = _remote_background_indep_poll
+ install target = indep
communication method = poll
@@ -31,3 +31,3 @@
hosts = _remote_background_indep_poll
- install target = _remote_background_indep_poll
+ install target = indep
communication method = poll
@@ -37,2 +37,3 @@
# hosts = _remote_background_shared_tcp
+ # install target = localhost
#[[_remote_background_shared_ssh]]
@@ -42,2 +43,3 @@
# communication method = ssh
+ # install target = localhost
#[[_remote_background_shared_poll]]
@@ -47 +49,2 @@
# submission polling intervals = PT1S
+ # install target = localhost
oliver-sanders
marked this pull request as draft
August 4, 2026 12:16
Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>
Member
Author
|
(Leaving this alone until questions on the main doc PR are resolved) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Companion of cylc/cylc-doc#929
Current docs are a bit misleading (IMO) on exactly what an
install targetis.Question: can we also change
install target = localhostin various example to something else, e.g.local_clusterto make it more obvious that an install target is not a hostname?Check List
CONTRIBUTING.mdand added my name as a Code Contributor.setup.cfg(andconda-environment.ymlif present).?.?.xbranch.