This is partially-based on a previous draft started by Mark Johnson.
The controversial part is installing in /usr/gnu, even though it is
not name-conflicting with anything in /usr - does /usr/gnu allow
for this usage?
- Dermot
===============
GNU readline
1. Summary
This fast-track introduces GNU readline, version 5.2,
into the SFW consolidation and removes it from the CCD.
Patch release binding is requested.
2. Discussion
GNU readline is a library used for reading lines of
text with interactive input and history editing.
It is used by a variety of open-source applications
including virsh (an application which manages guest
domains included with Solaris on Xen [1]). virsh
will be submitted to ARC as part of libvirt at a
later date.
Readline is delivered as two libraries, libreadline
and libhistory. The functions for editing lines are
in libreadline and the functions for saving and recalling
previous command-line history are in libhistory. Both
libraries can be used independently, if desired.
Further information on readline, including APIs and
user and programming guides are available at the
GNU readline site [2].
Readline is released under the GPL license and therefore
applications which use it must themselves be GPL.
It is proposed to install readline under /usr/gnu [3],
as placing it in /usr may lead other consolidations or
ISVs to ignore its licensing restrictions.
**FIXME** need to reference upcoming GPL/LGPL Legal review here?
3. Interfaces
Exported Interfaces
===================
SUNWreadline Committed Package name
**FIXME** was SFWrline in CCD, but I prefer SUNWreadline to SUNWrline
/usr/gnu/lib/libreadline.so.4 Uncommitted Shared object
library
/usr/gnu/lib/libhistory.so.4 Uncommitted Shared object
library
/usr/gnu/lib/libhistory.a Uncommitted Static library
/usr/gnu/lib/libreadline.a Uncommitted Static library
**FIXME** presume shouldn't deliver these, even though SFWrline did?
/usr/gnu/share/man/man3/readline.3 Uncommitted manpage
/usr/gnu/share/info/readline.info Uncommitted Info document
/usr/gnu/share/info/rluserman.info Uncommitted Info document
/usr/gnu/share/info/history.info Uncommitted Info document
/usr/gnu/include/readline Uncommitted Directory
/usr/gnu/include/readline/chardefs.h Uncommitted Header file
/usr/gnu/include/readline/history.h Uncommitted Header file
/usr/gnu/include/readline/keymaps.h Uncommitted Header file
/usr/gnu/include/readline/readline.h Uncommitted Header file
/usr/gnu/include/readline/rlconf.h Uncommitted Header file
/usr/gnu/include/readline/rlstdc.h Uncommitted Header file
/usr/gnu/include/readline/rltypedefs.h Uncommitted Header file
/usr/gnu/include/readline/tilde.h Uncommitted Header file
4. References
[1] Tim Marsland, PSARC/2006/260: Solaris on Xen
[2] http://cnswww.cns.cwru.edu/php/chet/readline/rltop.html
[3] S. Hahn, B. Smaalders, and R. Orth, PSARC/2007/047: /usr/gnu
This message posted from opensolaris.org
