From 8f195a1ff65a05f7679af852f2cbfa58ea8f4bfc Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Wed, 17 Jul 2013 17:22:38 -0600 Subject: [PATCH] change `release-notes' "info.rkt" field to `release-note-files' The change avoids a collision with PLaneT fields. Also, add checking for the form of a `release-note-files' value. --- pkgs/drracket-pkgs/drracket/drracket/info.rkt | 2 +- pkgs/gui-pkgs/gui-lib/mred/info.rkt | 11 +++---- pkgs/htdp-pkgs/htdp-lib/stepper/info.rkt | 2 +- pkgs/htdp-pkgs/htdp-lib/teachpack/info.rkt | 2 +- .../picturing-programs/info.rkt | 2 +- pkgs/plai/info.rkt | 2 +- .../racket-doc/scribblings/raco/setup.scrbl | 4 +-- .../scribblings/main/private/release.rkt | 29 +++++++++++++++++-- pkgs/redex-pkgs/redex-lib/redex/info.rkt | 2 +- .../typed-racket-lib/typed-racket/info.rkt | 2 +- racket/lib/collects/racket/info.rkt | 12 ++++---- 11 files changed, 48 insertions(+), 22 deletions(-) diff --git a/pkgs/drracket-pkgs/drracket/drracket/info.rkt b/pkgs/drracket-pkgs/drracket/drracket/info.rkt index f0eb0bdf26..3979c6fd74 100644 --- a/pkgs/drracket-pkgs/drracket/drracket/info.rkt +++ b/pkgs/drracket-pkgs/drracket/drracket/info.rkt @@ -9,4 +9,4 @@ (define gracket-launcher-names '("DrRacket")) (define gracket-launcher-libraries '("drracket.rkt")) -(define release-notes (list (list "DrRacket" "HISTORY.txt"))) +(define release-note-files (list (list "DrRacket" "HISTORY.txt"))) diff --git a/pkgs/gui-pkgs/gui-lib/mred/info.rkt b/pkgs/gui-pkgs/gui-lib/mred/info.rkt index b483fa5af1..ccd18bf51a 100644 --- a/pkgs/gui-pkgs/gui-lib/mred/info.rkt +++ b/pkgs/gui-pkgs/gui-lib/mred/info.rkt @@ -3,8 +3,9 @@ (define version '(400)) (define post-install-collection "installer.rkt") -(define release-notes '(("GRacket and racket/gui" "HISTORY.txt" - 0 - (("Porting from v5.0.x to v5.1" "Draw_and_GUI_5_1.txt") - ("Porting to v1xxx" "MrEd_100.txt") - ("Porting to v1xxx" "MrEd_100_Framework.txt"))))) +(define release-note-files + '(("GRacket and racket/gui" "HISTORY.txt" + 0 + (("Porting from v5.0.x to v5.1" "Draw_and_GUI_5_1.txt") + ("Porting to v1xxx" "MrEd_100.txt") + ("Porting to v1xxx" "MrEd_100_Framework.txt"))))) diff --git a/pkgs/htdp-pkgs/htdp-lib/stepper/info.rkt b/pkgs/htdp-pkgs/htdp-lib/stepper/info.rkt index b9512ae275..a17dabf0f7 100644 --- a/pkgs/htdp-pkgs/htdp-lib/stepper/info.rkt +++ b/pkgs/htdp-pkgs/htdp-lib/stepper/info.rkt @@ -6,4 +6,4 @@ (define drracket-tool-icons (list '("stepper-32x32.png" "icons"))) -(define release-notes (list (list "Stepper" "HISTORY.txt"))) +(define release-note-files (list (list "Stepper" "HISTORY.txt"))) diff --git a/pkgs/htdp-pkgs/htdp-lib/teachpack/info.rkt b/pkgs/htdp-pkgs/htdp-lib/teachpack/info.rkt index adbb64ae5e..859dfee94f 100644 --- a/pkgs/htdp-pkgs/htdp-lib/teachpack/info.rkt +++ b/pkgs/htdp-pkgs/htdp-lib/teachpack/info.rkt @@ -1,3 +1,3 @@ #lang info -(define release-notes (list (list "Teachpacks" "HISTORY.txt"))) +(define release-note-files (list (list "Teachpacks" "HISTORY.txt"))) diff --git a/pkgs/picturing-programs/picturing-programs/info.rkt b/pkgs/picturing-programs/picturing-programs/info.rkt index fdf4429479..1db4b56680 100644 --- a/pkgs/picturing-programs/picturing-programs/info.rkt +++ b/pkgs/picturing-programs/picturing-programs/info.rkt @@ -8,4 +8,4 @@ (define compile-omit-paths '("tests")) (define blurb `("The picturing-programs collection supersedes the tiles and sb-world collections. It provides functions to rotate, etc. images, as well as a slightly modified version of the universe teachpack.")) - (define release-notes '(("Picturing Programs" "HISTORY.txt"))) + (define release-note-files '(("Picturing Programs" "HISTORY.txt"))) diff --git a/pkgs/plai/info.rkt b/pkgs/plai/info.rkt index b55f09df32..435cd58222 100644 --- a/pkgs/plai/info.rkt +++ b/pkgs/plai/info.rkt @@ -7,7 +7,7 @@ (define primary-file "main.rkt") (define scribblings '(("scribblings/plai.scrbl" (multi-page) (teaching -20)))) -(define release-notes (list (list "PLAI" "HISTORY.txt"))) +(define release-note-files (list (list "PLAI" "HISTORY.txt"))) (define deps '("base" "gui-lib" "sandbox-lib" diff --git a/pkgs/racket-pkgs/racket-doc/scribblings/raco/setup.scrbl b/pkgs/racket-pkgs/racket-doc/scribblings/raco/setup.scrbl index 4d1b4392db..2c84c57c09 100644 --- a/pkgs/racket-pkgs/racket-doc/scribblings/raco/setup.scrbl +++ b/pkgs/racket-pkgs/racket-doc/scribblings/raco/setup.scrbl @@ -434,12 +434,12 @@ Optional @filepath{info.rkt} fields trigger additional actions by is given a value of @racket[10], the search page is given a value of @racket[-10], and the default is @racket[0].} - @item{@as-index{@racketidfont{release-notes}} : @racket[(listof (cons/c string? (cons/c string? list?)))] --- + @item{@as-index{@racketidfont{release-note-files}} : @racket[(listof (cons/c string? (cons/c string? list?)))] --- A list of release-notes text files to link from the main documentation pages. Each note is itself represented as a list, and the list can specify auxiliary notes that are grouped with the main note. - A @racketidfont{release-notes} entry must be a value + A @racketidfont{release-note-files} entry must be a value that can be generated from an expression matching the following @racket[entry] grammar: diff --git a/pkgs/racket-pkgs/racket-index/scribblings/main/private/release.rkt b/pkgs/racket-pkgs/racket-index/scribblings/main/private/release.rkt index 805615d848..16ba481114 100644 --- a/pkgs/racket-pkgs/racket-index/scribblings/main/private/release.rkt +++ b/pkgs/racket-pkgs/racket-index/scribblings/main/private/release.rkt @@ -11,12 +11,37 @@ (struct notes (pos label path subs) #:transparent) +(define (check-release-note-files l dir) + (if (and (list? l) + (for/and ([v (in-list l)]) + (and ((length v) . >= . 2) + (string? (car v)) + (path-string? (cadr v)) + (or (null? (cddr v)) + (exact-integer? (caddr v)) + (or (null? (cdddr v)) + (list? (cadddr v)) + (for/and ([i (in-list (cadddr v))]) + (and (list? i) + (= (length i) 2) + (string? (car i)) + (path-string? (cadr i))))))))) + #t + (begin + (log-error "bad `release-note-files' entry in: ~a value: ~e" + (build-path dir "info.rkt") + l) + #f))) + (define (build-release-list which) (sort - (for*/list ([dir (in-list (find-relevant-directories '(release-notes) which))] + (for*/list ([dir (in-list (find-relevant-directories '(release-note-files) which))] [rel (let ([i (get-info/full dir)]) (if i - (i 'release-notes (lambda () null)) + (let ([v (i 'release-note-files (lambda () null))]) + (if (check-release-note-files v dir) + v + null)) null))]) (define label (car rel)) (define file (cadr rel)) diff --git a/pkgs/redex-pkgs/redex-lib/redex/info.rkt b/pkgs/redex-pkgs/redex-lib/redex/info.rkt index fe553fed27..159928f76f 100644 --- a/pkgs/redex-pkgs/redex-lib/redex/info.rkt +++ b/pkgs/redex-pkgs/redex-lib/redex/info.rkt @@ -3,6 +3,6 @@ (define collection "redex") (define name "PLT Redex") -(define release-notes (list (list "Redex" "HISTORY.txt"))) +(define release-note-files (list (list "Redex" "HISTORY.txt"))) diff --git a/pkgs/typed-racket-pkgs/typed-racket-lib/typed-racket/info.rkt b/pkgs/typed-racket-pkgs/typed-racket-lib/typed-racket/info.rkt index 142dfc7c43..f4f7f2b93d 100644 --- a/pkgs/typed-racket-pkgs/typed-racket-lib/typed-racket/info.rkt +++ b/pkgs/typed-racket-pkgs/typed-racket-lib/typed-racket/info.rkt @@ -1,3 +1,3 @@ #lang info -(define release-notes '(("Typed Racket" "HISTORY.txt"))) +(define release-note-files '(("Typed Racket" "HISTORY.txt"))) diff --git a/racket/lib/collects/racket/info.rkt b/racket/lib/collects/racket/info.rkt index 23db2a5316..19408a674f 100644 --- a/racket/lib/collects/racket/info.rkt +++ b/racket/lib/collects/racket/info.rkt @@ -1,8 +1,8 @@ #lang info -(define release-notes '(("Racket core" "HISTORY.txt" - -100 - (("Porting from v4.x to v5.x" "Racket_5.txt") - ("Porting from v3xxx to v4.x" "MzScheme_4.txt") - ("Porting from v2xxx to v3xxx" "MzScheme_300.txt") - ("Porting from v1xxx to v2xxx" "MzScheme_200.txt"))))) +(define release-note-files '(("Racket core" "HISTORY.txt" + -100 + (("Porting from v4.x to v5.x" "Racket_5.txt") + ("Porting from v3xxx to v4.x" "MzScheme_4.txt") + ("Porting from v2xxx to v3xxx" "MzScheme_300.txt") + ("Porting from v1xxx to v2xxx" "MzScheme_200.txt")))))