]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
repart: add sections to --help text
authorLennart Poettering <lennart@poettering.net>
Mon, 1 Jul 2024 08:25:38 +0000 (10:25 +0200)
committerLennart Poettering <lennart@poettering.net>
Mon, 1 Jul 2024 14:35:56 +0000 (16:35 +0200)
src/partition/repart.c

index fc5d61e47c18adf6398b1958675ef54d138265a7..a3a6605ae5120d254f8dceeb30abf1aacd464bed 100644 (file)
@@ -6931,26 +6931,38 @@ static int help(void) {
         if (r < 0)
                 return log_oom();
 
-        printf("%s [OPTIONS...] [DEVICE]\n"
-               "\n%sGrow and add partitions to partition table.%s\n\n"
+        printf("%1$s [OPTIONS...] [DEVICE]\n"
+               "\n%5$sGrow and add partitions to a partition table, and generate disk images (DDIs).%6$s\n\n"
                "  -h --help               Show this help\n"
                "     --version            Show package version\n"
                "     --no-pager           Do not pipe output into a pager\n"
                "     --no-legend          Do not show the headers and footers\n"
+               "\n%3$sOperation:%4$s\n"
                "     --dry-run=BOOL       Whether to run dry-run operation\n"
                "     --empty=MODE         One of refuse, allow, require, force, create; controls\n"
                "                          how to handle empty disks lacking partition tables\n"
+               "     --offline=BOOL       Whether to build the image offline\n"
                "     --discard=BOOL       Whether to discard backing blocks for new partitions\n"
+               "     --sector-size=SIZE   Set the logical sector size for the image\n"
+               "     --architecture=ARCH  Set the generic architecture for the image\n"
+               "     --size=BYTES         Grow loopback file to specified size\n"
+               "     --seed=UUID          128-bit seed UUID to derive all UUIDs from\n"
+               "     --split=BOOL         Whether to generate split artifacts\n"
+               "\n%3$sOutput:%4$s\n"
                "     --pretty=BOOL        Whether to show pretty summary before doing changes\n"
+               "     --json=pretty|short|off\n"
+               "                          Generate JSON output\n"
+               "\n%3$sFactory Reset:%4$s\n"
                "     --factory-reset=BOOL Whether to remove data partitions before recreating\n"
                "                          them\n"
                "     --can-factory-reset  Test whether factory reset is defined\n"
+               "\n%3$sConfiguration & Image Control:%4$s\n"
                "     --root=PATH          Operate relative to root path\n"
                "     --image=PATH         Operate relative to image file\n"
                "     --image-policy=POLICY\n"
                "                          Specify disk image dissection policy\n"
                "     --definitions=DIR    Find partition definitions in specified directory\n"
-               "     --key-file=PATH      Key to use when encrypting partitions\n"
+               "\n%3$sVerity:%4$s\n"
                "     --private-key=PATH|URI\n"
                "                          Private key to use when generating verity roothash\n"
                "                          signatures, or an engine or provider specific\n"
@@ -6961,6 +6973,8 @@ static int help(void) {
                "                          verity roothash signatures\n"
                "     --certificate=PATH   PEM certificate to use when generating verity\n"
                "                          roothash signatures\n"
+               "\n%3$sEncryption:%4$s\n"
+               "     --key-file=PATH      Key to use when encrypting partitions\n"
                "     --tpm2-device=PATH   Path to TPM2 device node to use\n"
                "     --tpm2-device-key=PATH\n"
                "                          Enroll a TPM2 device using its public key\n"
@@ -6974,11 +6988,7 @@ static int help(void) {
                "                          Enroll signed TPM2 PCR policy for specified TPM2 PCRs\n"
                "     --tpm2-pcrlock=PATH\n"
                "                          Specify pcrlock policy to lock against\n"
-               "     --seed=UUID          128-bit seed UUID to derive all UUIDs from\n"
-               "     --size=BYTES         Grow loopback file to specified size\n"
-               "     --json=pretty|short|off\n"
-               "                          Generate JSON output\n"
-               "     --split=BOOL         Whether to generate split artifacts\n"
+               "\n%3$sPartition Control:%4$s\n"
                "     --include-partitions=PARTITION1,PARTITION2,PARTITION3,…\n"
                "                          Ignore partitions not of the specified types\n"
                "     --exclude-partitions=PARTITION1,PARTITION2,PARTITION3,…\n"
@@ -6986,23 +6996,25 @@ static int help(void) {
                "     --defer-partitions=PARTITION1,PARTITION2,PARTITION3,…\n"
                "                          Take partitions of the specified types into account\n"
                "                          but don't populate them yet\n"
-               "     --sector-size=SIZE   Set the logical sector size for the image\n"
-               "     --architecture=ARCH  Set the generic architecture for the image\n"
-               "     --offline=BOOL       Whether to build the image offline\n"
+               "\n%3$sCopying:%4$s\n"
                "  -s --copy-source=PATH   Specify the primary source tree to copy files from\n"
                "     --copy-from=IMAGE    Copy partitions from the given image(s)\n"
+               "\n%3$sDDI Profile:%4$s\n"
                "  -S --make-ddi=sysext    Make a system extension DDI\n"
                "  -C --make-ddi=confext   Make a configuration extension DDI\n"
                "  -P --make-ddi=portable  Make a portable service DDI\n"
+               "\n%3$sAuxiliary Resource Generation:%4$s\n"
                "     --generate-fstab=PATH\n"
                "                          Write fstab configuration to the given path\n"
                "     --generate-crypttab=PATH\n"
                "                          Write crypttab configuration to the given path\n"
-               "\nSee the %s for details.\n",
+               "\nSee the %2$s for details.\n",
                program_invocation_short_name,
-               ansi_highlight(),
+               link,
+               ansi_underline(),
                ansi_normal(),
-               link);
+               ansi_highlight(),
+               ansi_normal());
 
         return 0;
 }