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

misc small doc typos

Browse Source 
please include on the release branch
(cherry picked from commit e9b0975838)
This commit is contained in:
Robby Findler 2013-12-03 09:42:11 -06:00 committed by Ryan Culpepper
parent 3d73776eab
commit 55c0ad36e4
1 changed files with 15 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
pkgs/racket-pkgs/racket-doc/pkg/scribblings/getting-started.scrbl
View File

@ -151,7 +151,7 @@ that even if you discover a package name from PLT's @tech{package
catalog}, your installation may be configured to consult a different catalog}, your installation may be configured to consult a different
@tech{package catalog} to locate the package's implementation (to @tech{package catalog} to locate the package's implementation (to
obtain a pre-built version of the package, for example), but you obtain a pre-built version of the package, for example), but you
should expect the inatllation-configured @tech{package catalog} to should expect the installation-configured @tech{package catalog} to
deliver the package that is described on the PLT @tech{package deliver the package that is described on the PLT @tech{package
catalog}. catalog}.
@ -220,7 +220,7 @@ package is updated if the commit identifier doesn't match the
@tech{checksum} of the current installation. @tech{checksum} of the current installation.
In some cases, updating a package may require an update to one of the In some cases, updating a package may require an update to one of the
package's dependencies. That should only happen when the package package's dependencies. That should happen only when the package
requires a new binding, feature, or bug fix from the dependent requires a new binding, feature, or bug fix from the dependent
package, since packages are meant to evolve in an otherwise package, since packages are meant to evolve in an otherwise
backward-compatible way. Package @tech{versions} provide a way for backward-compatible way. Package @tech{versions} provide a way for
@ -379,19 +379,13 @@ Whenever you
@commandline{git push} @commandline{git push}
your changes will automatically be discovered by those who use your changes will automatically be discovered by those who use
@exec{raco pkg update} after installing from your @tech{package source}. @exec{raco pkg update} after installing from your
github-based @tech{package source}.
@; - - - - - - - - - - - - - - - - - - - - - - - - @; - - - - - - - - - - - - - - - - - - - - - - - -
@subsection[#:tag "manual-deploy"]{Manual Deployment} @subsection[#:tag "manual-deploy"]{Manual Deployment}
@margin-note{By default, @exec{raco pkg create} generates a
@filepath{.zip} archive. For more options, refer to the
@command-ref{create} documentation. If you want to generate an archive
through some other means, simply archive what you made in the first
part of this section. For more formal details, refer to the
@tech{package} definition.}
Alternatively, you can deploy your package by publishing it on a URL Alternatively, you can deploy your package by publishing it on a URL
you control. If you do this, it is preferable to create an archive you control. If you do this, it is preferable to create an archive
from your package directory first: from your package directory first:
@ -411,6 +405,13 @@ package archive (and @tech{checksum}). Your changes will automatically be
discovered by those who used your package source when they use discovered by those who used your package source when they use
@exec{raco pkg update}. @exec{raco pkg update}.
@margin-note{By default, @exec{raco pkg create} generates a
@filepath{.zip} archive. For more options, refer to the
@command-ref{create} documentation. If you want to generate an archive
through some other means, simply archive what you made in the first
part of this section. For more formal details, refer to the
@tech{package} definition.}
@; - - - - - - - - - - - - - - - - - - - - - - - - @; - - - - - - - - - - - - - - - - - - - - - - - -
@subsection[#:tag "register-at-catalog"]{Helping Others Discover Your Package} @subsection[#:tag "register-at-catalog"]{Helping Others Discover Your Package}
@ -467,10 +468,10 @@ present interfaces to external, versioned things, such as
package implementors to effectively declare dependencies on provided package implementors to effectively declare dependencies on provided
features. Such declarations allow @exec{raco pkg install} and features. Such declarations allow @exec{raco pkg install} and
@exec{raco pkg update} to help check dependencies. Declaring and @exec{raco pkg update} to help check dependencies. Declaring and
changing a version is optional, and @tech{package catalog} changing a version is optional, and the @tech{package catalog}
ignore version declarations; in particular, a package is a candidate ignores version declarations; in particular, a package is a candidate
for updating when its @tech{checksum} changes, independent of whether for updating when its @tech{checksum} changes, independent of whether
the package's version changes or in which direction the version the package's version changes or even in which direction the version
changes.} changes.}
@item{Packages should not combine large sets of utilities libraries @item{Packages should not combine large sets of utilities libraries
@ -493,7 +494,7 @@ documentation is not useful), define a package
@secref["metadata"]). If you want to keep tests separate, put them a @secref["metadata"]). If you want to keep tests separate, put them a
@pkgname{@nonterm{pkg-name}-test} package that is @emph{not} a @pkgname{@nonterm{pkg-name}-test} package that is @emph{not} a
dependency of @pkgname{@nonterm{pkg-name}}. Similarly, use dependency of @pkgname{@nonterm{pkg-name}}. Similarly, use
@pkgname{@nonterm{package-exe}} for executables.} @pkgname{@nonterm{pkg-name}-exe} for executables.}
@item{Packages should generally provide one collection with a name @item{Packages should generally provide one collection with a name
similar to the name of the package. For example, @pkgname{libgtk1} similar to the name of the package. For example, @pkgname{libgtk1}