Remove requirement that include/applets.h must be sorted

First, I _again_ violated it - two xz-related applets are in wrong positions.
Second, planned in-applet help text thing will be so much easier without
this requirement...

Signed-off-by: Denys Vlasenko <vda.linux@googlemail.com>
This commit is contained in:
Denys Vlasenko 2010-06-05 23:11:07 +02:00
parent 729ce47360
commit 0e5ba0843b
6 changed files with 103 additions and 75 deletions

View File

@ -83,7 +83,7 @@ config SHOW_USAGE
config FEATURE_VERBOSE_USAGE config FEATURE_VERBOSE_USAGE
bool "Show verbose applet usage messages" bool "Show verbose applet usage messages"
default n default n
select SHOW_USAGE depends on SHOW_USAGE
help help
All BusyBox applets will show more verbose help messages when All BusyBox applets will show more verbose help messages when
busybox is invoked with --help. This will add a lot of text to the busybox is invoked with --help. This will add a lot of text to the

View File

@ -5,9 +5,9 @@
* Licensed under GPLv2, see file LICENSE in this tarball for details. * Licensed under GPLv2, see file LICENSE in this tarball for details.
*/ */
#include <unistd.h> #include <unistd.h>
#include <stdlib.h>
#include <string.h>
/* Just #include "autoconf.h" doesn't work for builds in separate
* object directory */
#include "autoconf.h" #include "autoconf.h"
/* Since we can't use platform.h, have to do this again by hand: */ /* Since we can't use platform.h, have to do this again by hand: */
@ -21,14 +21,35 @@
# define USE_FOR_MMU(...) __VA_ARGS__ # define USE_FOR_MMU(...) __VA_ARGS__
#endif #endif
static const char usage_messages[] = ""
#define MAKE_USAGE
#include "usage.h" #include "usage.h"
#define MAKE_USAGE(aname, usage) { aname, usage },
static struct usage_data {
const char *aname;
const char *usage;
} usage_array[] = {
#include "applets.h" #include "applets.h"
; };
static int compare_func(const void *a, const void *b)
{
const struct usage_data *ua = a;
const struct usage_data *ub = b;
return strcmp(ua->aname, ub->aname);
}
int main(void) int main(void)
{ {
write(STDOUT_FILENO, usage_messages, sizeof(usage_messages)); int i;
int num_messages = sizeof(usage_array) / sizeof(usage_array[0]);
if (num_messages == 0)
return 0;
qsort(usage_array,
num_messages, sizeof(usage_array[0]),
compare_func);
for (i = 0; i < num_messages; i++)
write(STDOUT_FILENO, usage_array[i].usage, strlen(usage_array[i].usage) + 1);
return 0; return 0;
} }

View File

@ -9,12 +9,19 @@ test -x "$loc/usage" || exit 1
test "$SED" || SED=sed test "$SED" || SED=sed
test "$DD" || DD=dd test "$DD" || DD=dd
sz=`"$loc/usage" | wc -c` || exit 1
exec >"$target" exec >"$target"
echo 'static const char packed_usage[] ALIGN1 = {' echo '#define UNPACKED_USAGE \'
"$loc/usage" | od -v -t x1 \
| $SED -e 's/^[^ ]*//' \
-e 's/ //g' \
-e '/^$/d' \
-e 's/\(..\)/\\x\1/g' \
-e 's/^/"/' \
-e 's/$/" \\/'
echo ''
echo '#define PACKED_USAGE \'
## Breaks on big-endian systems! ## Breaks on big-endian systems!
## # Extra effort to avoid using "od -t x1": -t is not available ## # Extra effort to avoid using "od -t x1": -t is not available
## # in non-CONFIG_DESKTOPed busybox od ## # in non-CONFIG_DESKTOPed busybox od
@ -24,12 +31,11 @@ echo 'static const char packed_usage[] ALIGN1 = {'
## -e 's/ //g' \ ## -e 's/ //g' \
## -e '/^$/d' \ ## -e '/^$/d' \
## -e 's/\(..\)\(..\)/0x\2,0x\1,/g' ## -e 's/\(..\)\(..\)/0x\2,0x\1,/g'
## -e 's/$/ \\/'
"$loc/usage" | bzip2 -1 | $DD bs=2 skip=1 2>/dev/null | od -v -t x1 \ "$loc/usage" | bzip2 -1 | $DD bs=2 skip=1 2>/dev/null | od -v -t x1 \
| $SED -e 's/^[^ ]*//' \ | $SED -e 's/^[^ ]*//' \
-e 's/ //g' \ -e 's/ //g' \
-e '/^$/d' \ -e '/^$/d' \
-e 's/\(..\)/0x\1,/g' -e 's/\(..\)/0x\1,/g' \
-e 's/$/ \\/'
echo '};' echo ''
echo '#define SIZEOF_usage_messages' `expr 0 + $sz`

View File

@ -6,11 +6,10 @@
*/ */
#include <unistd.h> #include <unistd.h>
#include <stdint.h> #include <stdint.h>
#include <stdlib.h>
#include <string.h> #include <string.h>
#include <stdio.h> #include <stdio.h>
/* Just #include "autoconf.h" doesn't work for builds in separate
* object directory */
#include "autoconf.h" #include "autoconf.h"
#define SKIP_applet_main #define SKIP_applet_main
@ -29,22 +28,39 @@
# define USE_FOR_MMU(...) __VA_ARGS__ # define USE_FOR_MMU(...) __VA_ARGS__
#endif #endif
static const char usage_messages[] = ""
#define MAKE_USAGE
#include "usage.h" #include "usage.h"
#define MAKE_USAGE(aname, usage) { aname, usage },
static struct usage_data {
const char *aname;
const char *usage;
} usage_array[] = {
#include "applets.h" #include "applets.h"
; };
static int compare_func(const void *a, const void *b)
{
const struct usage_data *ua = a;
const struct usage_data *ub = b;
return strcmp(ua->aname, ub->aname);
}
int main(void) int main(void)
{ {
const char *names;
const char *usage;
int col, len2; int col, len2;
int i;
int num_messages = sizeof(usage_array) / sizeof(usage_array[0]);
if (num_messages == 0)
return 0;
qsort(usage_array,
num_messages, sizeof(usage_array[0]),
compare_func);
col = 0; col = 0;
names = applet_names; for (i = 0; i < num_messages; i++) {
while (*names) { len2 = strlen(usage_array[i].aname) + 2;
len2 = strlen(names) + 2;
if (col >= 76 - len2) { if (col >= 76 - len2) {
printf(",\n"); printf(",\n");
col = 0; col = 0;
@ -55,29 +71,24 @@ int main(void)
} else { } else {
printf(", "); printf(", ");
} }
printf(names); printf(usage_array[i].aname);
col += len2; col += len2;
names += len2 - 1;
} }
printf("\n\n"); printf("\n\n");
printf("=head1 COMMAND DESCRIPTIONS\n\n"); printf("=head1 COMMAND DESCRIPTIONS\n\n");
printf("=over 4\n\n"); printf("=over 4\n\n");
names = applet_names; for (i = 0; i < num_messages; i++) {
usage = usage_messages; if (usage_array[i].aname[0] >= 'a' && usage_array[i].aname[0] <= 'z'
while (*names) { && usage_array[i].usage[0] != NOUSAGE_STR[0]
if (*names >= 'a' && *names <= 'z'
&& *usage != NOUSAGE_STR[0]
) { ) {
printf("=item B<%s>\n\n", names); printf("=item B<%s>\n\n", usage_array[i].aname);
if (*usage) if (usage_array[i].usage[0])
printf("%s %s\n\n", names, usage); printf("%s %s\n\n", usage_array[i].aname, usage_array[i].usage);
else else
printf("%s\n\n", names); printf("%s\n\n", usage_array[i].aname);
} }
names += strlen(names) + 1;
usage += strlen(usage) + 1;
} }
return 0; return 0;
} }

View File

@ -4,11 +4,6 @@
* *
* If you write a new applet, you need to add an entry to this list to make * If you write a new applet, you need to add an entry to this list to make
* busybox aware of it. * busybox aware of it.
*
* It is CRUCIAL that this listing be kept in ascii order, otherwise the binary
* search lookup contributed by Gaute B Strokkenes stops working. If you value
* your kneecaps, you'll be sure to *make sure* that any changes made to this
* file result in the listing remaining in ascii order. You have been warned.
*/ */
/* /*
@ -36,16 +31,16 @@ s - suid type:
# define APPLET_NOFORK(name,main,l,s,name2) name main##_main name2 # define APPLET_NOFORK(name,main,l,s,name2) name main##_main name2
#elif defined(MAKE_USAGE) && ENABLE_FEATURE_VERBOSE_USAGE #elif defined(MAKE_USAGE) && ENABLE_FEATURE_VERBOSE_USAGE
# define APPLET(name,l,s) name##_trivial_usage name##_full_usage "\0" # define APPLET(name,l,s) MAKE_USAGE(#name, name##_trivial_usage name##_full_usage)
# define APPLET_ODDNAME(name,main,l,s,name2) name2##_trivial_usage name2##_full_usage "\0" # define APPLET_ODDNAME(name,main,l,s,name2) MAKE_USAGE(#name, name2##_trivial_usage name2##_full_usage)
# define APPLET_NOEXEC(name,main,l,s,name2) name2##_trivial_usage name2##_full_usage "\0" # define APPLET_NOEXEC(name,main,l,s,name2) MAKE_USAGE(#name, name2##_trivial_usage name2##_full_usage)
# define APPLET_NOFORK(name,main,l,s,name2) name2##_trivial_usage name2##_full_usage "\0" # define APPLET_NOFORK(name,main,l,s,name2) MAKE_USAGE(#name, name2##_trivial_usage name2##_full_usage)
#elif defined(MAKE_USAGE) && !ENABLE_FEATURE_VERBOSE_USAGE #elif defined(MAKE_USAGE) && !ENABLE_FEATURE_VERBOSE_USAGE
# define APPLET(name,l,s) name##_trivial_usage "\0" # define APPLET(name,l,s) MAKE_USAGE(#name, name##_trivial_usage)
# define APPLET_ODDNAME(name,main,l,s,name2) name2##_trivial_usage "\0" # define APPLET_ODDNAME(name,main,l,s,name2) MAKE_USAGE(#name, name2##_trivial_usage)
# define APPLET_NOEXEC(name,main,l,s,name2) name2##_trivial_usage "\0" # define APPLET_NOEXEC(name,main,l,s,name2) MAKE_USAGE(#name, name2##_trivial_usage)
# define APPLET_NOFORK(name,main,l,s,name2) name2##_trivial_usage "\0" # define APPLET_NOFORK(name,main,l,s,name2) MAKE_USAGE(#name, name2##_trivial_usage)
#elif defined(MAKE_LINKS) #elif defined(MAKE_LINKS)
# define APPLET(name,l,c) LINK l name # define APPLET(name,l,c) LINK l name

View File

@ -43,35 +43,30 @@
#include "applets.h" #include "applets.h"
#undef PROTOTYPES #undef PROTOTYPES
#if ENABLE_SHOW_USAGE && !ENABLE_FEATURE_COMPRESS_USAGE
/* Define usage_messages[] */
static const char usage_messages[] ALIGN1 = ""
# define MAKE_USAGE
# include "usage.h"
# include "applets.h"
;
# undef MAKE_USAGE
#else
# define usage_messages 0
#endif /* SHOW_USAGE */
/* Include generated applet names, pointers to <applet>_main, etc */ /* Include generated applet names, pointers to <applet>_main, etc */
#include "applet_tables.h" #include "applet_tables.h"
/* ...and if applet_tables generator says we have only one applet... */ /* ...and if applet_tables generator says we have only one applet... */
#ifdef SINGLE_APPLET_MAIN #ifdef SINGLE_APPLET_MAIN
#undef ENABLE_FEATURE_INDIVIDUAL # undef ENABLE_FEATURE_INDIVIDUAL
#define ENABLE_FEATURE_INDIVIDUAL 1 # define ENABLE_FEATURE_INDIVIDUAL 1
#undef IF_FEATURE_INDIVIDUAL # undef IF_FEATURE_INDIVIDUAL
#define IF_FEATURE_INDIVIDUAL(...) __VA_ARGS__ # define IF_FEATURE_INDIVIDUAL(...) __VA_ARGS__
#endif #endif
#include "usage_compressed.h"
#if ENABLE_SHOW_USAGE && !ENABLE_FEATURE_COMPRESS_USAGE
static const char usage_messages[] ALIGN1 = UNPACKED_USAGE;
#else
# define usage_messages 0
#endif /* SHOW_USAGE */
#if ENABLE_FEATURE_COMPRESS_USAGE #if ENABLE_FEATURE_COMPRESS_USAGE
#include "usage_compressed.h" static const char packed_usage[] = { PACKED_USAGE };
#include "unarchive.h" # include "unarchive.h"
static const char *unpack_usage_messages(void) static const char *unpack_usage_messages(void)
{ {
char *outbuf = NULL; char *outbuf = NULL;
@ -86,19 +81,19 @@ static const char *unpack_usage_messages(void)
* end up here with i != 0 on read data errors! Not trivial */ * end up here with i != 0 on read data errors! Not trivial */
if (!i) { if (!i) {
/* Cannot use xmalloc: will leak bd in NOFORK case! */ /* Cannot use xmalloc: will leak bd in NOFORK case! */
outbuf = malloc_or_warn(SIZEOF_usage_messages); outbuf = malloc_or_warn(sizeof(UNPACKED_USAGE));
if (outbuf) if (outbuf)
read_bunzip(bd, outbuf, SIZEOF_usage_messages); read_bunzip(bd, outbuf, sizeof(UNPACKED_USAGE));
} }
dealloc_bunzip(bd); dealloc_bunzip(bd);
return outbuf; return outbuf;
} }
#define dealloc_usage_messages(s) free(s) # define dealloc_usage_messages(s) free(s)
#else #else
#define unpack_usage_messages() usage_messages # define unpack_usage_messages() usage_messages
#define dealloc_usage_messages(s) ((void)(s)) # define dealloc_usage_messages(s) ((void)(s))
#endif /* FEATURE_COMPRESS_USAGE */ #endif /* FEATURE_COMPRESS_USAGE */