Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

minor documentation fixes #711

Merged
merged 1 commit into from
Aug 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion csug/libraries.stex
Original file line number Diff line number Diff line change
Expand Up @@ -1024,7 +1024,7 @@ automatically calls the value of the \scheme{compile-library-handler} parameter
to a procedure that simply calls \scheme{compile-library}) on any imported library if
the object file is missing, older than the corresponding source file,
older than any source files included (via \index{\scheme{include}}\scheme{include}) when the
object file was created, or itself requires a library that has or must
object file was created, or itself requires a library that has been or must
be recompiled, as described in Section~\ref{SECTUSELIBRARIES}.
The default initial value of this parameter is \scheme{#f}.
It can be set to \scheme{#t} via the command-line option
Expand Down
2 changes: 1 addition & 1 deletion csug/system.stex
Original file line number Diff line number Diff line change
Expand Up @@ -2902,7 +2902,7 @@ the parameter \scheme{generate-profile-forms} can be set to \scheme{#f}
to inhibit the expander's implicit generation of \scheme{profile} forms
for all annotated source expressions.
It is also possible to obtain finer control over implicit generation of
\scheme{profile} forms by marking which annotations that should and
\scheme{profile} forms by marking which annotations should and
should not be used for profiling (Section~\ref{SECTSYNTAXANNOTATIONS}).

With block profiling enabled, the compiler similarly instruments the
Expand Down
5 changes: 3 additions & 2 deletions csug/use.stex
Original file line number Diff line number Diff line change
Expand Up @@ -1223,7 +1223,8 @@ control parameters are described in Section~\ref{SECTSMGMTGC}.
\index{profiling}%
Finally, it is often useful to ``profile'' your code to determine that
parts of the code that are executed most frequently.
While this will not help the system optimize your code, it can help
While this may help the system optimize your code, the primary
benefit is to help
you identify ``hot spots'' where you need to concentrate your own
hand-optimization efforts.
In these hot spots, consider using more efficient operators, like
Expand All @@ -1235,7 +1236,7 @@ These operators can make code more readable when used judiciously,
but they can slow down time-critical code.

Section~\ref{SECTMISCPROFILE} describes how to use the compiler's support
for automatic profiling.
for automatic profiling and profile-directed optimization.
Be sure that profiling is not enabled when you compile your production
code, since the code introduced into the generated code to perform the
profiling adds significant run-time overhead.
Expand Down
4 changes: 2 additions & 2 deletions release_notes/release_notes.stex
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,14 @@ creating a syntactic binding for one of the built-in types, such as
As of 9.5.8, syntactic bindings that do not bind an ftype descriptor are no
longer considered when defining ftypes.

This change also allows a base ftype to be bound using `define-ftype`, though
This change also allows a base ftype to be bound using \scheme{define-ftype}, though
this fixes the endianness of the type. For instance:

\schemedisplay
(define-ftype integer-32 integer-32)
\endschemedisplay

This binds the ftype `integer-32` to the native-endian `integer-32`. It is possible to bind both endiannesses by using explicit names:
This binds the ftype \scheme{integer-32} to the native-endian \scheme{integer-32}. It is possible to bind both endiannesses by using explicit names:

\schemedisplay
(define-ftype integer-32-be (endian big integer-32))
Expand Down