[PATCH] doc: Fix minor typos and add missing words.

[PATCH] doc: Fix minor typos and add missing words.

[Chris Marusich]

[-- Attachment #1: Type: text/plain, Size: 298 bytes --]

Hi,

Thank you for the high quality documentation! Here's a patch to fix some
minor typos in the manual. Since "git send-email" doesn't work yet out
of the box on GuixSD (for me, at least), I've attached the patch by
hand.

Please let me know if anything needs to be changed.

Best regards,
Chris


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-doc-Fix-minor-typos-and-add-missing-words.patch --]
[-- Type: text/x-patch, Size: 2836 bytes --]

From ed3770fbc5d14899831359925c127a0f6bebde68 Mon Sep 17 00:00:00 2001
From: Chris Marusich <cmmarusich@gmail.com>
Date: Mon, 22 Feb 2016 22:25:09 -0800
Subject: [PATCH] doc: Fix minor typos and add missing words.

* doc/guix.texi (Shepherd Services): Add missing words.
  (Invoking guix system): Fix typo.
  (Service Types and Services): Fix typo.
* doc/contributing.texi (Submitting Patches): Fix typo.
---
 doc/contributing.texi |  6 +++---
 doc/guix.texi         | 14 +++++++-------
 2 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index 54fb23a..3dbd3db 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -315,6 +315,6 @@ extensions---or to the operating system kernel---e.g., reliance on
 
 @end enumerate
 
-When posting a patch to the mailing list, use @samp{[PATCH] @dots{}} as a
-subject.  You may use your email client or the @command{git send-mail}
-command.
+When posting a patch to the mailing list, use @samp{[PATCH] @dots{}} as
+a subject.  You may use your email client or the @command{git
+send-email} command.
diff --git a/doc/guix.texi b/doc/guix.texi
index 51b0652..1bb44cb 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -9338,7 +9338,7 @@ guix system @var{options}@dots{} @var{action} @var{file}
 
 @var{file} must be the name of a file containing an
 @code{operating-system} declaration.  @var{action} specifies how the
-operating system is instantiate.  Currently the following values are
+operating system is instantiated.  Currently the following values are
 supported:
 
 @table @code
@@ -9804,7 +9804,7 @@ the composition of the extensions.
 
 Udev extensions are composed into a list of rules, but the udev service
 value is itself a @code{<udev-configuration>} record.  So here, we
-extend that record by appending the list of rules is contains to the
+extend that record by appending the list of rules it contains to the
 list of contributed rules.
 @end table
 
@@ -9998,11 +9998,11 @@ extend it by passing it lists of packages to add to the system profile.
 
 @cindex PID 1
 @cindex init system
-The @code{(gnu services shepherd)} provides a way to define services
-managed by the GNU@tie{}Shepherd, which is GuixSD initialization
-system---the first process that is started when the system boots,
-aka. PID@tie{}1 (@pxref{Introduction,,, shepherd, The GNU Shepherd
-Manual}).
+The module @code{(gnu services shepherd)} provides a way to define
+services managed by the GNU@tie{}Shepherd, which is the GuixSD
+initialization system---the first process that is started when the
+system boots, aka. PID@tie{}1 (@pxref{Introduction,,, shepherd, The GNU
+Shepherd Manual}).
 
 Services in the Shepherd can depend on each other.  For instance, the
 SSH daemon may need to be started after the syslog daemon has been
-- 
2.5.0

Re: [PATCH] doc: Fix minor typos and add missing words.

[Alex Kost]

Chris Marusich (2016-02-23 10:01 +0300) wrote:

> Hi,
>
> Thank you for the high quality documentation! Here's a patch to fix some
> minor typos in the manual. Since "git send-email" doesn't work yet out
> of the box on GuixSD (for me, at least), I've attached the patch by
> hand.

To make "git send-email" work, you need to install "send-email" output
of "git" package:

  guix package -i git:send-email

[...]
>  @cindex PID 1
>  @cindex init system
> -The @code{(gnu services shepherd)} provides a way to define services
> -managed by the GNU@tie{}Shepherd, which is GuixSD initialization
> -system---the first process that is started when the system boots,
> -aka. PID@tie{}1 (@pxref{Introduction,,, shepherd, The GNU Shepherd
> -Manual}).
> +The module @code{(gnu services shepherd)} provides a way to define

I would rather write: "The @code{(gnu services shepherd)} module ..."
But I don't know if it's preferable or not, other opinions are needed.
The rest fixes look good to me.

-- 
Alex

Re: [PATCH] doc: Fix minor typos and add missing words.

[Andreas Enge]

On Tue, Feb 23, 2016 at 10:53:57AM +0300, Alex Kost wrote:
> I would rather write: "The @code{(gnu services shepherd)} module ..."
> But I don't know if it's preferable or not, other opinions are needed.
> The rest fixes look good to me.

I will have a look at the documentation again next weekend (at the latest)
and can integrate this suggestion, as well as other pending ones.

Andreas

Re: [PATCH] doc: Fix minor typos and add missing words.

[Andreas Enge]

On Tue, Feb 23, 2016 at 10:53:57AM +0300, Alex Kost wrote:
> I would rather write: "The @code{(gnu services shepherd)} module ..."
> But I don't know if it's preferable or not, other opinions are needed.
> The rest fixes look good to me.

I agree and pushed like this.

Thanks, Chris and Alex!

Andreas

Re: [PATCH] doc: Fix minor typos and add missing words.

[Chris Marusich]

Andreas Enge <andreas@enge.fr> writes:

> On Tue, Feb 23, 2016 at 10:53:57AM +0300, Alex Kost wrote:
>> I would rather write: "The @code{(gnu services shepherd)} module ..."
>> But I don't know if it's preferable or not, other opinions are needed.
>> The rest fixes look good to me.
>
> I agree and pushed like this.

That works, too! Thanks for incorporating my feedback.

Chris