At Wed, 7 Oct 2015 17:35:44 -0700 (PDT), Anurag Mendhekar wrote:
> Having just submitted my first contribution to Planet
[Note: We use the name "Planet" for an older package system. I see that
you uploaded a package in the new system; assuming that you didn't also
upload to the old system, calling the new one "Planet" may be confusing
some here --- including Robby. We call the new one just "the package
repository".]
> 1. My module is an FFI which requires a specific library. Quite obviously,
> the
> building daemon fails (because it doesn't have this library). But, it seems
> like this a mischaracterization of the package (which does build fine). My
> question is whether this is fixable.
> 2. I have included scribble documentation with the module, but it seems like
> it is not being found. I am not sure if this is somehow linked to the problem
> above.
>
> What do I need to do to fix these two issues? My info.rkt is below.
Yes, these are the same issue. Your documentation starts
#lang scribble/manual
@(require racket/base "wn.ss")
which means that "wn.ss" must be run to build the document. Running
"wn.ss", in turn, needs "libWN".
But you don't actually need to run "wn.ss" to build your documentation.
You should instead write
#lang scribble/manual
@(require (for-label racket/base "wn.ss"))
which pulls in the identity of bindings to "wn.ss", so that references
can be hyperlinked correctly, but `for-label` does not actually run
"wn.ss".
If you make that change, then you'll get a new pile of warnings.
Mostly, the warnings are because your
@defmodule[wn/wn #:packages ("base")]
declaration is inside a particular section, while the documentation for
the module's content is partly in sibling sections. One way to avoid
most of the warnings is to live that `defmodule` to be right after
`title`, or you could leave `defmodule` in place and add
@declare-exporting[wn/wn]
after `title`.
Then, there will still be warnings, and those have to do with things
that are referenced in the documentation but not defined in the
documentation.
In any case, these warnings will not counts as failure for the package
installation.
--
You received this message because you are subscribed to the Google Groups
"Racket Users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to racket-users+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
