Skip to content

Commit ceb109f

Browse files
author
Alexey Semenyuk
committed
8380081: jpackage: Incorrect descriptions of win-specific options
Reviewed-by: nlisker, almatvee
1 parent a55656d commit ceb109f

3 files changed

Lines changed: 25 additions & 14 deletions

File tree

src/jdk.jpackage/share/classes/jdk/jpackage/internal/resources/HelpResources.properties

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -405,20 +405,24 @@ help.option.win-help-url=\
405405
\ URL where user can obtain further information or technical support
406406

407407
help.option.win-menu=\
408-
\ Request to add a Start menu shortcut for this application
408+
\ Adds a Start menu shortcut for this application, or requests\n\
409+
\ to do so if --win-shortcut-prompt is specified
409410

410411
help.option.win-menu-group=\
411412
\ Start Menu group this application is placed in
412413

413414
help.option.win-per-user-install=\
414-
\ Request to perform an install on a per-user basis
415+
\ Installs the application on a per-user basis.\n\
416+
\ Without this option installs per-machine
415417

416418
help.option.win-shortcut=\
417-
\ Request to add desktop shortcut for this application
419+
\ Adds a desktop shortcut for this application, or requests\n\
420+
\ to do so if --win-shortcut-prompt is specified
418421

419422
help.option.win-shortcut-prompt=\
420-
\ Adds a dialog to enable the user to choose if shortcuts\n\
421-
\ will be created by installer.
423+
\ Adds a dialog if at least one of --win-menu or --win-shortcut\n\
424+
\ are specified to enable the user to choose if these shortcuts\n\
425+
\ will be created by the installer
422426

423427
help.option.win-update-url=\
424428
\ URL of available application update information

src/jdk.jpackage/share/man/jpackage.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -410,23 +410,26 @@ The `jpackage` tool will take as input a Java application and a Java run-time im
410410

411411
<a id="option-win-menu">`--win-menu`</a>
412412

413-
: Request to add a Start Menu shortcut for this application
413+
: Adds a Start menu shortcut for this application, or requests to do so
414+
if --win-shortcut-prompt is specified
414415

415416
<a id="option-win-menu-group">`--win-menu-group` *menu-group-name*</a>
416417

417418
: Start Menu group this application is placed in
418419

419420
<a id="option-win-per-user-install">`--win-per-user-install`</a>
420421

421-
: Request to perform an install on a per-user basis
422+
: Installs the application on a per-user basis. Without this option installs per-machine
422423

423424
<a id="option-win-shortcut">`--win-shortcut`</a>
424425

425-
: Request to create a desktop shortcut for this application
426+
: Adds a desktop shortcut for this application, or requests to do so
427+
if --win-shortcut-prompt is specified
426428

427429
<a id="option-win-shortcut-prompt">`--win-shortcut-prompt`</a>
428430

429-
: Adds a dialog to enable the user to choose if shortcuts will be created by installer
431+
: Adds a dialog if at least one of --win-menu or --win-shortcut are specified
432+
to enable the user to choose if these shortcuts will be created by the installer
430433

431434
<a id="option-win-update-url">`--win-update-url` *url*</a>
432435

test/jdk/tools/jpackage/junit/share/jdk.jpackage/jdk/jpackage/internal/cli/help-windows.txt

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -189,16 +189,20 @@ Platform dependent options for creating the application package:
189189
--win-help-url <url>
190190
URL where user can obtain further information or technical support
191191
--win-menu [<shortcut startup directory>]
192-
Request to add a Start menu shortcut for this application
192+
Adds a Start menu shortcut for this application, or requests
193+
to do so if --win-shortcut-prompt is specified
193194
--win-menu-group <menu group name>
194195
Start Menu group this application is placed in
195196
--win-per-user-install
196-
Request to perform an install on a per-user basis
197+
Installs the application on a per-user basis.
198+
Without this option installs per-machine
197199
--win-shortcut [<shortcut startup directory>]
198-
Request to add desktop shortcut for this application
200+
Adds a desktop shortcut for this application, or requests
201+
to do so if --win-shortcut-prompt is specified
199202
--win-shortcut-prompt
200-
Adds a dialog to enable the user to choose if shortcuts
201-
will be created by installer.
203+
Adds a dialog if at least one of --win-menu or --win-shortcut
204+
are specified to enable the user to choose if these shortcuts
205+
will be created by the installer
202206
--win-update-url <url>
203207
URL of available application update information
204208
--win-upgrade-uuid <uuid>

0 commit comments

Comments
 (0)