about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorMatthew Bauer <mjbauer95@gmail.com>2018-11-18 23:10:39 -0600
committerMatthew Bauer <mjbauer95@gmail.com>2018-11-19 13:02:17 -0600
commit32ddbe3da97657fbd6ebaff27303f72f572bd41f (patch)
treeede4c6cf571933f554fb128f6352b192b6033e47 /doc
parent67d78be03673dff235e9477f968dd6d5b6cb1253 (diff)
doc: typo fixes
Diffstat (limited to 'doc')
-rw-r--r--doc/configuration.xml13
-rw-r--r--doc/cross-compilation.xml4
-rw-r--r--doc/multiple-output.xml2
-rw-r--r--doc/overlays.xml8
-rw-r--r--doc/package-notes.xml2
-rw-r--r--doc/platform-notes.xml6
-rw-r--r--doc/reviewing-contributions.xml30
-rw-r--r--doc/stdenv.xml4
8 files changed, 34 insertions, 35 deletions
diff --git a/doc/configuration.xml b/doc/configuration.xml
index af74f3f9c01fb..624a5bb270abb 100644
--- a/doc/configuration.xml
+++ b/doc/configuration.xml
@@ -132,7 +132,7 @@
   </itemizedlist>
 
   <para>
-   The difference between an a package being unsupported on some system and
+   The difference between a package being unsupported on some system and
    being broken is admittedly a bit fuzzy. If a program
    <emphasis>ought</emphasis> to work on a certain platform, but doesn't, the
    platform should be included in <literal>meta.platforms</literal>, but marked
@@ -175,11 +175,12 @@
 </programlisting>
     </para>
     <para>
-     A more useful example, the following configuration allows only allows
-     flash player and visual studio code:
+     For a more useful example, try the following. This configuration
+     only allows unfree packages named flash player and visual studio
+     code:
 <programlisting>
 {
-  allowUnfreePredicate = (pkg: elem (builtins.parseDrvName pkg.name).name [ "flashplayer" "vscode" ]);
+  allowUnfreePredicate = (pkg: builtins.elem (builtins.parseDrvName pkg.name).name [ "flashplayer" "vscode" ]);
 }
 </programlisting>
     </para>
@@ -286,8 +287,8 @@
 
   <para>
    You can define a function called <varname>packageOverrides</varname> in your
-   local <filename>~/.config/nixpkgs/config.nix</filename> to override nix
-   packages. It must be a function that takes pkgs as an argument and return
+   local <filename>~/.config/nixpkgs/config.nix</filename> to override Nix
+   packages. It must be a function that takes pkgs as an argument and returns a
    modified set of packages.
 <programlisting>
 {
diff --git a/doc/cross-compilation.xml b/doc/cross-compilation.xml
index da664394f2624..77cbf44fb20ca 100644
--- a/doc/cross-compilation.xml
+++ b/doc/cross-compilation.xml
@@ -193,7 +193,7 @@
      <listitem>
       <para>
        These predicates are defined in <literal>lib.systems.inspect</literal>,
-       and slapped on every platform. They are superior to the ones in
+       and slapped onto every platform. They are superior to the ones in
        <varname>stdenv</varname> as they force the user to be explicit about
        which platform they are inspecting. Please use these instead of those.
       </para>
@@ -221,7 +221,7 @@
 
    <para>
     In this section we explore the relationship between both runtime and
-    buildtime dependencies and the 3 Autoconf platforms.
+    build-time dependencies and the 3 Autoconf platforms.
    </para>
 
    <para>
diff --git a/doc/multiple-output.xml b/doc/multiple-output.xml
index e96e84bfe72fd..d18e282c5bd34 100644
--- a/doc/multiple-output.xml
+++ b/doc/multiple-output.xml
@@ -12,7 +12,7 @@
   <para>
    The Nix language allows a derivation to produce multiple outputs, which is
    similar to what is utilized by other Linux distribution packaging systems.
-   The outputs reside in separate nix store paths, so they can be mostly
+   The outputs reside in separate Nix store paths, so they can be mostly
    handled independently of each other, including passing to build inputs,
    garbage collection or binary substitution. The exception is that building
    from source always produces all the outputs.
diff --git a/doc/overlays.xml b/doc/overlays.xml
index 90dd163072d3c..bff2339ca9338 100644
--- a/doc/overlays.xml
+++ b/doc/overlays.xml
@@ -3,9 +3,9 @@
          xml:id="chap-overlays">
  <title>Overlays</title>
  <para>
-  This chapter describes how to extend and change Nixpkgs packages using
-  overlays. Overlays are used to add layers in the fix-point used by Nixpkgs to
-  compose the set of all packages.
+  This chapter describes how to extend and change Nixpkgs using overlays.
+  Overlays are used to add layers in the fixed-point used by Nixpkgs to compose
+  the set of all packages.
  </para>
  <para>
   Nixpkgs can be configured with a list of overlays, which are applied in
@@ -60,7 +60,7 @@
       <para>
        First, if an
        <link xlink:href="#sec-overlays-argument"><varname>overlays</varname>
-       argument</link> to the nixpkgs function itself is given, then that is
+       argument</link> to the Nixpkgs function itself is given, then that is
        used and no path lookup will be performed.
       </para>
      </listitem>
diff --git a/doc/package-notes.xml b/doc/package-notes.xml
index 49f94f3bd5d22..803d343aa0969 100644
--- a/doc/package-notes.xml
+++ b/doc/package-notes.xml
@@ -205,7 +205,7 @@ $ cat $(PRINT_PATH=1 nix-prefetch-url $i | tail -n 1) \
 
   <para>
    Nixpkgs provides a number of packages that will install Eclipse in its
-   various forms, these range from the bare-bones Eclipse Platform to the more
+   various forms. These range from the bare-bones Eclipse Platform to the more
    fully featured Eclipse SDK or Scala-IDE packages and multiple version are
    often available. It is possible to list available Eclipse packages by
    issuing the command:
diff --git a/doc/platform-notes.xml b/doc/platform-notes.xml
index cde27b8a5edfc..b27f248757594 100644
--- a/doc/platform-notes.xml
+++ b/doc/platform-notes.xml
@@ -6,13 +6,13 @@
   <title>Darwin (macOS)</title>
 
   <para>
-   Some common issues when packaging software for darwin:
+   Some common issues when packaging software for Darwin:
   </para>
 
   <itemizedlist>
    <listitem>
     <para>
-     The darwin <literal>stdenv</literal> uses clang instead of gcc. When
+     The Darwin <literal>stdenv</literal> uses clang instead of gcc. When
      referring to the compiler <varname>$CC</varname> or <command>cc</command>
      will work in both cases. Some builds hardcode gcc/g++ in their build
      scripts, that can usually be fixed with using something like
@@ -31,7 +31,7 @@
    </listitem>
    <listitem>
     <para>
-     On darwin libraries are linked using absolute paths, libraries are
+     On Darwin, libraries are linked using absolute paths, libraries are
      resolved by their <literal>install_name</literal> at link time. Sometimes
      packages won't set this correctly causing the library lookups to fail at
      runtime. This can be fixed by adding extra linker flags or by running
diff --git a/doc/reviewing-contributions.xml b/doc/reviewing-contributions.xml
index 849bb9316c608..79ebc400d3604 100644
--- a/doc/reviewing-contributions.xml
+++ b/doc/reviewing-contributions.xml
@@ -17,27 +17,25 @@
   </para>
  </warning>
  <para>
-  The nixpkgs project receives a fairly high number of contributions via GitHub
+  The Nixpkgs project receives a fairly high number of contributions via GitHub
   pull-requests. Reviewing and approving these is an important task and a way
   to contribute to the project.
  </para>
  <para>
-  The high change rate of nixpkgs makes any pull request that remains open for
+  The high change rate of Nixpkgs makes any pull-request that remains open for
   too long subject to conflicts that will require extra work from the submitter
-  or the merger. Reviewing pull requests in a timely manner and being
-  responsive to the comments is the key to avoid these. GitHub provides sort
-  filters that can be used to see the
-  <link
-    xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most
-  recently</link> and the
-  <link
-    xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc">least
+  or the merger. Reviewing pull-requests in a timely manner and being responsive
+  to the comments is the key to avoid this issue. GitHub provides sort filters
+  that can be used to see the <link
+  xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc">most
+  recently</link> and the <link
+  xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-asc">least
   recently</link> updated pull-requests. We highly encourage looking at
   <link xlink:href="https://github.com/NixOS/nixpkgs/pulls?q=is%3Apr+is%3Aopen+review%3Anone+status%3Asuccess+-label%3A%222.status%3A+work-in-progress%22+no%3Aproject+no%3Aassignee+no%3Amilestone">
-  this list of ready to merge, unreviewed pull requests</link>.
+  this list of ready to merge, unreviewed pull-requests</link>.
  </para>
  <para>
-  When reviewing a pull request, please always be nice and polite.
+  When reviewing a pull-request, please always be nice and polite.
   Controversial changes can lead to controversial opinions, but it is important
   to respect every community member and their work.
  </para>
@@ -230,7 +228,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
   <title>New packages</title>
 
   <para>
-   New packages are a common type of pull-requests. These pull requests
+   New packages are a common type of pull-requests. These pull-requests
    consists in adding a new nix-expression for a package.
   </para>
 
@@ -279,7 +277,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
      </listitem>
      <listitem>
       <para>
-       A maintainer must be set, this can be the package submitter or a
+       A maintainer must be set. This can be the package submitter or a
        community member that accepts to take maintainership of the package.
       </para>
      </listitem>
@@ -582,7 +580,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
 
   <para>
    Container system, boot system and library changes are some examples of the
-   pull requests fitting this category.
+   pull-requests fitting this category.
   </para>
  </section>
  <section xml:id="reviewing-contributions--merging-pull-requests">
@@ -590,7 +588,7 @@ $ nix-shell -p nox --run "nox-review -k pr PRNUMBER"
 
   <para>
    It is possible for community members that have enough knowledge and
-   experience on a special topic to contribute by merging pull requests.
+   experience on a special topic to contribute by merging pull-requests.
   </para>
 
   <para>
diff --git a/doc/stdenv.xml b/doc/stdenv.xml
index 9ed9a448c614f..5458b5d31811c 100644
--- a/doc/stdenv.xml
+++ b/doc/stdenv.xml
@@ -581,7 +581,7 @@ let f(h, h + 1, i) = i + h
    </varlistentry>
    <varlistentry>
     <term>
-     <varname>depsTargetTarget</varname>
+     <varname>depsTargetTargetPropagated</varname>
     </term>
     <listitem>
      <para>
@@ -836,7 +836,7 @@ passthru = {
        <para>
         Zip files are unpacked using <command>unzip</command>. However,
         <command>unzip</command> is not in the standard environment, so you
-        should add it to <varname>buildInputs</varname> yourself.
+        should add it to <varname>nativeBuildInputs</varname> yourself.
        </para>
       </listitem>
      </varlistentry>