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

doc and terminology fix

Browse Source
This commit is contained in:
Matthew Flatt 2012-02-26 15:39:23 -05:00
parent bf5ab2a1c9
commit 2d7b97ece9
3 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
collects/scribblings/foreign/types.scrbl
View File

@ -296,7 +296,7 @@ value of @cpp{NULL} is translated to a Racket @racket[eof] value.}
@defthing[_pointer ctype?]{ @defthing[_pointer ctype?]{
Corresponds to Racket ``C pointer'' objects. These pointers can have Corresponds to Racket @deftech{C pointer} values. These pointers can have
an arbitrary Racket object attached as a type tag. The tag is ignored an arbitrary Racket object attached as a type tag. The tag is ignored
by built-in functionality; it is intended to be used by interfaces. by built-in functionality; it is intended to be used by interfaces.
See @secref["foreign:tagged-pointers"] for creating pointer types that See @secref["foreign:tagged-pointers"] for creating pointer types that
@ -316,7 +316,7 @@ refer to the same address.}
@defthing[_gcpointer ctype?]{ @defthing[_gcpointer ctype?]{
Like @racket[_pointer], but for a value that can refer to memory Like @racket[_pointer], but for a C pointer value that can refer to memory
managed by the garbage collector. managed by the garbage collector.
Although a @racket[_gcpointer] can reference to memory that is not Although a @racket[_gcpointer] can reference to memory that is not

4
collects/scribblings/reference/file-ports.scrbl
View File

@ -197,9 +197,9 @@ A @tech{path} value that is the @tech{cleanse}d version of
Like @racket[open-output-file], but producing two values: an input Like @racket[open-output-file], but producing two values: an input
port and an output port. The two ports are connected in that they port and an output port. The two ports are connected in that they
share the underlying file device. This procedure is intended for use share the underlying file descriptor. This procedure is intended for use
with special devices that can be opened by only one process, such as with special devices that can be opened by only one process, such as
@filepath{COM1} in Windows. For regular files, sharing the device can be @filepath{COM1} in Windows. For regular files, sharing the file descriptor can be
confusing. For example, using one port does not automatically flush confusing. For example, using one port does not automatically flush
the other port's buffer, and reading or writing in one port moves the the other port's buffer, and reading or writing in one port moves the
file position (if any) for the other port. For regular files, use file position (if any) for the other port. For regular files, use

17
collects/scribblings/reference/places.scrbl
View File

@ -303,12 +303,16 @@ messages:
@item{@tech{numbers}, @tech{characters}, @tech{booleans}, and @item{@tech{numbers}, @tech{characters}, @tech{booleans}, and
@|void-const|;} @|void-const|;}
@item{@tech{symbols};} @item{@tech{symbols}, where the @racket[eq?]ness of @tech{uninterned}
symbols is preserved within a single message, but not across
messages;}
@item{@tech{strings} and @tech{byte strings}, where mutable strings @item{@tech{strings} and @tech{byte strings}, where mutable strings
and byte strings are automatically replaced by immutable and byte strings are automatically replaced by immutable
variants;} variants;}
@item{@tech{paths} (for any platform);}
@item{@tech{pairs}, @tech{lists}, @tech{vectors}, and immutable @item{@tech{pairs}, @tech{lists}, @tech{vectors}, and immutable
@tech{prefab} structures containing message-allowed values, @tech{prefab} structures containing message-allowed values,
where a mutable vector is automatically replaced by an where a mutable vector is automatically replaced by an
@ -317,12 +321,13 @@ messages:
@item{@tech{place channels}, where a @tech{place descriptor} is @item{@tech{place channels}, where a @tech{place descriptor} is
automatically replaced by a plain place channel;} automatically replaced by a plain place channel;}
@item{foreign pointers such as @racket[_cpointers] and @item{@tech{file-stream ports} and @tech{TCP ports}, where the
cstructs;} underlying representation (such as a file descriptor, socket,
or handle) is duplicated and attached to a fresh port in the
receiving place;}
@item{file ports and tcp ports, the underlying @item{@tech[#:doc '(lib "scribblings/foreign/foreign.scrbl")]{C
file descriptor is dupped and a new port is created with the pointers} as created or accessed via @racketmodname[ffi/unsafe]; and}
dupped file descriptor in the destination place; and}
@item{values produced by @racket[shared-flvector], @item{values produced by @racket[shared-flvector],
@racket[make-shared-flvector], @racket[shared-fxvector], @racket[make-shared-flvector], @racket[shared-fxvector],