* [PATCH] Typos in documentation
@ 2012-12-11 21:28 Andreas Enge
2012-12-12 19:14 ` Andreas Enge
2012-12-12 21:23 ` Ludovic Courtès
0 siblings, 2 replies; 3+ messages in thread
From: Andreas Enge @ 2012-12-11 21:28 UTC (permalink / raw)
To: bug-guix
[-- Attachment #1.1: Type: text/plain, Size: 29 bytes --]
See attached patch.
Andreas
[-- Attachment #1.2: Type: text/html, Size: 950 bytes --]
[-- Attachment #2: patch --]
[-- Type: text/x-patch, Size: 4184 bytes --]
--- guix.alt/doc/guix.texi 2012-12-11 21:53:49.000000000 +0100
+++ guix/doc/guix.texi 2012-12-11 22:20:49.000000000 +0100
@@ -105,7 +105,7 @@
@cindex package store
The result of package build functions is @dfn{cached} in the file
system, in a special directory called the @dfn{package store}. In
-practice, each package is installed in a directory of its own, in the
+practice, each package is installed in a subdirectory of its own in the
store---by default under @file{/nix/store}. The directory name contains
a hash of all the inputs used to build that package; thus, changing an
input yields a different directory name.
@@ -160,7 +160,7 @@
The command provides the obvious install, remove, and upgrade
operations. Each invocation is actually a @emph{transaction}: either
-the specified operations succeed, or nothing happens. Thus, if the
+the specified operation succeeds, or nothing happens. Thus, if the
@command{guix-package} processed is terminated during the transaction,
or if a power outage occurs during the transaction, then the user's
profile remains in its previous state, and remains usable.
@@ -180,7 +180,7 @@
management, as described in the introduction (@pxref{Introduction}).
Each @file{/nix/store} package directory name contains a hash of all the
inputs that were used to build that package---compiler, libraries, build
-scripts, etc. This direct correspondence allows users to make sure a
+scripts, etc.. This direct correspondence allows users to make sure a
given package installation matches the current state of their
distribution.
@@ -192,7 +192,7 @@
@node Invoking guix-package
@section Invoking @command{guix-package}
-The @command{guix-package} command it the tool that allows users to
+The @command{guix-package} command is the tool that allows users to
install, upgrade, and remove packages, as well as rolling back to
previous configurations. It operates only on the user's own profile,
and works with normal user privileges (@pxref{Features}). Its syntax
@@ -202,7 +202,7 @@
guix-package @var{options}
@end example
-Primarily, @var{options} specify the operations to be performed during
+Primarily, @var{options} specifies the operations to be performed during
the transaction. Upon completion, a new profile is created, but
previous generations of the profile remain available, should the user
want to roll back.
@@ -223,8 +223,8 @@
@itemx -r @var{package}
Remove @var{package}.
-@item --upgrade=@var{REGEXP}
-@itemx -u @var{REGEXP}
+@item --upgrade=@var{regexp}
+@itemx -u @var{regexp}
Upgrade all the installed packages matching @var{regexp}.
@item --profile=@var{profile}
@@ -283,7 +283,7 @@
its build system, and its dependencies. These definitions can then be
turned into concrete build actions.
-Build actions are performed the Guix daemon, on behalf of users. In a
+Build actions are performed by the Guix daemon, on behalf of users. In a
standard setup, the daemon has write access to the store---the
@file{/nix/store} directory---whereas users do not. The recommended
setup also has the daemon perform builds in chroots, under a specific
@@ -369,7 +369,7 @@
Naturally, @var{gnu-build-system} represents the familiar GNU Build
System, and variants thereof (@pxref{Configuration, configuration and
makefile conventions,, standards, GNU Coding Standards}). In a
-nutshell, packages using the GNU Build System may be configured, build,
+nutshell, packages using the GNU Build System may be configured, built,
and installed with the usual @code{./configure && make && make check &&
make install} command sequence. This is what @var{gnu-build-system}
does.
@@ -420,7 +420,7 @@
Behind the scenes, a derivation corresponding to the @code{<package>}
object is first computed by the @code{package-derivation} procedure.
That derivation is stored in a @code{.drv} file under @file{/nix/store}.
-The build actions is prescribes may then be realized by using the
+The build actions it prescribes may then be realized by using the
@code{build-derivations} procedure (@pxref{The Store}).
@deffn {Scheme Procedure} package-derivation @var{store} @var{package} [@var{system}]
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] Typos in documentation
2012-12-11 21:28 [PATCH] Typos in documentation Andreas Enge
@ 2012-12-12 19:14 ` Andreas Enge
2012-12-12 21:23 ` Ludovic Courtès
1 sibling, 0 replies; 3+ messages in thread
From: Andreas Enge @ 2012-12-12 19:14 UTC (permalink / raw)
To: bug-guix
[-- Attachment #1.1: Type: text/plain, Size: 123 bytes --]
Am Dienstag, 11. Dezember 2012 schrieb Andreas Enge:
> See attached patch.
This time in the required git format.
Andreas
[-- Attachment #1.2: Type: text/html, Size: 1484 bytes --]
[-- Attachment #2: 0002-doc-guix.texi-corrected-typos-and-made-minor-changes.patch --]
[-- Type: text/x-patch, Size: 4995 bytes --]
From 9de3b7b7a5b0e82e621aad77fd4f724f97460343 Mon Sep 17 00:00:00 2001
From: Andreas Enge <andreas@enge.fr>
Date: Wed, 12 Dec 2012 20:13:03 +0100
Subject: [PATCH 2/2] doc/guix.texi: corrected typos and made minor changes
---
doc/guix.texi | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/doc/guix.texi b/doc/guix.texi
index b01aa96..e161972 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -105,7 +105,7 @@ inputs are visible.
@cindex package store
The result of package build functions is @dfn{cached} in the file
system, in a special directory called the @dfn{package store}. In
-practice, each package is installed in a directory of its own, in the
+practice, each package is installed in a subdirectory of its own in the
store---by default under @file{/nix/store}. The directory name contains
a hash of all the inputs used to build that package; thus, changing an
input yields a different directory name.
@@ -160,7 +160,7 @@ packages. It operates on those per-user profiles, and can be used
The command provides the obvious install, remove, and upgrade
operations. Each invocation is actually a @emph{transaction}: either
-the specified operations succeed, or nothing happens. Thus, if the
+the specified operation succeeds, or nothing happens. Thus, if the
@command{guix-package} processed is terminated during the transaction,
or if a power outage occurs during the transaction, then the user's
profile remains in its previous state, and remains usable.
@@ -180,7 +180,7 @@ Finally, Guix takes a @dfn{purely functional} approach to package
management, as described in the introduction (@pxref{Introduction}).
Each @file{/nix/store} package directory name contains a hash of all the
inputs that were used to build that package---compiler, libraries, build
-scripts, etc. This direct correspondence allows users to make sure a
+scripts, etc.. This direct correspondence allows users to make sure a
given package installation matches the current state of their
distribution.
@@ -192,7 +192,7 @@ builds the package from source, locally.
@node Invoking guix-package
@section Invoking @command{guix-package}
-The @command{guix-package} command it the tool that allows users to
+The @command{guix-package} command is the tool that allows users to
install, upgrade, and remove packages, as well as rolling back to
previous configurations. It operates only on the user's own profile,
and works with normal user privileges (@pxref{Features}). Its syntax
@@ -202,7 +202,7 @@ is:
guix-package @var{options}
@end example
-Primarily, @var{options} specify the operations to be performed during
+Primarily, @var{options} specifies the operations to be performed during
the transaction. Upon completion, a new profile is created, but
previous generations of the profile remain available, should the user
want to roll back.
@@ -223,8 +223,8 @@ colon, followed by the name of one of the outputs of the package, as in
@itemx -r @var{package}
Remove @var{package}.
-@item --upgrade=@var{REGEXP}
-@itemx -u @var{REGEXP}
+@item --upgrade=@var{regexp}
+@itemx -u @var{regexp}
Upgrade all the installed packages matching @var{regexp}.
@item --profile=@var{profile}
@@ -283,7 +283,7 @@ familiar packaging concepts, such as the name and version of a package,
its build system, and its dependencies. These definitions can then be
turned into concrete build actions.
-Build actions are performed the Guix daemon, on behalf of users. In a
+Build actions are performed by the Guix daemon, on behalf of users. In a
standard setup, the daemon has write access to the store---the
@file{/nix/store} directory---whereas users do not. The recommended
setup also has the daemon perform builds in chroots, under a specific
@@ -369,7 +369,7 @@ object.
Naturally, @var{gnu-build-system} represents the familiar GNU Build
System, and variants thereof (@pxref{Configuration, configuration and
makefile conventions,, standards, GNU Coding Standards}). In a
-nutshell, packages using the GNU Build System may be configured, build,
+nutshell, packages using the GNU Build System may be configured, built,
and installed with the usual @code{./configure && make && make check &&
make install} command sequence. This is what @var{gnu-build-system}
does.
@@ -420,7 +420,7 @@ tool (@pxref{Invoking guix-build}).
Behind the scenes, a derivation corresponding to the @code{<package>}
object is first computed by the @code{package-derivation} procedure.
That derivation is stored in a @code{.drv} file under @file{/nix/store}.
-The build actions is prescribes may then be realized by using the
+The build actions it prescribes may then be realized by using the
@code{build-derivations} procedure (@pxref{The Store}).
@deffn {Scheme Procedure} package-derivation @var{store} @var{package} [@var{system}]
--
1.7.10.4
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] Typos in documentation
2012-12-11 21:28 [PATCH] Typos in documentation Andreas Enge
2012-12-12 19:14 ` Andreas Enge
@ 2012-12-12 21:23 ` Ludovic Courtès
1 sibling, 0 replies; 3+ messages in thread
From: Ludovic Courtès @ 2012-12-12 21:23 UTC (permalink / raw)
To: Andreas Enge; +Cc: bug-guix
Thanks for catching these!
I applied most of the changes. See below (nitpicking ahead!).
Andreas Enge <andreas@enge.fr> skribis:
> --- guix.alt/doc/guix.texi 2012-12-11 21:53:49.000000000 +0100
> +++ guix/doc/guix.texi 2012-12-11 22:20:49.000000000 +0100
> @@ -105,7 +105,7 @@
> @cindex package store
> The result of package build functions is @dfn{cached} in the file
> system, in a special directory called the @dfn{package store}. In
> -practice, each package is installed in a directory of its own, in the
> +practice, each package is installed in a subdirectory of its own in the
A sub-directory is also a directory. Saying that it’s under /nix/store
should make the “sub” part clear, IMO.
> -scripts, etc. This direct correspondence allows users to make sure a
> +scripts, etc.. This direct correspondence allows users to make sure a
I think the two periods would look odd, typographically.
> -Primarily, @var{options} specify the operations to be performed during
> +Primarily, @var{options} specifies the operations to be performed during
A trick meant to be equivalent to “the options listed in @var{options}”.
Thanks!
Ludo’.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2012-12-12 21:23 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-12-11 21:28 [PATCH] Typos in documentation Andreas Enge
2012-12-12 19:14 ` Andreas Enge
2012-12-12 21:23 ` Ludovic Courtès
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).