Skip to content

Commit 5317b91

Browse files
committed
Update help msg
1 parent 1ff3809 commit 5317b91

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

components/gitpod-cli/cmd/jetbrains-gradle-pause.go

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ const gradleSyncLockFile = "/tmp/gitpod-gradle.lock"
1414

1515
var jetbrainsGradlePauseCmd = &cobra.Command{
1616
Use: "pause",
17-
Short: "Pause Gradle Sync in JetBrains IDEs",
18-
Long: `Pause JetBrains IDE gradle sync to prevent performance issues on Gitpod workspace startup when there's no Prebuilds ready.
17+
Short: "Pause JetBrains' builtin automatic Gradle Sync",
18+
Long: `Pause JetBrains' builtin automatic Gradle Sync to prevent performance issues on Gitpod workspace startup when there's no Prebuilds ready.
1919
2020
This command is typically used to prevent concurrent Gradle syncs between:
2121
- Manual gradle initialization in Gitpod init tasks
@@ -25,25 +25,27 @@ Typical usage in your .gitpod.yml:
2525
2626
tasks:
2727
- init: |
28-
gp jetbrains gradle pause # Prevent JetBrains' gradle sync
29-
...
28+
gp jetbrains gradle pause # Prevent JetBrains' auto gradle sync at beginning
29+
...
3030
./gradlew <init_service> # Run your initialization tasks
31-
gp jetbrains gradle resume # Enable
31+
gp jetbrains gradle resume # Enable
3232
command: ./gradlew <dev_service>
3333
3434
If you have two init tasks want to pause Gradle Sync:
3535
3636
tasks:
3737
- name: Task 1
3838
init: |
39-
gp jetbrains gradle pause # Prevent JetBrains' gradle sync
39+
gp jetbrains gradle pause # Prevent JetBrains' auto gradle sync
4040
./gradlew <init_service>
4141
gp sync-await gradle-init-1
4242
gp jetbrains gradle resume # Enable
4343
- name: Task 2
4444
init: |
4545
./gradlew <init_service>
4646
gp sync-done gradle-init-1
47+
- name: Task 3
48+
command: echo hi there
4749
`,
4850
RunE: func(cmd *cobra.Command, args []string) error {
4951
err := os.WriteFile(gradleSyncLockFile, []byte{}, 0644)

components/gitpod-cli/cmd/jetbrains-gradle-resume.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212

1313
var jetbrainsGradleResumeCmd = &cobra.Command{
1414
Use: "resume",
15-
Short: "Resume paused Gradle Sync in JetBrains IDEs",
15+
Short: "Resume paused Gradle Sync",
1616
RunE: func(cmd *cobra.Command, args []string) error {
1717
err := os.Remove(gradleSyncLockFile)
1818
if err != nil && os.IsNotExist(err) {

0 commit comments

Comments
 (0)