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@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@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 s11@member.fsf.org writes:
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.
My suggestion is that we should create a common-lisp.net project to host ASDF, its manual and other ASDF-related stuff. :-)
Details follow; patch (140k) at http://csserver.evansville.edu/~sc87/cffi/cffi-manual-2s11.darcs.patch
Great stuff, the manual is starting to look great.
- Use @sc and @result to make REPL examples pretty, and move them into @example sections.
Is this really necessary? @sc doesn't play very well with colorize, @example's aren't colorized and adding @r to the comments breaks the colorize script.
I can be convinced that colorizing the examples is silly (specially in this ad-hoc way), but if not I'll revert these changes to the examples. Please let me know what do you think about this before I push the patches.
- Use @unnumberedsec in dictionary nodes instead of @heading, and @code the names.
- Use new @seealso macro for "See Also" xrefs.
I kind of prefer not to use @code in these two situtations. Looks better to me probably because that's what both Lispworks's FLI manual and the Texinfo version of the CLHS do. And that was the style I was going for. Also, for some weird reason it doesn't render very well in Safari wrt spacings.
BTW, Is there a way to write some sort of macro, say refsection{foo} that'd expand into:
@node foo @unnumberedsec @code{foo}
?
Anyway, nice job!
--- Luís Oliveira luismbo@gmail.com wrote:
My suggestion is that we should create a common-lisp.net project to host ASDF, its manual and other ASDF-related stuff. :-)
I'll second that!
Cheers, CY
__________________________________________________ Do You Yahoo!? Tired of spam? Yahoo! Mail has the best spam protection around http://mail.yahoo.com
-
C Y -
Luís Oliveira -
Stephen Compall