* HACKING: describe how to find a misplaced change-set
[platform/upstream/coreutils.git] / TODO
1 If you're interested in helping, here are some tasks that we've considered
2 over the years.  Beware: some are quite old and no longer valid.  To avoid
3 wasting your time by duplicating work or by working on a task that is no
4 longer pertinent, please search the mailing list and post your intent
5 before embarking on a big project.
6
7 ==================================================
8 document the following in coreutils.texi:
9   runcon
10   chcon
11   mktemp
12   [
13   pinky
14   uptime
15 Also document the SELinux changes.
16
17 Suggestion from Paul Eggert:
18   More generally, there's not that much use for imaxtostr nowadays,
19   since the inttypes module and newer versions of gettext allow things
20   like _("truncating %s at %" PRIdMAX " bytes") to work portably.
21   I suspect that (if someone cares to take the time) we can remove
22   all instances of imaxtostr and umaxtostr in coreutils and gnulib.
23
24 cp --recursive: use fts and *at functions to perform directory traversals
25   in source and destination hierarchy rather than forming full file names.
26   The latter (current) approach fails unnecessarily when the names
27   become very long, and requires space and time that is quadratic in the
28   depth of the hierarchy.  [Bo Borgerson is working on this]
29
30 printf:
31   Now that gnulib supports *printf("%a"), import one of the
32   *printf-posix modules so that printf(1) will support %a even on
33   platforms where the native *printf(3) is deficient.
34   Suggestion from Eric Blake.
35
36 renice: POSIX utility, needs implementing.
37   suggestion from Karl Berry (among others).
38   Bob Proulx is working on this.
39
40 install: add an option to specify the program used to strip binaries.
41   suggestion from Karl Berry
42
43 doc/coreutils.texi:
44   Address this comment: FIXME: mv's behavior in this case is system-dependent
45   Better still: fix the code so it's *not* system-dependent.
46
47 ls: add --format=FORMAT option that controls how each line is printed.
48
49 cp --no-preserve=X should not attempt to preserve attribute X
50   reported by Andreas Schwab
51
52 copy.c: Address the FIXME-maybe comment in copy_internal.
53 And once that's done, add an exclusion so that `cp --link'
54 no longer incurs the overhead of saving src. dev/ino and dest. filename
55 in the hash table.
56
57 Write an autoconf test to work around build failure in HPUX's 64-bit mode.
58 See notes in README -- and remove them once there's a work-around.
59
60 Integrate use of sendfile, suggested here:
61   http://mail.gnu.org/archive/html/bug-fileutils/2003-03/msg00030.html
62 I don't plan to do that, since a few tests demonstrate no significant benefit.
63
64 Should printf '\0123' print "\n3"?
65   per report from TAKAI Kousuke on Mar 27
66   http://mail.gnu.org/archive/html/bug-coreutils/2003-03/index.html
67
68 printf: consider adapting builtins/printf.def from bash
69
70 df: add `--total' option, suggested here http://bugs.debian.org/186007
71
72 tail: don't use xlseek; it *exits*.
73   Instead, maybe use a macro and return nonzero.
74
75 tr: support nontrivial equivalence classes, e.g. [=e=] with LC_COLLATE=fr_FR
76
77 lib/strftime.c: Since %N is the only format that we need but that
78   glibc's strftime doesn't support, consider using a wrapper that
79   would expand /%(-_)?\d*N/ to the desired string and then pass the
80   resulting string to glibc's strftime.
81
82 unexpand: [http://www.opengroup.org/onlinepubs/007908799/xcu/unexpand.html]
83   printf 'x\t \t y\n'|unexpand -t 8,9 should print its input, unmodified.
84   printf 'x\t \t y\n'|unexpand -t 5,8 should print "x\ty\n"
85
86 Let GNU su use the `wheel' group if appropriate.
87   (there are a couple patches, already)
88
89 sort: Investigate better sorting algorithms; see Knuth vol. 3.
90
91   We tried list merge sort, but it was about 50% slower than the
92   recursive algorithm currently used by sortlines, and it used more
93   comparisons.  We're not sure why this was, as the theory suggests it
94   should do fewer comparisons, so perhaps this should be revisited.
95   List merge sort was implemented in the style of Knuth algorithm
96   5.2.4L, with the optimization suggested by exercise 5.2.4-22.  The
97   test case was 140,213,394 bytes, 426,4424 lines, text taken from the
98   GCC 3.3 distribution, sort.c compiled with GCC 2.95.4 and running on
99   Debian 3.0r1 GNU/Linux, 2.4GHz Pentium 4, single pass with no
100   temporary files and plenty of RAM.
101
102   Since comparisons seem to be the bottleneck, perhaps the best
103   algorithm to try next should be merge insertion.  See Knuth section
104   5.3.1, who credits Lester Ford, Jr. and Selmer Johnson, American
105   Mathematical Monthly 66 (1959), 387-389.
106
107 Remove suspicious uses of alloca (ones that may allocate more than
108    about 4k)
109
110 Adapt these contribution guidelines for coreutils:
111   http://sources.redhat.com/automake/contribute.html
112
113 Improve test coverage.
114   See HACKING for instructions on generating an html test coverage report.
115   Find a program that has poor coverage and improve.
116
117 Changes expected to go in, someday.
118 ======================================
119
120   dd patch from Olivier Delhomme
121
122   test/mv/*: clean up $other_partition_tmpdir in all cases
123
124   ls: when both -l and --dereference-command-line-symlink-to-dir are
125   specified, consider whether to let the latter select whether to
126   dereference command line symlinks to directories.  Since -l has
127   an implicit --NO-dereference-command-line-symlink-to-dir meaning.
128   Pointed out by Karl Berry.
129
130   A more efficient version of factor, and possibly one that
131   accepts inputs of size 2^64 and larger.
132
133   dd: consider adding an option to suppress `bytes/block read/written'
134   output to stderr.  Suggested here:
135     http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=165045
136
137   Pending copyright papers:
138   ------------------------
139   getpwnam from Bruce Korb
140
141   pb (progress bar) from Miika Pekkarinen
142
143   ------------------------------
144
145 Remove long-deprecated options.  Search case-insensitive for
146 `deprecated' and `remove in '.  Automate this.
147
148 Add a distcheck-time test to ensure that every distributed
149 file is either read-only(indicating generated) or is
150 version-controlled and up to date.
151
152 remove `%s' notation (now that they're all gone, add a maint.mk sc_
153     rule to ensure no new ones are added):
154   grep -E "\`%.{,4}s'" src/*.c
155
156 remove all uses of the `register' keyword: Done.  add a maint.mk rule
157   for this, too.
158
159 remove or adjust chown's --changes option, since it
160   can't always do what it currently says it does.
161
162 Adapt tools like wc, tr, fmt, etc. (most of the textutils) to be
163   multibyte aware.  The problem is that I want to avoid duplicating
164   significant blocks of logic, yet I also want to incur only minimal
165   (preferably `no') cost when operating in single-byte mode.
166
167 pr's use of nstrftime can make it malloc a very large (up to SIZE_MAX) buffer
168
169 -----
170
171 Copyright (C) 2002-2008 Free Software Foundation, Inc.
172
173 This program is free software: you can redistribute it and/or modify
174 it under the terms of the GNU General Public License as published by
175 the Free Software Foundation, either version 3 of the License, or
176 (at your option) any later version.
177
178 This program is distributed in the hope that it will be useful,
179 but WITHOUT ANY WARRANTY; without even the implied warranty of
180 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
181 GNU General Public License for more details.
182
183 You should have received a copy of the GNU General Public License
184 along with this program.  If not, see <http://www.gnu.org/licenses/>.