[cffi-devel] [patch] lots of new manual changes

[Stephen Compall]

Most notably, documenting the library interface.  Thanks especially to
Jonathan `slyphon' Simms on #lisp for pointing out a bug in the tutorial
code.

I added two more broken cross-references, one to libtool, and one to
asdf.  I'll fix gendocs.sh for libtool later, but would appreciate
suggestions (other than host an asdf manual myself) for asdf.

Details follow; patch (140k) at
http://csserver.evansville.edu/~sc87/cffi/cffi-manual-2s11.darcs.patch

Thu Jan 19 12:59:20 CST 2006  Stephen Compall <scompall at nocandysw.com>
  * update manual Introduction and Foreign types, texinfo idioms
throughout

  - Remove note on cffi-luis branch.
  - Write introductory chapter.
  - Acronym/sc-ify CL implementation names.
  - Use @cffi{} instead of CFFI.
  - Use @impnote for notes from luis and james.
  - Split existing type translator explanation to make "Defining
    typedefs" and rewrite the former.
  - Invent an example for defcstruct, and explain its limitations.
  - Write "Allocating Foreign Objects".
  - Move with-foreign-object(s) to Pointers chapter, to group it with
    foreign-alloc.
  - Use @sc and @result to make REPL examples pretty, and move them into
    @example sections.
  - Remove commented-out sections; they can be readded later from darcs
    repo if need be.

Sun Jan 22 22:06:05 CST 2006  Stephen Compall <scompall at nocandysw.com>
  * document new library interface, some other manual stuff

  - New macro @Variable.
  - Fix 2 @end examples.
  - In "Arguments and Values" headings, use @var for tables of
    variables, as they act as metasyntactic variables in this situation.
  - Document new library interface.
  - Use @unnumberedsec in dictionary nodes instead of @heading, and
    @code the names.
  - Platform-specific features: new appendix.
  - define-curl-option-setter: curl-code is not a keyword
  - Use new @seealso macro for "See Also" xrefs.
  - Merge all indexes into cp.

-- 
Stephen Compall
http://scompall.nocandysw.com/blog
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 189 bytes
Desc: This is a digitally signed message part
URL: <https://mailman.common-lisp.net/pipermail/cffi-devel/attachments/20060122/08f45e0c/attachment.sig>