← Commit list

26fdc7c6e

Noelle Leigh
Noelle Leigh
2025-08-03
SUCCESS Duration: 158s

Subject

docs: Add links to cmd description from cmd list

Binary

No binary (build failed)

Architecture & Compiler Flags

Architecture: x86_64-linux-gnu Compiler: gcc (Ubuntu 11.4.0-1ubuntu1~22.04.3) 11.4.0

—

Build Log

(log yok)

Commit Diff GitHub →

Makefile.custom+2 -2
@@ -156,12 +156,12 @@ docs/busybox.pod: $(srctree)/docs/busybox_header.pod \
docs/BusyBox.txt: docs/busybox.pod
$(disp_doc)
$(Q)-mkdir -p docs
- $(Q)-pod2text $< > $@
+ $(Q)-pod2text --quotes=none $< > $@
docs/busybox.1: docs/busybox.pod
$(disp_doc)
$(Q)-mkdir -p docs
- $(Q)-pod2man --center=busybox --release="version $(KERNELVERSION)" $< > $@
+ $(Q)-pod2man --quotes=none --center=busybox --release="version $(KERNELVERSION)" $< > $@
docs/BusyBox.html: docs/busybox.net/BusyBox.html
$(disp_doc)
applets/usage_pod.c+12 -5
@@ -67,30 +67,37 @@ int main(void)
}
if (col == 0) {
col = 6;
- printf("\t");
} else {
printf(", ");
}
- printf("%s", usage_array[i].aname);
+ if (usage_array[i].usage[0] != NOUSAGE_STR[0]) {
+ /*
+ * If the applet usage string will be included in the final document
+ * optimistically link to its header (which is just the applet name).
+ */
+ printf("L<C<%1$s>|/\"%1$s\">", usage_array[i].aname);
+ } else {
+ /* Without a usage string, just output the applet name with no link. */
+ printf("C<%s>", usage_array[i].aname);
+ }
col += len2;
}
printf("\n\n");
printf("=head1 COMMAND DESCRIPTIONS\n\n");
- printf("=over 4\n\n");
for (i = 0; i < num_messages; i++) {
if (usage_array[i].aname[0] >= 'a' && usage_array[i].aname[0] <= 'z'
&& usage_array[i].usage[0] != NOUSAGE_STR[0]
) {
- printf("=item B<%s>\n\n", usage_array[i].aname);
+ /* This is the heading that will be linked from the command list. */
+ printf("=head2 %s\n\n", usage_array[i].aname);
if (usage_array[i].usage[0])
printf("%s %s\n\n", usage_array[i].aname, usage_array[i].usage);
else
printf("%s\n\n", usage_array[i].aname);
}
}
- printf("=back\n\n");
return 0;
}