maint: HACKING: mention a few more useful git commands
[coreutils.git] / TODO
blob9128ddf77902d059bceceab74a5eb977186a8eff
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.
7 ==================================================
8 Modify chmod so that it does not change an inode's st_ctime
9   when the selected operation would have no other effect.
10   First suggested by Hans Ecke <http://hans.ecke.ws> in
11     http://thread.gmane.org/gmane.comp.gnu.coreutils.bugs/2920
12   Discussed more recently on <http://bugs.debian.org/497514>.
14 document the following in coreutils.texi:
15   mktemp
16   [
17   pinky
19 Suggestion from Paul Eggert:
20   More generally, there's not that much use for imaxtostr nowadays,
21   since the inttypes module and newer versions of gettext allow things
22   like _("truncating %s at %" PRIdMAX " bytes") to work portably.
23   I suspect that (if someone cares to take the time) we can remove
24   all instances of imaxtostr and umaxtostr in coreutils and gnulib.
26 cp --recursive: use fts and *at functions to perform directory traversals
27   in source and destination hierarchy rather than forming full file names.
28   The latter (current) approach fails unnecessarily when the names
29   become very long, and requires space and time that is quadratic in the
30   depth of the hierarchy.  [Bo Borgerson is working on this]
32 printf:
33   Now that gnulib supports *printf("%a"), import one of the
34   *printf-posix modules so that printf(1) will support %a even on
35   platforms where the native *printf(3) is deficient.
36   Suggestion from Eric Blake.
38 renice: POSIX utility, needs implementing.
39   suggestion from Karl Berry (among others).
40   Bob Proulx is working on this.
42 doc/coreutils.texi:
43   Address this comment: FIXME: mv's behavior in this case is system-dependent
44   Better still: fix the code so it's *not* system-dependent.
46 ls: add --format=FORMAT option that controls how each line is printed.
48 cp --no-preserve=X should not attempt to preserve attribute X
49   reported by Andreas Schwab
51 copy.c: Address the FIXME-maybe comment in copy_internal.
52 And once that's done, add an exclusion so that `cp --link'
53 no longer incurs the overhead of saving src. dev/ino and dest. filename
54 in the hash table.
56 Write an autoconf test to work around build failure in HPUX's 64-bit mode.
57 See notes in README -- and remove them once there's a work-around.
59 Integrate use of sendfile, suggested here:
60   http://mail.gnu.org/archive/html/bug-fileutils/2003-03/msg00030.html
61 I don't plan to do that, since a few tests demonstrate no significant benefit.
63 Should printf '\0123' print "\n3"?
64   per report from TAKAI Kousuke on Mar 27
65   http://mail.gnu.org/archive/html/bug-coreutils/2003-03/index.html
67 printf: consider adapting builtins/printf.def from bash
69 tail: don't use xlseek; it *exits*.
70   Instead, maybe use a macro and return nonzero.
72 tr: support nontrivial equivalence classes, e.g. [=e=] with LC_COLLATE=fr_FR
74 lib/strftime.c: Since %N is the only format that we need but that
75   glibc's strftime doesn't support, consider using a wrapper that
76   would expand /%(-_)?\d*N/ to the desired string and then pass the
77   resulting string to glibc's strftime.
79 unexpand: [http://www.opengroup.org/onlinepubs/007908799/xcu/unexpand.html]
80   printf 'x\t \t y\n'|unexpand -t 8,9 should print its input, unmodified.
81   printf 'x\t \t y\n'|unexpand -t 5,8 should print "x\ty\n"
83 Let GNU su use the `wheel' group if appropriate.
84   (there are a couple patches, already)
86 sort: Investigate better sorting algorithms; see Knuth vol. 3.
88   We tried list merge sort, but it was about 50% slower than the
89   recursive algorithm currently used by sortlines, and it used more
90   comparisons.  We're not sure why this was, as the theory suggests it
91   should do fewer comparisons, so perhaps this should be revisited.
92   List merge sort was implemented in the style of Knuth algorithm
93   5.2.4L, with the optimization suggested by exercise 5.2.4-22.  The
94   test case was 140,213,394 bytes, 426,4424 lines, text taken from the
95   GCC 3.3 distribution, sort.c compiled with GCC 2.95.4 and running on
96   Debian 3.0r1 GNU/Linux, 2.4GHz Pentium 4, single pass with no
97   temporary files and plenty of RAM.
99   Since comparisons seem to be the bottleneck, perhaps the best
100   algorithm to try next should be merge insertion.  See Knuth section
101   5.3.1, who credits Lester Ford, Jr. and Selmer Johnson, American
102   Mathematical Monthly 66 (1959), 387-389.
104 shred: Update shred as described here to conform to DoD 5220 rules:
105 http://lists.gnu.org/archive/html/bug-coreutils/2007-05/msg00075.html
107 Remove suspicious uses of alloca (ones that may allocate more than
108    about 4k)
110 Adapt these contribution guidelines for coreutils:
111   http://sources.redhat.com/automake/contribute.html
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.
117 Changes expected to go in, someday.
118 ======================================
120   dd patch from Olivier Delhomme
122   test/mv/*: clean up $other_partition_tmpdir in all cases
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.
130   dd: consider adding an option to suppress `bytes/block read/written'
131   output to stderr.  Suggested here:
132     http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=165045
134   Pending copyright papers:
135   ------------------------
136   getpwnam from Bruce Korb
138   pb (progress bar) from Miika Pekkarinen
140   ------------------------------
142 Remove long-deprecated options.  Search case-insensitive for
143 `deprecated' and `remove in '.  Automate this.
145 Add a distcheck-time test to ensure that every distributed
146 file is either read-only(indicating generated) or is
147 version-controlled and up to date.
149 remove `%s' notation (now that they're all gone, add a maint.mk sc_
150     rule to ensure no new ones are added):
151   grep -E "\`%.{,4}s'" src/*.c
153 remove all uses of the `register' keyword: Done.  add a maint.mk rule
154   for this, too.
156 remove or adjust chown's --changes option, since it
157   can't always do what it currently says it does.
159 Support arbitrary-precision arithmetic in those tools for which it
160 makes sense.  Factor and expr already support this via libgmp.
161 The "test" program is covered via its string-based comparison of
162 integers.  To be converted: seq.
164 Adapt tools like wc, tr, fmt, etc. (most of the textutils) to be
165   multibyte aware.  The problem is that I want to avoid duplicating
166   significant blocks of logic, yet I also want to incur only minimal
167   (preferably `no') cost when operating in single-byte mode.
169 pr's use of nstrftime can make it malloc a very large (up to SIZE_MAX) buffer
171 -----
173 Copyright (C) 2002-2009 Free Software Foundation, Inc.
175 This program is free software: you can redistribute it and/or modify
176 it under the terms of the GNU General Public License as published by
177 the Free Software Foundation, either version 3 of the License, or
178 (at your option) any later version.
180 This program is distributed in the hope that it will be useful,
181 but WITHOUT ANY WARRANTY; without even the implied warranty of
182 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
183 GNU General Public License for more details.
185 You should have received a copy of the GNU General Public License
186 along with this program.  If not, see <http://www.gnu.org/licenses/>.