docs: improve CLI pass-through argument documentation for Windows (#1336)

[rishi919-rgb]

Platforms affected

Documentation / CLI (All platforms, specifically Windows Command Prompt and PowerShell, Android, iOS)

Motivation and Context

Fixes #1336

On Windows using Command Prompt or PowerShell, passing platform-specific arguments using the intermediate -- separator requires enclosing the -- in quotation marks ("--"). Without quotes, PowerShell throws syntax/parse errors or treats -- as a parameter terminator, leading to argument forwarding failures (as reported in apache/cordova-android#1671).

Description

• Changed articles
  • CLI Guide: docs/en/latest/guide/cli/index.md
  • Android Platform Guide: docs/en/latest/guide/platforms/android/index.md
  • iOS Platform Guide: docs/en/latest/guide/platforms/ios/index.md

Following reviewer feedback:

• Standard CLI examples across Android, iOS, and the CLI guide continue to use the standard unquoted -- separator (Unix/macOS).
• Added explicit, dedicated notes for Windows users explaining that on Windows (Command Prompt and PowerShell), the -- separator must be enclosed in quotation marks ("--"), with accompanying examples.
• Added a dedicated "Passing Platform-Specific Arguments" subsection in the Cordova CLI guide (guide/cli/index.md) with concrete examples for Android (Gradle parameters, signing / packageType) and links to platform guides.

Testing

• Executed npm test (npm run lint), passing with 0 errors.
• Verified Markdown syntax and links across modified documentation files.

Checklist

• I've run the tests to see all new and existing tests pass
• I added automated test coverage as appropriate for this change
• Commit is prefixed with (platform) if this change only applies to one platform (e.g. (android))
• If this Pull Request resolves an issue, I linked to the issue in the text above (and used the correct keyword to close issues using keywords)
• I've updated the documentation if necessary

[GitToTheHub]

I would leave the documentation examples to use just -- and note, that these are Unix/macOS examples. A note can be added, that on Windows the -- has to be enclosed in quotation marks. Giving Unix/macOS users more verbosed samples than necessary is also not a good solution.

[rishi919-rgb]

Thanks for the feedback @GitToTheHub! That makes complete sense.

I have updated the changes accordingly:

• Kept the standard CLI examples using the clean, unquoted -- separator (Unix/macOS).
• Added dedicated notes specifically clarifying that on Windows (Command Prompt and PowerShell), the -- separator must be enclosed in quotation marks ("--"), with accompanying Windows examples.

The commit has been amended and force-pushed.

[rishi919-rgb]

Thanks again for the thorough review and helpful suggestions @GitToTheHub!

I have updated the PR to incorporate all of your feedback:

• **\guide/cli/index.md**: Removed the platform guide links from the Windows note blockquote and added them under See Also: (linking Android to \index.html\ like iOS).
• **\platforms/android/index.md**:
  • Replaced verbose explanation notes with direct **Example (Windows):\ code blocks alongside **Example (Unix/macOS):\ across the --gradleArg, --jvmargs, and signing sections.
  • Clarified the environment variable example header to **Example (Unix/macOS):**.
• \platforms/ios/index.md**: Updated the example header to **Example (Unix/macOS):\ and removed the unnecessary Windows note.

The commit has been amended and force-pushed.

[GitToTheHub]

Hi I found one thing which should be changed. Also there exists a Cordova Command-line-interface (CLI) Commands article, which is generated from apache/cordova-cli/doc/readme.md. This should be changed accordingly.

[GitToTheHub]

The Windows JVM example uses single quotes. Command Prompt passes those quotes literally, so Cordova writes '-Xmx4g' into org.gradle.jvmargs, producing an invalid JVM argument. Use double quotes, which work in both Windows shells.

[rishi919-rgb]

Updated to double quotes (\-Xmx4g\) so it works across both Command Prompt and PowerShell without passing literal single quotes.

[GitToTheHub]

I added the articles you change in the description

[rishi919-rgb]

Thanks @GitToTheHub!

• Appreciate you updating the changed articles list in the description.
• Rebased on latest master and updated the Windows JVM args example to use double quotes ("--jvmargs=\"-Xmx4g\"").
• Regarding apache/cordova-cli/doc/readme.md: makes total sense. I can submit a companion PR over in apache/cordova-cli to update the -- pass-through notes and examples there as well.

[GitToTheHub]

Would be good if you could make a follow up PR on apache/cordova-cli

[rishi919-rgb]

Done! I've opened the follow-up PR on \�pache/cordova-cli\ here: apache/cordova-cli#735

[GitToTheHub]

Nice, I will have a look on it