Skip to content

Commit

Permalink
doc,nixos/doc: unescape double quotes
Browse files Browse the repository at this point in the history
Leftovers from the CommonMark conversion.
  • Loading branch information
ncfavier committed Dec 27, 2022
1 parent d11832f commit e9e6581
Show file tree
Hide file tree
Showing 25 changed files with 67 additions and 65 deletions.
2 changes: 1 addition & 1 deletion doc/using/configuration.chapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ There are also two ways to try compiling a package which has been marked as unsu
}
```

The difference between a package being unsupported on some system and being broken is admittedly a bit fuzzy. If a program *ought* to work on a certain platform, but doesn't, the platform should be included in `meta.platforms`, but marked as broken with e.g. `meta.broken = !hostPlatform.isWindows`. Of course, this begs the question of what \"ought\" means exactly. That is left to the package maintainer.
The difference between a package being unsupported on some system and being broken is admittedly a bit fuzzy. If a program *ought* to work on a certain platform, but doesn't, the platform should be included in `meta.platforms`, but marked as broken with e.g. `meta.broken = !hostPlatform.isWindows`. Of course, this begs the question of what "ought" means exactly. That is left to the package maintainer.

## Installing unfree packages {#sec-allow-unfree}

Expand Down
2 changes: 1 addition & 1 deletion nixos/doc/manual/configuration/kubernetes.chapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ services.kubernetes = {
};
```

Another way is to assign cluster roles (\"master\" and/or \"node\") to
Another way is to assign cluster roles ("master" and/or "node") to
the host. This enables apiserver, controllerManager, scheduler,
addonManager, kube-proxy and etcd:

Expand Down
2 changes: 1 addition & 1 deletion nixos/doc/manual/configuration/xfce.chapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Thunar:2410): GVFS-RemoteVolumeMonitor-WARNING **: remote volume monitor with db
```

This is caused by some needed GNOME services not running. This is all
fixed by enabling \"Launch GNOME services on startup\" in the Advanced
fixed by enabling "Launch GNOME services on startup" in the Advanced
tab of the Session and Startup settings panel. Alternatively, you can
run this command to do the same thing.

Expand Down
4 changes: 2 additions & 2 deletions nixos/doc/manual/from_md/configuration/kubernetes.chapter.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ services.kubernetes = {
};
</programlisting>
<para>
Another way is to assign cluster roles (&quot;master&quot; and/or
&quot;node&quot;) to the host. This enables apiserver,
Another way is to assign cluster roles (<quote>master</quote> and/or
<quote>node</quote>) to the host. This enables apiserver,
controllerManager, scheduler, addonManager, kube-proxy and etcd:
</para>
<programlisting language="bash">
Expand Down
7 changes: 4 additions & 3 deletions nixos/doc/manual/from_md/configuration/xfce.chapter.xml
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,10 @@ Thunar:2410): GVFS-RemoteVolumeMonitor-WARNING **: remote volume monitor with db
</programlisting>
<para>
This is caused by some needed GNOME services not running. This is
all fixed by enabling &quot;Launch GNOME services on startup&quot;
in the Advanced tab of the Session and Startup settings panel.
Alternatively, you can run this command to do the same thing.
all fixed by enabling <quote>Launch GNOME services on
startup</quote> in the Advanced tab of the Session and Startup
settings panel. Alternatively, you can run this command to do the
same thing.
</para>
<programlisting>
$ xfconf-query -c xfce4-session -p /compat/LaunchGNOME -s true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -290,12 +290,12 @@ $ sudo chown -R 0:0 /nix
<note>
<para>
Support for <literal>NIXOS_LUSTRATE</literal> was added in
NixOS 16.09. The act of &quot;lustrating&quot; refers to the
wiping of the existing distribution. Creating
NixOS 16.09. The act of <quote>lustrating</quote> refers to
the wiping of the existing distribution. Creating
<literal>/etc/NIXOS_LUSTRATE</literal> can also be used on
NixOS to remove all mutable files from your root partition
(anything that’s not in <literal>/nix</literal> or
<literal>/boot</literal> gets &quot;lustrated&quot; on the
<literal>/boot</literal> gets <quote>lustrated</quote> on the
next boot.
</para>
<para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,9 @@ diskutil unmountDisk diskX
sudo dd if=&lt;path-to-image&gt; of=/dev/rdiskX bs=4m
</programlisting>
<para>
After <literal>dd</literal> completes, a GUI dialog &quot;The disk
you inserted was not readable by this computer&quot; will pop up,
which can be ignored.
After <literal>dd</literal> completes, a GUI dialog <quote>The
disk you inserted was not readable by this computer</quote> will
pop up, which can be ignored.
</para>
<note>
<para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
<orderedlist numeration="arabic">
<listitem>
<para>
Add a New Machine in VirtualBox with OS Type &quot;Linux / Other
Linux&quot;
Add a New Machine in VirtualBox with OS Type <quote>Linux /
Other Linux</quote>
</para>
</listitem>
<listitem>
Expand All @@ -38,7 +38,7 @@
<listitem>
<para>
Click on Settings / System / Acceleration and enable
&quot;VT-x/AMD-V&quot; acceleration
<quote>VT-x/AMD-V</quote> acceleration
</para>
</listitem>
<listitem>
Expand Down Expand Up @@ -71,7 +71,7 @@ boot.initrd.checkJournalingFS = false;
<para>
Shared folders can be given a name and a path in the host system in
the VirtualBox settings (Machine / Settings / Shared Folders, then
click on the &quot;Add&quot; icon). Add the following to the
click on the <quote>Add</quote> icon). Add the following to the
<literal>/etc/nixos/configuration.nix</literal> to auto-mount them.
If you do not add <literal>&quot;nofail&quot;</literal>, the system
will not boot properly.
Expand Down
12 changes: 6 additions & 6 deletions nixos/doc/manual/from_md/release-notes/rl-1509.section.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<para>
The <link xlink:href="http://haskell.org/">Haskell</link>
packages infrastructure has been re-designed from the ground up
(&quot;Haskell NG&quot;). NixOS now distributes the latest
(<quote>Haskell NG</quote>). NixOS now distributes the latest
version of every single package registered on
<link xlink:href="http://hackage.haskell.org/">Hackage</link> --
well in excess of 8,000 Haskell packages. Detailed instructions
Expand All @@ -23,8 +23,8 @@
Haskell</link> release since version 0.0 as well as the most
recent <link xlink:href="http://www.stackage.org/">Stackage
Nightly</link> snapshot. The announcement
<link xlink:href="https://nixos.org/nix-dev/2015-September/018138.html">&quot;Full
Stackage Support in Nixpkgs&quot;</link> gives additional
<link xlink:href="https://nixos.org/nix-dev/2015-September/018138.html"><quote>Full
Stackage Support in Nixpkgs</quote></link> gives additional
details.
</para>
</listitem>
Expand Down Expand Up @@ -534,9 +534,9 @@
<itemizedlist spacing="compact">
<listitem>
<para>
&quot;<literal>nix-env -qa</literal>&quot; no longer discovers
Haskell packages by name. The only packages visible in the
global scope are <literal>ghc</literal>,
<quote><literal>nix-env -qa</literal></quote> no longer
discovers Haskell packages by name. The only packages visible in
the global scope are <literal>ghc</literal>,
<literal>cabal-install</literal>, and <literal>stack</literal>,
but all other packages are hidden. The reason for this
inconvenience is the sheer size of the Haskell package set.
Expand Down
6 changes: 3 additions & 3 deletions nixos/doc/manual/from_md/release-notes/rl-1603.section.xml
Original file line number Diff line number Diff line change
Expand Up @@ -632,8 +632,8 @@ error: path ‘/nix/store/*-broadcom-sta-*’ does not exist and cannot be creat
The <literal>services.xserver.startGnuPGAgent</literal> option
has been removed. GnuPG 2.1.x changed the way the gpg-agent
works, and that new approach no longer requires (or even
supports) the &quot;start everything as a child of the
agent&quot; scheme we’ve implemented in NixOS for older
supports) the <quote>start everything as a child of the
agent</quote> scheme we’ve implemented in NixOS for older
versions. To configure the gpg-agent for your X session, add the
following code to <literal>~/.bashrc</literal> or some file
that’s sourced when your shell is started:
Expand Down Expand Up @@ -670,7 +670,7 @@ export GPG_TTY
</programlisting>
<para>
The <literal>gpg-agent(1)</literal> man page has more details
about this subject, i.e. in the &quot;EXAMPLES&quot; section.
about this subject, i.e. in the <quote>EXAMPLES</quote> section.
</para>
</listitem>
</itemizedlist>
Expand Down
10 changes: 5 additions & 5 deletions nixos/doc/manual/from_md/release-notes/rl-1803.section.xml
Original file line number Diff line number Diff line change
Expand Up @@ -495,11 +495,11 @@
<para>
The propagation logic has been changed. The new logic, along
with new types of dependencies that go with, is thoroughly
documented in the &quot;Specifying dependencies&quot; section
of the &quot;Standard Environment&quot; chapter of the nixpkgs
manual. The old logic isn’t but is easy to describe:
dependencies were propagated as the same type of dependency no
matter what. In practice, that means that many
documented in the <quote>Specifying dependencies</quote>
section of the <quote>Standard Environment</quote> chapter of
the nixpkgs manual. The old logic isn’t but is easy to
describe: dependencies were propagated as the same type of
dependency no matter what. In practice, that means that many
<literal>propagatedNativeBuildInputs</literal> should instead
be <literal>propagatedBuildInputs</literal>. Thankfully, that
was and is the least used type of dependency. Also, it means
Expand Down
2 changes: 1 addition & 1 deletion nixos/doc/manual/from_md/release-notes/rl-1903.section.xml
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@
preserved when also setting interface specific rules such as
<literal>networking.firewall.interfaces.en0.allow*</literal>.
These rules continue to use the pseudo device
&quot;default&quot;
<quote>default</quote>
(<literal>networking.firewall.interfaces.default.*</literal>),
and assigning to this pseudo device will override the
(<literal>networking.firewall.allow*</literal>) options.
Expand Down
6 changes: 3 additions & 3 deletions nixos/doc/manual/from_md/release-notes/rl-1909.section.xml
Original file line number Diff line number Diff line change
Expand Up @@ -746,9 +746,9 @@
<literal>services.gitlab.secrets.jwsFile</literal>). This was
done so that secrets aren’t stored in the world-readable nix
store, but means that for each option you’ll have to create a
file with the same exact string, add &quot;File&quot; to the
end of the option name, and change the definition to a string
pointing to the corresponding file; e.g.
file with the same exact string, add <quote>File</quote> to
the end of the option name, and change the definition to a
string pointing to the corresponding file; e.g.
<literal>services.gitlab.databasePassword = &quot;supersecurepassword&quot;</literal>
becomes
<literal>services.gitlab.databasePasswordFile = &quot;/path/to/secret_file&quot;</literal>
Expand Down
12 changes: 6 additions & 6 deletions nixos/doc/manual/from_md/release-notes/rl-2009.section.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1472,8 +1472,8 @@ $ sudo /run/current-system/fine-tune/child-1/bin/switch-to-configuration test
</programlisting>
<para>
The base package has also been upgraded to the 2020-07-29
&quot;Hogfather&quot; release. Plugins might be incompatible
or require upgrading.
<quote>Hogfather</quote> release. Plugins might be
incompatible or require upgrading.
</para>
</listitem>
<listitem>
Expand Down Expand Up @@ -1736,11 +1736,11 @@ CREATE ROLE postgres LOGIN SUPERUSER;
</listitem>
<listitem>
<para>
The cc- and binutils-wrapper’s &quot;infix salt&quot; and
The cc- and binutils-wrapper’s <quote>infix salt</quote> and
<literal>_BUILD_</literal> and <literal>_TARGET_</literal>
user infixes have been replaced with with a &quot;suffix
salt&quot; and suffixes and <literal>_FOR_BUILD</literal> and
<literal>_FOR_TARGET</literal>. This matches the autotools
user infixes have been replaced with with a <quote>suffix
salt</quote> and suffixes and <literal>_FOR_BUILD</literal>
and <literal>_FOR_TARGET</literal>. This matches the autotools
convention for env vars which standard for these things,
making interfacing with other tools easier.
</para>
Expand Down
9 changes: 5 additions & 4 deletions nixos/doc/manual/from_md/release-notes/rl-2105.section.xml
Original file line number Diff line number Diff line change
Expand Up @@ -235,8 +235,8 @@
<para>
The <literal>networking.wireless.iwd</literal> module now
installs the upstream-provided 80-iwd.link file, which sets
the NamePolicy= for all wlan devices to &quot;keep
kernel&quot;, to avoid race conditions between iwd and
the NamePolicy= for all wlan devices to <quote>keep
kernel</quote>, to avoid race conditions between iwd and
networkd. If you don’t want this, you can set
<literal>systemd.network.links.&quot;80-iwd&quot; = lib.mkForce {}</literal>.
</para>
Expand Down Expand Up @@ -1027,7 +1027,7 @@ self: super:
<listitem>
<para>
<link xlink:href="https://kodi.tv/">Kodi</link> has been
updated to version 19.1 &quot;Matrix&quot;. See the
updated to version 19.1 <quote>Matrix</quote>. See the
<link xlink:href="https://kodi.tv/article/kodi-19-0-matrix-release">announcement</link>
for further details.
</para>
Expand Down Expand Up @@ -1298,7 +1298,8 @@ self: super:
<para>
The zookeeper package does not provide
<literal>zooInspector.sh</literal> anymore, as that
&quot;contrib&quot; has been dropped from upstream releases.
<quote>contrib</quote> has been dropped from upstream
releases.
</para>
</listitem>
<listitem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,10 +201,10 @@ The first steps to all these are the same:

::: {.note}
Support for `NIXOS_LUSTRATE` was added in NixOS 16.09. The act of
\"lustrating\" refers to the wiping of the existing distribution.
"lustrating" refers to the wiping of the existing distribution.
Creating `/etc/NIXOS_LUSTRATE` can also be used on NixOS to remove
all mutable files from your root partition (anything that's not in
`/nix` or `/boot` gets \"lustrated\" on the next boot.
`/nix` or `/boot` gets "lustrated" on the next boot.

lustrate /ˈlʌstreɪt/ verb.

Expand Down
4 changes: 2 additions & 2 deletions nixos/doc/manual/installation/installing-usb.section.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ select the image, select the USB flash drive and click "Write".
sudo dd if=<path-to-image> of=/dev/rdiskX bs=4m
```

After `dd` completes, a GUI dialog \"The disk
you inserted was not readable by this computer\" will pop up, which can
After `dd` completes, a GUI dialog "The disk
you inserted was not readable by this computer" will pop up, which can
be ignored.

::: {.note}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use a pre-made VirtualBox appliance, it is available at [the downloads
page](https://nixos.org/nixos/download.html). If you want to set up a
VirtualBox guest manually, follow these instructions:

1. Add a New Machine in VirtualBox with OS Type \"Linux / Other Linux\"
1. Add a New Machine in VirtualBox with OS Type "Linux / Other Linux"

1. Base Memory Size: 768 MB or higher.

Expand All @@ -16,7 +16,7 @@ VirtualBox guest manually, follow these instructions:

1. Click on Settings / System / Processor and enable PAE/NX

1. Click on Settings / System / Acceleration and enable \"VT-x/AMD-V\"
1. Click on Settings / System / Acceleration and enable "VT-x/AMD-V"
acceleration

1. Click on Settings / Display / Screen and select VMSVGA as Graphics
Expand All @@ -41,7 +41,7 @@ boot.initrd.checkJournalingFS = false;

Shared folders can be given a name and a path in the host system in the
VirtualBox settings (Machine / Settings / Shared Folders, then click on
the \"Add\" icon). Add the following to the
the "Add" icon). Add the following to the
`/etc/nixos/configuration.nix` to auto-mount them. If you do not add
`"nofail"`, the system will not boot properly.

Expand Down
4 changes: 2 additions & 2 deletions nixos/doc/manual/release-notes/rl-1509.section.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

In addition to numerous new and upgraded packages, this release has the following highlights:

- The [Haskell](http://haskell.org/) packages infrastructure has been re-designed from the ground up (\"Haskell NG\"). NixOS now distributes the latest version of every single package registered on [Hackage](http://hackage.haskell.org/) \-- well in excess of 8,000 Haskell packages. Detailed instructions on how to use that infrastructure can be found in the [User's Guide to the Haskell Infrastructure](https://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure). Users migrating from an earlier release may find helpful information below, in the list of backwards-incompatible changes. Furthermore, we distribute 51(!) additional Haskell package sets that provide every single [LTS Haskell](http://www.stackage.org/) release since version 0.0 as well as the most recent [Stackage Nightly](http://www.stackage.org/) snapshot. The announcement [\"Full Stackage Support in Nixpkgs\"](https://nixos.org/nix-dev/2015-September/018138.html) gives additional details.
- The [Haskell](http://haskell.org/) packages infrastructure has been re-designed from the ground up ("Haskell NG"). NixOS now distributes the latest version of every single package registered on [Hackage](http://hackage.haskell.org/) \-- well in excess of 8,000 Haskell packages. Detailed instructions on how to use that infrastructure can be found in the [User's Guide to the Haskell Infrastructure](https://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure). Users migrating from an earlier release may find helpful information below, in the list of backwards-incompatible changes. Furthermore, we distribute 51(!) additional Haskell package sets that provide every single [LTS Haskell](http://www.stackage.org/) release since version 0.0 as well as the most recent [Stackage Nightly](http://www.stackage.org/) snapshot. The announcement ["Full Stackage Support in Nixpkgs"](https://nixos.org/nix-dev/2015-September/018138.html) gives additional details.

- Nix has been updated to version 1.10, which among other improvements enables cryptographic signatures on binary caches for improved security.

Expand Down Expand Up @@ -203,7 +203,7 @@ The new option `system.stateVersion` ensures that certain configuration changes
}
```

- \"`nix-env -qa`\" no longer discovers Haskell packages by name. The only packages visible in the global scope are `ghc`, `cabal-install`, and `stack`, but all other packages are hidden. The reason for this inconvenience is the sheer size of the Haskell package set. Name-based lookups are expensive, and most `nix-env -qa` operations would become much slower if we'd add the entire Hackage database into the top level attribute set. Instead, the list of Haskell packages can be displayed by running:
- "`nix-env -qa`" no longer discovers Haskell packages by name. The only packages visible in the global scope are `ghc`, `cabal-install`, and `stack`, but all other packages are hidden. The reason for this inconvenience is the sheer size of the Haskell package set. Name-based lookups are expensive, and most `nix-env -qa` operations would become much slower if we'd add the entire Hackage database into the top level attribute set. Instead, the list of Haskell packages can be displayed by running:

```ShellSession
nix-env -f "<nixpkgs>" -qaP -A haskellPackages
Expand Down
Loading

0 comments on commit e9e6581

Please sign in to comment.