Add deprecation notices to most mzlib libraries

This commit is contained in:
Asumu Takikawa 2012-07-11 14:31:37 -04:00
parent f747c086d8
commit e414107748
18 changed files with 95 additions and 5 deletions

View File

@ -10,6 +10,8 @@
@mzlib[#:mode title cmdline]
@deprecated[@racketmodname[racket/cmdline]]{}
Provides a @racket[command-line] from that is similar to the one in
@racketmodname[racket/cmdline], but without using keywords. The
@racket[parse-command-line] procedure from

View File

@ -27,9 +27,11 @@
@mzlib[#:mode title contract]
This library is designed as a backwards compatible library
for old uses of contracts. It should not be used for new
libraries; use @racketmodname[racket/contract] instead.
@deprecated[@racketmodname[racket/contract]]{
This library is designed as a backwards compatible library
for old uses of contracts. It should not be used for new
libraries.
}
The main differences: the function contract syntax is more
regular and function contracts now support keywords, and

View File

@ -6,6 +6,8 @@
@mzlib[#:mode title file]
@deprecated[@racketmodname[racket/file]]{}
The @racketmodname[mzlib/file] library mostly re-exports from
@racketmodname[scheme/file]:

View File

@ -4,6 +4,8 @@
@mzlib[#:mode title for]
@deprecated[@racketmodname[racket/base]]{}
The @racketmodname[mzlib/for] library re-exports from
@racketmodname[scheme/base]:

View File

@ -4,6 +4,8 @@
@mzlib[#:mode title include]
@deprecated[@racketmodname[racket/include]]{}
Similar to @racketmodname[scheme/include], but with a different syntax
for paths.

View File

@ -18,6 +18,10 @@
@mzlib[#:mode title kw]
@deprecated[@racketmodname[racket/base]]{The Racket base language
supports keyword arguments. Using the built-in keyword arguments
in Racket is highly recommended.}
@margin-note{The @base-lambda and procedure-application forms of
@racket[scheme/base] support keyword arguments, and it is
@emph{not} compatible with the @racket[mzlib/kw]

View File

@ -4,6 +4,8 @@
@mzlib[#:mode title list]
@deprecated[@racketmodname[racket/list]]{}
The @racketmodname[mzlib/list] library re-exports several functions
from @racketmodname[scheme/base] and @racketmodname[scheme/list]:

View File

@ -12,6 +12,8 @@
@mzlib[#:mode title match]
@deprecated[@racketmodname[racket/match]]{}
The @racketmodname[mzlib/match] library provides a @racket[match] form
similar to that of @racketmodname[racket/match], but with an different
(older and less extensible) syntax of patterns.

View File

@ -4,6 +4,8 @@
@mzlib[#:mode title math]
@deprecated[@racketmodname[racket/math]]{}
Re-exports @racketmodname[scheme/math], and also exports @racket[e].
@defthing[e real?]{

View File

@ -15,6 +15,8 @@ libraries reside in the @filepath{scheme} collection.
@mzlib[a-signature]
@deprecated[@racketmodname[racket/signature]]{}
Like @racketmodname[scheme/signature] in @hash-lang[] form for
defining a single signature within a module, but based on
@racketmodname[mzscheme] instead of @racketmodname[scheme/base].
@ -23,6 +25,8 @@ defining a single signature within a module, but based on
@mzlib[a-unit]
@deprecated[@racketmodname[racket/unit]]{}
Like @racketmodname[scheme/unit] in @hash-lang[] form for defining a
single unit within a module, but based on @racketmodname[mzscheme]
instead of @racketmodname[scheme/base].
@ -31,6 +35,8 @@ instead of @racketmodname[scheme/base].
@mzlib[async-channel]
@deprecated[@racketmodname[racket/async-channel]]{}
Re-exports @racketmodname[scheme/async-channel].
@; ----------------------------------------------------------------------
@ -41,6 +47,8 @@ Re-exports @racketmodname[scheme/async-channel].
@mzlib[class]
@deprecated[@racketmodname[racket/class]]{}
Re-exports @racketmodname[scheme/class], except for the contract
constructors.
@ -52,12 +60,16 @@ constructors.
@mzlib[cm]
@deprecated[@racketmodname[compiler/cm]]{}
Re-exports @racketmodname[compiler/cm].
@; ----------------------------------------------------------------------
@mzlib[cm-accomplice]
@deprecated[@racketmodname[compiler/cm-accomplice]]{}
Re-exports @racketmodname[compiler/cm-accomplice].
@; ----------------------------------------------------------------------
@ -84,18 +96,24 @@ Re-exports @racketmodname[compiler/cm-accomplice].
@mzlib[control]
@deprecated[@racketmodname[racket/control]]{}
Re-exports @racketmodname[scheme/control].
@; ----------------------------------------------------------------------
@mzlib[date]
@deprecated[@racketmodname[racket/date]]{}
Re-exports @racketmodname[scheme/date].
@; ----------------------------------------------------------------------
@mzlib[deflate]
@deprecated[@racketmodname[file/gzip]]{}
Re-exports @racketmodname[file/gzip].
@; ----------------------------------------------------------------------
@ -118,6 +136,8 @@ Re-exports @racketmodname[file/gzip].
@mzlib[foreign]
@deprecated[@racketmodname[ffi/unsafe]]{}
Re-exports @racketmodname[scheme/foreign].
@; ----------------------------------------------------------------------
@ -128,6 +148,8 @@ Re-exports @racketmodname[scheme/foreign].
@mzlib[inflate]
@deprecated[@racketmodname[file/gunzip]]{}
Re-exports @racketmodname[file/gunzip].
@; ----------------------------------------------------------------------
@ -154,6 +176,8 @@ Re-exports @racketmodname[file/gunzip].
@mzlib[md5]
@deprecated[@racketmodname[file/md5]]{}
Re-exports @racketmodname[file/md5].
@; ----------------------------------------------------------------------
@ -184,12 +208,16 @@ Re-exports @racketmodname[file/md5].
@mzlib[pretty]
@deprecated[@racketmodname[racket/pretty]]{}
Re-exports @racketmodname[scheme/pretty].
@; ----------------------------------------------------------------------
@mzlib[process]
@deprecated[@racketmodname[racket/system]]{}
Re-exports @racketmodname[scheme/system].
@; ----------------------------------------------------------------------
@ -200,6 +228,8 @@ Re-exports @racketmodname[scheme/system].
@mzlib[runtime-path]
@deprecated[@racketmodname[racket/runtime-path]]{}
Re-exports @racketmodname[scheme/runtime-path].
@; ----------------------------------------------------------------------
@ -218,6 +248,8 @@ Re-exports @racketmodname[scheme/runtime-path].
@mzlib[shared]
@deprecated[@racketmodname[racket/shared]]{}
Re-exports @racketmodname[scheme/shared].
@; ----------------------------------------------------------------------
@ -232,6 +264,10 @@ Re-exports @racketmodname[scheme/shared].
@mzlib[stxparam]
@deprecated[@racketmodname[racket/stxparam]]{
Also see @racketmodname[racket/stxparam-exptime].
}
Re-exports @racketmodname[scheme/stxparam] and
@racketmodname[scheme/stxparam-exptime] (both at phase level 0).
@ -239,12 +275,16 @@ Re-exports @racketmodname[scheme/stxparam] and
@mzlib[surrogate]
@deprecated[@racketmodname[racket/surrogate]]{}
Re-exports @racketmodname[scheme/surrogate].
@; ----------------------------------------------------------------------
@mzlib[tar]
@deprecated[@racketmodname[file/tar]]{}
Re-exports @racketmodname[file/tar].
@; ----------------------------------------------------------------------
@ -255,6 +295,8 @@ Re-exports @racketmodname[file/tar].
@mzlib[trace]
@deprecated[@racketmodname[racket/trace]]{}
Re-exports @racketmodname[racket/trace].
@; ----------------------------------------------------------------------
@ -265,6 +307,8 @@ Re-exports @racketmodname[racket/trace].
@mzlib[trait]
@deprecated[@racketmodname[racket/trait]]{}
Re-exports @racketmodname[scheme/trait].
@; ----------------------------------------------------------------------
@ -279,12 +323,16 @@ Re-exports @racketmodname[scheme/trait].
@mzlib[unit-exptime]
@deprecated[@racketmodname[racket/unit-exptime]]{}
Re-exports @racketmodname[scheme/unit-exptime].
@; ----------------------------------------
@mzlib[unit200]
@deprecated[@racketmodname[racket/unit]]{}
The @racketmodname[mzlib/unit200] library provides an old
implementation of units. See archived version 360 documentation on the
@filepath{unit.ss} library of the @filepath{mzlib} collection for
@ -294,6 +342,8 @@ information about this library.
@mzlib[unitsig200]
@deprecated[@racketmodname[racket/unit]]{}
The @racketmodname[mzlib/unit200] library provides an old
implementation of units. See archived version 360 documentation on the
@filepath{unitsig.ss} library of the @filepath{mzlib} collection for
@ -303,6 +353,8 @@ information about this library.
@mzlib[zip]
@deprecated[@racketmodname[file/zip]]{}
Re-exports @racketmodname[file/zip].
@; ----------------------------------------------------------------------

View File

@ -4,6 +4,8 @@
@mzlib[#:mode title plt-match]
@deprecated[@racketmodname[racket/match]]{}
The @racketmodname[mzlib/plt-match] library mostly re-provides
@racket[scheme/match].

View File

@ -4,6 +4,8 @@
@mzlib[#:mode title port]
@deprecated[@racketmodname[racket/port]]{}
The @racketmodname[mzlib/port] library mostly re-provides
@racketmodname[racket/port].

View File

@ -5,6 +5,8 @@
@mzlib[#:mode title pregexp]
@deprecated[@racketmodname[racket/base]]{}
The @racketmodname[mzlib/pregexp] library provides wrappers around
@racket[regexp-match], @|etc| that coerce string and byte-string
arguments to @racket[pregexp] matchers instead of @racket[regexp]

View File

@ -5,8 +5,10 @@
@mzlib[#:mode title restart]
@margin-note{See @racket[scheme/sandbox] for a more general way to
simulate running a new Racket process.}
@deprecated[@racketmodname[racket/sandbox]]{
The @racket[racket/sandbox] library provides a more general way to
simulate running a new Racket process.
}
@defproc[(restart-mzscheme [init-argv (vectorof string?)]
[adjust-flag-table (any/c . -> . any/c)]

View File

@ -12,6 +12,8 @@
@mzlib[#:mode title sandbox]
@deprecated[@racketmodname[racket/sandbox]]{}
The @racketmodname[mzlib/sandbox] library mostly re-exports
@racketmodname[racket/sandbox], but it provides a slightly different
@racket[make-evaluator] function.

View File

@ -13,6 +13,8 @@
@mzlib[#:mode title serialize]
@deprecated[@racketmodname[racket/serialize]]{}
The @racketmodname[mzlib/serialize] library provides the same bindings
as @racketmodname[racket/serialize], except that
@racket[define-serializable-struct] and

View File

@ -7,6 +7,10 @@
@mzlib[#:mode title string]
@deprecated[@racketmodname[racket/base]]{
Also see @racketmodname[racket/string]
}
The @racketmodname[mzlib/string] library re-exports several functions
from @racketmodname[scheme/base]:

View File

@ -16,6 +16,8 @@
@mzlib[#:mode title unit]
@deprecated[@racketmodname[racket/unit]]{}
The @racketmodname[mzlib/unit] library mostly re-provides
@racketmodname[racket/unit], except for @racket-struct and
@racket-struct/ctc from @racketmodname[racket/unit].