www/cleanup.html

   1 <html><head><title>toybox cleanup</title></head>
   2 <!--#include file="header.html" -->
   3
   4 <h1>Index</h1>
   5
   6 <ul>
   7 <li><a href=#intro>Introduction</a></li>
   8 <li><a href=#advice>Advice</a></li>
   9 <li>Commands:</li>
  10 <ul>
  11 <li><a href=#uuencode>uuencode</a></li>
  12 <li><a href=#uudecode>uudecode</a></li>
  13 <li><a href=#ifconfig>ifconfig</a></li>
  14 </ul>
  15 </ul>
  16
  17 <hr>
  18
  19 <a name=intro />
  20 <h1>Cleaning up the toybox code.</h1>
  21
  22 <p>Toybox <a href=http://landley.net/notes.html#31-03-2013>hasn't always</a>
  23 taken proper advantage of external contributions</a>.
  24 Lots of people want to help, but their contributions languish out of tree
  25 or in the "pending" directory, awaiting cleanup.</p>
  26
  27 <p>Toybox's design goals require simpler, tighter, and more explicit code
  28 than most other implementations, among other reasons to allow better security
  29 auditing. Writing "another" implementation of standard command line tools
  30 isn't very interesting, they should be _better_ implementations.
  31 Unfortunately, this means existing, working commands often take more effort to
  32 clean up to Toybox's standards than writing a new one from scratch, not
  33 because they don't work, but because we aim for an unusual level of polish.</p>
  34
  35 <p>In hopes of teaching more people how to do this
  36 cleanup work, I've started breaking cleanup changes into smaller chunks and
  37 posting explanations of each change to the mailing list.
  38 Below are indexes of such cleanup series. Each commit and post are meant to
  39 be read together: each description explains what the corresponding patch
  40 was trying to accomplish.</p>
  41
  42 <p>Line/byte totals of completed series are given for scale, but the point
  43 of this work is simplicity and compactness, not size per se.</p>
  44
  45 <p>(Note: mercurial's web viewer doesn't follow renames, so although each
  46 command name links to a commit list with the bulk of the changes, it may
  47 not include the final version of each file moved from the "pending"
  48 directory to its final location. The summaries link the initial and cleaned
  49 versions of each file when giving line counts.)</p>
  50
  51 <hr>
  52
  53 <a name=advice />
  54 <h1>General advice and/or policy.</h1>
  55
  56 <p>The <a href=design.html>design of toybox</a> page and the coding
  57 style section at the start of the <a href=code.html>source code walkthrough</a>
  58 don't cover everything. Here are some
  59 links to mailing list messages that cover various programming topics
  60 not directly related to a specific cleanup series:</p>
  61
  62 <ul>
  63 <li><a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-April/000850.html>Error messages and internationalization.</a></li>
  64 <li><a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-April/000891.html>Why not "const"?</a> (Exception: global variables
  65 outside of GLOBALS can be static const, to go in rodata instead of data.
  66 This means the pages can be shared between instances.)</li>
  67 <li><a href=http://lkml.indiana.edu/hypermail/linux/kernel/1308.3/03890.html>Why not "bool"?</a> (explanation from Linus Torvalds)</li>
  68 <li><a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-April/000893.html>Why not to check in debug code.</a></li>
  69 <li><a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-June/001044.html>Relationship between /proc and /sys</a> (/proc isn't obsolete and /sys is an ABI)</li>
  70 <li>"Hiding numbers that are used just once into defines to put them out of
  71 sight does not really help readability."</a> -
  72 <a href=http://lkml.iu.edu/hypermail/linux/kernel/1407.1/00299.html>Pavel
  73 Machek</a></li>
  74 <li>"Infrastructure in search of a user" is a bad thing, so don't put code
  75 in lib/ that doesn't already have at least two users. Don't preemptively
  76 factor stuff out, it's easy enough to rewrite it uin future if it needs
  77 to change. The "extreme programming" fad called this "You Ain't Gonna
  78 Need It" (while inexplicably screaming at cans of Mountain Dew, back in the
  79 90's). Here's <a href=https://lwn.net/Articles/683745/>Linus Torvalds' take</a>.</li>
  80 </ul>
  81
  82 <hr>
  83
  84 <a name="uuencode"><h1><a href=/hg/toybox/log/900/toys/pending/uuencode.c>uuencode</a></h1>
  85
  86 <p>This is an example of cleaning up something most projects would be quite
  87 happy with. The initial submission of uuencode and uudecode was high
  88 quality code, written by a seasoned developer who did an excellent
  89 job, but it was still possible to shrink the result almost by half:</p>
  90
  91 <ul>
  92 <li>old total: <a href=/hg/toybox/file/828/toys/pending/uuencode.c>116 lines (2743
  93 bytes) in 7 functions</a></li>
  94 <li>new total: <a href=/hg/toybox/file/841/toys/posix/uuencode.c>67 lines (1440
  95 bytes) in 1 function</a></li>
  96 </ul>
  97
  98 <ul>
  99 <li>commit: <a href=/hg/toybox/rev/830>830</a>: first pass, description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-April/000904.html>part 1</a>,
 100 <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-April/000903.html>part 2</a></li>
 101 <li>commit: <a href=/hg/toybox/rev/831>831</a>,
 102 second pass, description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-April/000919.html>part 3</a></li>
 103 <li>commit: <a href=/hg/toybox/rev/837>837</a>,
 104 description: fix test suite.</li>
 105 <li>commit: <a href=/hg/toybox/rev/853>853</a>, description: bugfix.</li>
 106 </ul>
 107
 108 <p>Status: COMPLETE</p>
 109
 110 <a name="uudecode"><h1><a href=/hg/toybox/log/900/toys/pending/uudecode.c>uudecode</a></h1>
 111
 112 <p>The uudecode cleanup was my second "explain as I go along" cleanup,
 113 and I tried to do it in smaller stages so it was easier to see what
 114 changed from the diff:</p>
 115
 116 <ul>
 117 <li>old: <a href=/hg/toybox/file/828/toys/pending/uudecode.c>175
 118 lines (4534 bytes) in 9 functions</a></li>
 119 <li>new: <a href=/hg/toybox/file/840/toys/posix/uudecode.c>107 lines
 120 (2300 bytes) in 1 function</a></li>
 121 </ul>
 122
 123 <ul>
 124 <li>commit: <a href=/hg/toybox/rev/833>833</a>,
 125 description: preparatory adjustments to test suite.</li>
 126 <li>commit: <a href=/hg/toybox/rev/835>835</a>,
 127 description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2014-January/001532.html>Redo command line parsing, redo parsing loop.</a></li>
 128 <li>commit: <a href=/hg/toybox/rev/838>838</a>,
 129 description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2014-January/001533.html>Redo b64_1byte, b64_4bytes, and uu_line()</a></li>
 130 <li>commit: <a href=/hg/toybox/rev/839>839</a>,
 131 description: todo</a></li>
 132 <li>commit: <a href=/hg/toybox/rev/840>840</a>,
 133 description: todo (finish, move pending->posix, default y)</a></li>
 134 </ul>
 135
 136 <p>Status: COMPLETE</p>
 137
 138 <a name=ifconfig>
 139 <h1><a href=/hg/toybox/log/tip/toys/pending/ifconfig.c>ifconfig</a></h1>
 140
 141 <p>This series describes a thorough cleanup that took a while to do.</p>
 142
 143 <p>When ifconfig was submitted, it touched a half-dozen files. I glued it
 144 together into a single self-contained file, which needed a lot of
 145 cleanup. The final version is about 1/3 the size of the original.</p>
 146
 147 <ul>
 148 <li>old total: <a href=/hg/toybox/file/841/toys/pending/ifconfig.c>1504 lines (44268 bytes) in 38 functions</a></li>
 149 <li>new total: <a href=/hg/toybox/file/1133/toys/other/ifconfig.c>521 lines (15963 bytes) in 4 functions</a></li>
 150 </ul>
 151
 152 <p>This was the first command I started cleaning up with the intent of
 153 describing the process, and especially the first few entries in this
 154 series describe many of the low hanging fruit techniques used to clean
 155 up a codebase.</p>
 156
 157 <ul>
 158 <li>commit: <a href=/hg/toybox/rev/843>843</a>, description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-April/000882.html>Infrastructure in search of a user, code proximity,
 159 unnecessary #defines, shorter code is easier to read.</a></li>
 160 <li>commit: <a href=/hg/toybox/rev/844>844</a>,
 161 description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-April/000881.html>Headers, replacing repeated code with loops,
 162 logical operators guaranteed to return 0 or 1, math on string constants,
 163 removing unnecessary variables and tests.</a></li>
 164 <li>commit: <a href=/hg/toybox/rev/852>852</a>,
 165 description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-April/000921.html>hg commit numbers, documenting the obvious, ordering
 166 to avoid prototypes, returning void, collate local declarations,
 167 use error_exit(), unnecessary parentheses, inline to remove variables/functions
 168 used only once, using *var instead of var[0], unnecessary typecasts,
 169 xprintf("\n") vs xputc('\n')</a></li>
 170 <li>commit: <a href=/hg/toybox/rev/856>856</a>,
 171 description: one line portability fix from Isaac Dunham</li>
 172 <li>commit: <a href=/hg/toybox/rev/861>861</a>
 173 and <a href=/hg/toybox/rev/863>863</a>,
 174 description:
 175 <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-April/000910.html>Help
 176 infrastructure cleanup from Isaac Dunham</a>
 177 (which I mis-applied and then <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-April/000920.html>fixed plus some whitespace changes</a>)</li>
 178
 179 <li>commit: <a href=/hg/toybox/rev/862>862</a>, description:
 180 <a href=http://lists.landley.net/pipermail/toybox-landley.net/2014-January/001525.html>remove unused headers and function, replace local buffer with toybuf, perror_exit(), avoid unnecessary assignment.</a></li>
 181 <li>commit: <a href=/hg/toybox/rev/864>864</a>, description:
 182 <a href=http://lists.landley.net/pipermail/toybox-landley.net/2014-January/001526.html>use common linked list functions, inline set_data, add xioctl, clean up error messages, whitespace and comment tweaks, remove NOP return statements</a></li>
 183 <li>commit: <a href=/hg/toybox/rev/866>866</a>, description:
 184 <a href=http://lists.landley.net/pipermail/toybox-landley.net/2014-January/001528.html>move standalone globals into GLOBALS() block, collate structs into
 185 iface_list. Inline/rewrite/remove field_format, iface_flags_str,
 186 omit_whitespace(), print_iface_flags(), print_media(), get_ifconfig_info(),
 187 and clear_list(). Merge duplicate function
 188 calls. Show get_proc_info() version field can't matter in 2.6 or newer kernel,
 189 and that SIOCGIFMAP has been there since 1994 so doesn't need an #ifdef.
 190 Loop simplification in readconf() and show_iface().</a></li>
 191
 192 <li>commit: <a href=/hg/toybox/rev/869>869</a> and <a href=/hg/toybox/rev/870>870</a>,
 193 description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-April/000928.html>869:
 194 reorder to eliminate prototypes, put command_main() at end of file,
 195 870: long repeated variable prefixes, replacing struct+sscanf()+printf with a
 196 loop and a table (from iface_list, get_proc_info(), display_ifconfig()),
 197 use lib/xwrap.c functions to return void, why xstrcpy() fails closed,
 198 (functional comment: why multicast failed, CSLIP obsolecense), not being
 199 _too_ clever.</a></li>
 200 <li>commit: <a href=/hg/toybox/rev/878>878</a> and <a href=/hg/toybox/rev/879>879</a>:
 201 description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-April/000946.html>878: add xsocket(), free(NULL) is a safe NOP (posix!).
 202 879: inline three functions and simplify, some simplifications only show up
 203 after repeated inlining</a></li>
 204 <li>commit: <a href=/hg/toybox/rev/883>883</a>,
 205 description: move some common code to lib/ and posix headers to toys.h.</li>
 206 <li>commit: <a href=/hg/toybox/rev/898>898</a>,
 207 description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-May/000974.html>Argument parsing. (Replace ifconfig_main() if/else staircase with a loop over
 208 an array, genericize minus prefix logic, inline a use of set_flags().)</a></li>
 209 <li>commit: <a href=/hg/toybox/rev/905>905</a>,
 210 description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-May/000992.html>remove unnecessary wrapper function, inlining more functions,
 211 relying on the values of constants that don't change across architectures
 212 (binary backwards compatability), more ifconfig_main table work,
 213 man ioctl_list.</a></li>
 214 <li>commit: <a href=/hg/toybox/rev/906>906</a>,
 215 description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-May/000994.html>More ifconfig_main() table work, remove vestigial arguments
 216 to functions, "a frenzy of inlining", slightly better error reporting,
 217 don't reinvent libc functions.</a></li>
 218 <li>commit: <a href=/hg/toybox/rev/907>907</a>,
 219 <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-May/000995.html>inlining show_ip_addr() with a loop and a table, inlining hex_to_binary()
 220 and set_hw_address(), stop validating data we supplied, remove a table
 221 that's overkill (two entries, we don't even loop over it), when you don't need a
 222 NULL terminator for array, remove unnecessary memcpy(offsetof()) with
 223 assignment, trusting -funsigned-char.</a></li>
 224 <li>commit: <a href=/hg/toybox/rev/919>919</a>,
 225 <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-June/001027.html>todo whitespace damage, introduce IFREQ_OFFSZ() and poke() to
 226 ifconfig_main() table logic to fold more if/else parts into the table</a></li>
 227 <li>Status update: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-June/001033.html>Entering the home stretch on ifconfig</a> (and a <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-June/001043.html>note about infiniband</a>)</li>
 228 <li>commit: <a href=/hg/toybox/rev/921>921</a>, description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2014-June/003508.html>Inline a couple more functions and make sockfd a global.</li>
 229 <li>commit: <a href=/hg/toybox/rev/957>957</a>, description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-July/001121.html>Remove unused socklen and addr_to_len(), cleanup so we can merge get_device_info()/display_ifconfig().</a></li>
 230 <li>commit: <a href=/hg/toybox/rev/958>958</a>, description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-July/001131.html>This commit removes struct if_list by unifying get_device_info() and display_ifconfig().</a></li>
 231 <li>commit: <a href=/hg/toybox/rev/1104>1104</a>, description: Merge toynet into toys.h: musl supports it and micromanaging uClibc config options isn't very interesting anymore.</li>
 232 <li>commit: <a href=/hg/toybox/rev/1127>1127</a>, description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-November/001464.html>Start tacling ipv6 issues, beginning with display_ifconfig().</a></li>
 233 <li>commit: <a href=/hg/toybox/rev/1128>1128</a>, description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-November/001463.html>More ipv6, make struct sockaddr_with_len go away, merge more arguments into the table in main().</a></li>
 234 <li>commit: <a href=/hg/toybox/rev/1132>1132</a>, description: promotion from pending to other</li>
 235 <li>commit: <a href=/hg/toybox/rev/1133>1133</a>, description: <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-November/001462.html>cleanup help text, remove obsolete/NOP commands</a></li>
 236 </ul>
 237
 238 <p>Status: COMPLETE.</p>
 239
 240 <p>Status: in progress.</p>
 241
 242 <h1><a href=/hg/toybox/log/917/toys/pending/stat.c>stat</a></h1>
 243
 244 <p>A lot of the stat cleanup was done by Felix Janda.</p>
 245
 246 <ul>
 247 <li>commit <a href=/hg/toybox/rev/747>747</a>: initial submission</a></li>
 248 <li>commit <a href=/hg/toybox/rev/810>810</a>: whitespace</li>
 249 <li>commit <a href=/hg/toybox/rev/811>811</a>: description in commit message.</li>
 250 <li>commit <a href=/hg/toybox/rev/871>871</a>: whitespace (reindent from 4 spaces to 2)</li>
 251 <li>commit <a href=/hg/toybox/rev/872>872</a>: Felix Janda - <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-April/000923.html>cleanup</a> (with discussion thread)</li>
 252 <li>commit <a href=/hg/toybox/rev/875>885</a>: Felix Janda - <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-April/000936.html>move permission formatting (777 -> -rwxrwxrwx) from ls to lib so stat can reuse it.</a></li>
 253 <li>commit <a href=/hg/toybox/rev/885>886</a>: Felix Janda - remove unimplemented options and clean up help text</li>
 254 <li>commit <a href=/hg/toybox/rev/910>910</a>: Felix Janda - <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-May/001013.html>Add support for stating multiple files</a>.</li>
 255 <li>commit <a href=/hg/toybox/rev/911>911</a>: Felix Janda - Separate stat and statfs, give stat_main() a ds[2] array to distinguish FLAG_f vs not cases, and some whitespace changes.</li>
 256 <li>commit <a href=/hg/toybox/rev/912>912</a>: description in commit message (also <a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-May/001019.html>here</a>)</li>
 257 <li><a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-May/001024.html>design pondering</a> (leading to peek() function in lib/)</li>
 258
 259 <li>commit <a href=/hg/toybox/rev/914>914</a>: description in commit message.</li>
 260 <li>commit <a href=/hg/toybox/rev/916>916</a>: description in commit message.</li>
 261 <li>commit: <a href=/hg/toybox/rev/917>917</a>: description in commit message.</li>
 262 <li>commit: <a href=/hg/toybox/rev/918>918</a>,
 263 description: done: move pending to posix, default y, no other changes</a>.</li>
 264 <li><a href=http://lists.landley.net/pipermail/toybox-landley.net/2013-June/001026.html>summary</a></li>
 265 </ul>
 266
 267 <p>Status: COMPLETE.</p>
 268
 269 <!--#include file="footer.html" -->