suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

More hyperlinks between info.rkt docs

Browse Source 
This adds links between most of the pages that
are hits for "info.rkt" in the doc search so that
it's easier to find the field specifications.
This commit is contained in:
Asumu Takikawa 2014-12-05 15:26:52 -05:00
parent 2837c995a9
commit 468d77e8d0
3 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
pkgs/racket-pkgs/racket-doc/pkg/scribblings/pkg.scrbl
View File

@ -956,6 +956,13 @@ For example, a basic @filepath{info.rkt} file might be
The following @filepath{info.rkt} fields are used by the package manager:
@margin-note{
When a package is a @tech{single collection package}, its @filepath{info.rkt}
file may specify additional fields that are used for the Scribble documentation
system or other tools. Many of these fields are described
in @secref["setup-info" #:doc '(lib "scribblings/raco/raco.scrbl")].
}
@itemlist[
@item{@racketidfont{collection} --- either @racket['multi] to

7
pkgs/racket-pkgs/racket-doc/scribblings/raco/info.scrbl
View File

@ -21,6 +21,13 @@ example, an @filepath{info.rkt} file specifies how to build the
documentation for a collection, and it lists plug-in tools for
DrRacket or commands for @exec{raco} that the collection provides.
@margin-note{
The fields specified in an @filepath{info.rkt} file are documented
in @secref["metadata" #:doc '(lib "pkg/scribblings/pkg.scrbl")] for
packages and in @secref["setup-info" #:doc '(lib "scribblings/raco/raco.scrbl")]
for collections.
}
Although an @filepath{info.rkt} file contains a module declaration, the
declaration has a highly constrained form. It must match the following
grammar of @racket[_info-module]:

10
pkgs/racket-pkgs/racket-doc/scribblings/raco/setup.scrbl
View File

@ -319,6 +319,12 @@ specific instructions on compiling the collection. See
@filepath{info.rkt} that it uses, and see @secref["info.rkt"] for
information on the format of an @filepath{info.rkt} file.
Additional fields are used by the
@seclink["top" #:doc '(lib "pkg/scribblings/pkg.scrbl") "Racket package manager"]
and are documented in @secref["metadata" #:doc '(lib "pkg/scribblings/pkg.scrbl")].
The @exec{raco test} command also recognizes additional fields, which are
documented in @secref["test-config-info" #:doc '(lib "scribblings/raco/raco.scrbl")].
Optional @filepath{info.rkt} fields trigger additional actions by
@exec{raco setup}:
@ -1290,7 +1296,9 @@ function for installing a single @filepath{.plt} file.
@defmodule[setup/getinfo]{ The @racketmodname[setup/getinfo] library
provides functions for accessing fields in @filepath{info.rkt}
files.}
files. The file format for @filepath{info.rkt} files is documented
in @secref["info.rkt" #:doc '(lib "scribblings/raco/raco.scrbl")].
}
@defproc[(get-info [collection-names (listof string?)]
[#:namespace namespace (or/c namespace? #f) #f]