From 468d77e8d00b9537116ee2bbc8faa63301580781 Mon Sep 17 00:00:00 2001 From: Asumu Takikawa Date: Fri, 5 Dec 2014 15:26:52 -0500 Subject: [PATCH] More hyperlinks between info.rkt docs 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. --- pkgs/racket-pkgs/racket-doc/pkg/scribblings/pkg.scrbl | 7 +++++++ .../racket-pkgs/racket-doc/scribblings/raco/info.scrbl | 7 +++++++ .../racket-doc/scribblings/raco/setup.scrbl | 10 +++++++++- 3 files changed, 23 insertions(+), 1 deletion(-) diff --git a/pkgs/racket-pkgs/racket-doc/pkg/scribblings/pkg.scrbl b/pkgs/racket-pkgs/racket-doc/pkg/scribblings/pkg.scrbl index e3752a022b..538c7247c2 100644 --- a/pkgs/racket-pkgs/racket-doc/pkg/scribblings/pkg.scrbl +++ b/pkgs/racket-pkgs/racket-doc/pkg/scribblings/pkg.scrbl @@ -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 diff --git a/pkgs/racket-pkgs/racket-doc/scribblings/raco/info.scrbl b/pkgs/racket-pkgs/racket-doc/scribblings/raco/info.scrbl index cb72825bd3..97db62f589 100644 --- a/pkgs/racket-pkgs/racket-doc/scribblings/raco/info.scrbl +++ b/pkgs/racket-pkgs/racket-doc/scribblings/raco/info.scrbl @@ -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]: diff --git a/pkgs/racket-pkgs/racket-doc/scribblings/raco/setup.scrbl b/pkgs/racket-pkgs/racket-doc/scribblings/raco/setup.scrbl index 3ac265c6f9..86046c7a5d 100644 --- a/pkgs/racket-pkgs/racket-doc/scribblings/raco/setup.scrbl +++ b/pkgs/racket-pkgs/racket-doc/scribblings/raco/setup.scrbl @@ -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]