RFR: 8356128: Correct documentation for --linux-package-deps [v2]

[Alexey Semenyuk]

On Wed, 21 May 2025 10:00:39 GMT, Stefan Lobbenmeier <duke at openjdk.org> wrote:

>> The documentation suggests that --linux-package-deps is a boolean option, while in fact it is a string option with dependencies separated by comma and space
>> 
>> You can tell that this option is supposed to have an argument here: https://github.com/openjdk/jdk/blob/fea5f2b1458cdd53f437e59caaffaa6e22fb59a7/src/jdk.jpackage/linux/classes/jdk/jpackage/internal/LinuxPackageBundler.java#L366-L372
>
> Stefan Lobbenmeier has updated the pull request incrementally with one additional commit since the last revision:
> 
>   change cli option to single string as suggested in PR review

Changes requested by asemenyuk (Reviewer).

src/jdk.jpackage/share/classes/jdk/jpackage/internal/resources/HelpResources_de.properties line 36:

> 34: MSG_Help_mac_install=\  --mac-dmg-content <Pfad zu zusätzlichem Inhalt>[,<Pfad zu zusätzlichem Inhalt>...]\n          Nimmt den gesamten referenzierten Inhalt in die DMG-Datei auf.\n          Diese Option kann mehrmals verwendet werden. \n
> 35: MSG_Help_mac_launcher=\  --mac-package-identifier <ID-Zeichenfolge>\n          Eine ID, die die Anwendung für macOS eindeutig identifiziert\n          Standardwert ist der Hauptklassenname.\n          Es dürfen nur alphanumerische Zeichen (A-Z, a-z, 0-9), Bindestriche (-)\n          und Punkte (.) verwendet werden.\n  --mac-package-name <Namenszeichenfolge>\n          Name der Anwendung, wie in der Menüleiste angezeigt\n          Dieser kann vom Anwendungsnamen abweichen.\n          Er darf maximal 15 Zeichen enthalten und muss für die Anzeige\n          in der Menüleiste und im Infofenster der Anwendung geeignet sein.\n          Standardwert: Anwendungsname.\n  --mac-package-signing-prefix <Präfixzeichenfolge>\n          Beim Signieren des Anwendungspackages wird dieser Wert\n          allen zu signierenden Komponenten ohne vorhandene\n          Package-ID als Präfix vorangestellt.\n  --mac-sign\n          Anforderung zum Signieren des Packages oder des vordefinierten\n
 Anwendungsimages\n  --mac-signing-keychain <Schlüsselbundname>\n          Name des Schlüsselbundes für die Suche nach der Signaturidentität\n          Bei fehlender Angabe werden die Standardschlüsselbunde verwendet.\n  --mac-signing-key-user-name <Teamname>\n          Team- oder Benutzernamensteil der Apple-Signaturidentitäten. Um direkt zu steuern,\n          welche Signaturidentität zum Signieren eines Anwendungsimages oder\n          Installationsprogramms verwendet wird, verwenden Sie --mac-app-image-sign-identity und/oder\n          --mac-installer-sign-identity. Diese Option kann nicht mit\n          --mac-app-image-sign-identity oder --mac-installer-sign-identity kombiniert werden.\n  --mac-app-image-sign-identity <identity>\n          Zum Signieren des Anwendungsimages verwendete Identität. Dieser Wert wird\n          direkt an die Option --sign des Tools "codesign" übergeben. Diese Option kann nicht\n          mit --mac-signing-key-user-name kombiniert werden.\n  
 --mac-installer-sign-identity <identity>\n          Zum Signieren des Installationsprogramms "pkg" verwendete Identität. Dieser Wert wird\n          direkt an die Option --sign des Tools "productbuild" übergeben. Diese Option\n          kann nicht mit --mac-signing-key-user-name kombiniert werden.\n  --mac-app-store\n          Gibt an, dass die jpackage-Ausgabe für den\n          Mac App Store bestimmt ist.\n  --mac-entitlements <Dateipfad>\n          Pfad zu einer Datei mit Berechtigungen, die beim Signieren\n          von ausführbaren Dateien und Librarys im Bundle verwendet werden sollen.\n  --mac-app-category <Kategoriezeichenfolge>\n          Zeichenfolge für das Erstellen von LSApplicationCategoryType in\n          Anwendungs-plist. Standardwert: "utilities".\n
> 36: MSG_Help_linux_install=\  --linux-package-name <Packagename>\n          Name für das Linux-Package, Standardwert: Anwendungsname\n  --linux-deb-maintainer <E-Mail-Adresse>\n          Maintainer für .deb-Package\n  --linux-menu-group <Menügruppenname>\n          Menügruppe, in der diese Anwendung abgelegt wird\n  --linux-package-deps <Paketabhängigkeit>[, <Paketabhängigkeit>...]\n          Erforderliche Packages oder Funktionen für die Anwendung\n  --linux-rpm-license-type <Typzeichenfolge>\n          Typ der Lizenz ("License: <Wert>" der RPM-SPEC-Datei)\n  --linux-app-release <Releasewert>\n          Releasewert der RPM-SPEC-Datei <Name> oder \n          Debian-Revisionswert der DEB-Kontrolldatei\n  --linux-app-category <Kategoriewert>\n          Gruppenwert der RPM-SPEC-Datei <Name> oder \n          Abschnittswert der DEB-Kontrolldatei\n  --linux-shortcut\n          Erstellt eine Verknüpfung für die Anwendung.\n

`--linux-package-deps <package-dep-string>` to sync with HelpResources.properties

src/jdk.jpackage/share/classes/jdk/jpackage/internal/resources/HelpResources_ja.properties line 39:

> 37: MSG_Help_mac_launcher=\  --mac-package-identifier <ID string>\n          macOSのアプリケーションを一意に識別するID\n          メイン・クラス名にデフォルト設定されています。\n          英数字(A-Z、a-z、0-9)、ハイフン(-)およびピリオド(.)文字のみ\n          使用できます。\n  --mac-package-name <name string>\n          メニュー・バーに表示されるアプリケーションの名前\n          アプリケーション名とは異なります。\n          この名前は16æ–‡å­—æœªæº€ã«ã™ã‚‹å¿…è¦ãŒã‚ã‚Šã€ãƒ¡ãƒ‹ãƒ¥ãƒ¼ãƒ»ãƒãƒ¼ãŠã‚ˆã³ã‚¢ãƒ—ãƒªã‚±ãƒ¼ã‚·ãƒ§ãƒ³æƒ…å ±ã‚¦ã‚£ãƒ³ãƒ‰ã‚¦ã«\n          表示するのに適している必要があります。\n          アプリケーション名にデフォルト設定されています。\n  --mac-package-signing-prefix <prefix string>\n          アプリケーション・パッケージに署名する際、\n          既存のパッケージIDのない署
 名が必要なすべてのコンポーネントに、\n          ã“ã®å€¤ãŒæŽ¥é ­è¾žã¨ã—ã¦ä»˜ã‘ã‚‰ã‚Œã¾ã™ã€‚\n  --mac-sign\n          パッケージまたは事前定義済アプリケーション・イメージに署名するよう\n          リクエストします。\n  --mac-signing-keychain <keychain name>\n          署名アイデンティティを検索するキーチェーンの名前\n          æŒ‡å®šã—ãªã‹ã£ãŸå ´åˆã€æ¨™æº–ã®ã‚­ãƒ¼ãƒã‚§ãƒ¼ãƒ³ãŒä½¿ç”¨ã•ã‚Œã¾ã™ã€‚\n  --mac-signing-key-user-name <team name>\n          Apple署名アイデンティティのチームまたはユーザー名部分。\n          アプリケーション・イメージまたはインストーラの署名に使用する署名アイデンティティの\n          直接制御には、--mac-app-image-sign-identityまたは\n          --mac-installer-sign-identity(あるいは両方)を使用します。このオプションは\n          --mac-app-image-sign-identityまたは
 --mac-installer-sign-identityと組み合せることはできません。\n  --mac-app-image-sign-identity <identity>\n          アプリケーション・イメージの署名に使用するアイデンティティ。この値は直接\n          "codesign"ツールの--signオプションに渡されます。このオプションは\n          \
> 38: --mac-signing-key-user-nameと組み合せることはできません。\n  --mac-installer-sign-identity <identity>\n          "pkg"インストーラの署名に使用するアイデンティティ。この値は直接\n          "productbuild"ツールの--signオプションに渡されます。このオプションは\n          --mac-signing-key-user-nameと組み合せることはできません。\n  --mac-app-store\n          jpackage出力がMac App Store用であること\n          を示します。\n  --mac-entitlements <file path>\n          バンドルの実行可能ファイルおよびライブラリの署名時に\n          使用する権限を含むファイルのパス。\n  --mac-app-category <category string>\n          アプリケーションのplistのLSApplicationCategoryTypeを生成する際に使用する文字列。\n          デフォルト値は"utilities"です。\n
> 39: MSG_Help_linux_install=\  --linux-package-name <package name>\n          Linuxパッケージの名前。アプリケーション名にデフォルト設定されています\n  --linux-deb-maintainer <email address>\n          .debパッケージのMaintainer\n  --linux-menu-group <menu-group-name>\n          このアプリケーションが配置されているメニュー・グループ\n  --linux-package-deps <package-dep>[, <package-dep>...]\n          アプリケーションに必要なパッケージまたは機能\n  --linux-rpm-license-type <type string>\n          ライセンスのタイプ(RPM .specの"License: <value>")\n  --linux-app-release <release value>\n          RPM <name>.specファイルのリリース値または\n          DEBコントロール・ファイルのDebianリビジョン値。\n  --linux-app-category <category value>\n          RPM <name>.specファイルのグループ値または \n           DEBコントロール・ファイルのセクã
 ‚·ãƒ§ãƒ³å€¤\n  --linux-shortcut\n          アプリケーションのショートカットを作成します。\n

`--linux-package-deps <package-dep-string>` to sync with HelpResources.properties

src/jdk.jpackage/share/classes/jdk/jpackage/internal/resources/HelpResources_zh_CN.properties line 37:

> 35: MSG_Help_mac_install=\  --mac-dmg-content <additional content path>[,<additional content path>...]\n          包括 DMG 中引用的所有内容。\n          此选项可以使用多次。\n
> 36: MSG_Help_mac_launcher=\  --mac-package-identifier <ID string>\n          ç”¨æ¥å”¯ä¸€åœ°æ ‡è¯† macOS åº”ç”¨ç¨‹åºçš„æ ‡è¯†ç¬¦\n          默认为主类名称。\n          只能使用字母数字 (A-Z,a-z,0-9)、连字符 (-) å’Œ\n          句点 (.) 字符。\n  --mac-package-name <name string>\n          å‡ºçŽ°åœ¨èœå•æ ä¸­çš„åº”ç”¨ç¨‹åºåç§°\n          这可以与应用程序名称不同。\n          此名称的长度必须小于 16 个字符，适合\n          æ˜¾ç¤ºåœ¨èœå•æ ä¸­å’Œåº”ç”¨ç¨‹åºâ€œä¿¡æ¯â€çª—å£ä¸­ã€‚\n          默认为应用程序名称。\n  --mac-package-signing-prefix <prefix string>\n          在对应用程序包签名时，会在所有需要签名\n          ä½†å½“å‰æ²¡æœ‰ç¨‹åºåŒ…æ ‡è¯†ç¬¦çš„ç»„ä»¶çš„\n          å‰é¢åŠ ä¸Šæ­¤å€¼ã€‚\n  --mac-sign\n          è¯·æ±‚å¯¹ç¨‹åºåŒ…æˆ–é¢„å®šä¹‰çš„åº”ç”¨ç¨‹åºæ˜ åƒ\n          进行签名。\n  --mac-signing-keychain <keychain name>\n          要用来搜索签名身份的密钥链的名
 称\n          å¦‚æžœæœªæŒ‡å®šï¼Œåˆ™ä½¿ç”¨æ ‡å‡†çš„å¯†é’¥é“¾ã€‚\n  --mac-signing-key-user-name <team name>\n          Apple 签名身份的团队或用户名称部分。为了直接\n          æŽ§åˆ¶ç”¨äºŽå¯¹åº”ç”¨ç¨‹åºæ˜ åƒæˆ–å®‰è£…ç¨‹åºè¿›è¡Œç­¾åçš„\n          签名身份，请使用 --mac-app-image-sign-identity å’Œ/或\n          --mac-installer-sign-identity。此选项不能与\n          --mac-app-image-sign-identity 或 --mac-installer-sign-identity 结合使用。\n  --mac-app-image-sign-identity <identity>\n          ç”¨äºŽå¯¹åº”ç”¨ç¨‹åºæ˜ åƒè¿›è¡Œç­¾åçš„èº«ä»½ã€‚æ­¤å€¼å°†ç›´æŽ¥\n          ä¼ é€’è‡³ "codesign" 工具的 --sign 选项。此选项不能\n          与 --mac-signing-key-user-name 结合使用。\n  --mac-installer-sign-identity <identity>\n          用于对 "pkg" 安装程序进行签名的身份。此值将直接\n          ä¼ é€’è‡³ "productbuild" 工具的 --sign 选项。此选项不能\n          与 --mac-signing-key-user-name 结合使用ã€
 ‚\n  --mac-app-store\n          指示 jpackage 输出面向\n          Mac App Store。\n  --mac-entitlements <file path>\n          包含一些权利的文件的路径，在对捆绑包中的可执行文件\n          和库进行签名时会使用这些权利。\n  --mac-app-category <category string>\n          ç”¨äºŽæž„é€ åº”ç”¨ç¨‹åº plist 中 LSApplicationCategoryType çš„\n          字符串。默认值为 "utilities"。\n
> 37: MSG_Help_linux_install=\  --linux-package-name <package name>\n          Linux 程序包的名称，默认为应用程序名称\n  --linux-deb-maintainer <email address>\n          .deb 程序包的维护程序\n  --linux-menu-group <menu-group-name>\n          此应用程序所在的菜单组\n  --linux-package-deps <package-dep>[, <package-dep>...]\n          应用程序所需的程序包或功能\n  --linux-rpm-license-type <type string>\n          许可证的类型（RPM .spec 的 "License: <value>"）\n  --linux-app-release <release value>\n          RPM <name>.spec 文件的发行版值或 \n          DEB 控制文件的 Debian 修订版值\n  --linux-app-category <category value>\n          RPM <name>.spec 文件的组值或 \n          DEB 控制文件的节值\n  --linux-shortcut\n          为应用程序创建快捷方式。\n

`--linux-package-deps <package-dep-string>` to sync with HelpResources.properties

src/jdk.jpackage/share/man/jpackage.md line 426:

> 424: :   Menu group this application is placed in
> 425: 
> 426: <a id="option-linux-package-deps">`--linux-package-deps *package-dep* \[`,`*package-dep*...\]`</a>

Should be *package-dep-string* to sync with HelpResources.properties

-------------

PR Review: https://git.openjdk.org/jdk/pull/23638#pullrequestreview-2857464848
PR Review Comment: https://git.openjdk.org/jdk/pull/23638#discussion_r2100125034
PR Review Comment: https://git.openjdk.org/jdk/pull/23638#discussion_r2100125279
PR Review Comment: https://git.openjdk.org/jdk/pull/23638#discussion_r2100125547
PR Review Comment: https://git.openjdk.org/jdk/pull/23638#discussion_r2100122529