Commit graph

78 commits

Author SHA1 Message Date
Naïm Favier
4580a6608d
doc: fix broken links 2023-01-24 13:27:27 +01:00
Naïm Favier
d11832fd96
doc,nixos/doc: unescape apostrophes
Leftovers from the CommonMark conversion.
2022-12-27 17:13:47 +01:00
Colin Arnott
bac379f30a
doc: use sri hash syntax
The nixpkgs manual contains references to both sri hash and explicit
sha256 attributes. This is at best confusing to new users. Since the
final destination is exclusive use of sri hashes, see nixos/rfcs#131,
might as well push new users in that direction gently.

Notable exceptions to sri hash support are builtins.fetchTarball,
cataclysm-dda, coq, dockerTools.pullimage, elixir.override, and
fetchCrate. None, other than builtins.fetchTarball, are fundamentally
incompatible, but all currently accept explicit sha256 attributes as
input. Because adding backwards compatibility is out of scope for this
change, they have been left intact, but migration to sri format has been
made for any using old hash formats.

All hashes have been manually tested to be accurate, and updates were
only made for missing upstream artefacts or bugs.
2022-12-04 06:12:18 +00:00
Arnout Engelen
0dd7792b4c
nixpkgs/doc: remove unused unfree.xml
This section was broken out into its own file in efb55d2a42 but
apparently never actually got included anywhere.

Since then a more detailed section on using unfree packages has been
introduced.

Copied the introduction and removed the rest of the file.
2022-07-28 16:54:32 +02:00
Klemens Nanni
787a444596 doc: firefox: Show how to use PKCS#11 Proxy Module
`p11-kit-proxy.so` makes it able to use multiple PKCS#11 modules and
manage them through p11-kit(8).

Fix indentation while here.
2022-06-01 01:22:46 +02:00
Martino Fontana
93d624a49a doc/builders: fix typos 2022-03-10 20:43:29 +01:00
Jonathan Ringer
5f91781b55 treewide: remove steam-run-native 2022-03-02 12:25:45 -08:00
Guillaume Girol
a15fbab8e9 doc: minimize mentions of nix-env -i without -A in nixpkgs manual 2021-12-18 12:00:00 +00:00
Jörg Thalheim
e6c02cc4b4 nixpkgs/doc/glibc: better glibc link
also replace unicode symbol in case some environment cannot reproduce the
encoding or font symbol.
2021-09-22 20:29:41 +02:00
Jörg Thalheim
a65e3b66cb
Merge pull request #137601 from fzakaria/faridzakaria/glibc-netbase
glibc: allow environment variable for /etc/ files (i.e. /etc/protocols)
2021-09-21 08:07:02 +01:00
Farid Zakaria
4687d7523b glibc: add dependency on netbase /etc/protocols
Add an explicit dependency on netbase for /etc/protocols

Certain functions in glibc look for files present in /etc such as getprotobyname which reads /etc/protocols.
If you are using Nix over a Linux installation, this file may not be present, and therefore it will cause errors.

- add netbase as a new package in nixpks
- add a dependency in glibc on it using postPatchPhase and substitute
the path

Fixes #124401
2021-09-19 19:37:56 -07:00
github-actions[bot]
8fb1ff7c31
Merge master into staging-next 2021-08-26 18:01:02 +00:00
Luis-Hebendanz
d031843a1e firefox: Added checks for new addon behaviour since v91 2021-08-22 22:17:44 +02:00
Dominik Xaver Hörl
b4e9cd8596 docs: adjust to the new structure of kernel packages 2021-08-12 12:22:05 +02:00
Alexander Ben Nasrallah
c81250a1d3 emacs: fix overrideScope' examples 2021-07-12 16:48:10 +02:00
slotThe
2c529c3cb8 Link to Libera, Matrix instead of Freenode
The project has moved away from Freenode as an IRC network[1], and there
is now a quite large channel on Libera.  As such, we should point users
towards that instead.

This also changes all examples to refer to libera instead of freenode
as, with the recent deletion of all freenode channels, it is perhaps
where most communities are to be found nowadays.

Finally, also link to the official Matrix room[2] as an alternative to
IRC.

Related: https://github.com/NixOS/nixpkgs/pull/129384

[1]: https://discourse.nixos.org/t/join-us-on-matrix-at-nix-nixos-org-migrating-from-freenode
[2]: https://github.com/NixOS/rfcs/pull/94
2021-07-06 16:35:37 +02:00
Chris Martin
023489f623 docs: update Steam instructions to use steam-run-native package
pkgs.steam-run-native is defined as exactly the expression that
these instructions tell you to write, so the instruction is no
longer necessary since we can just tell you to use that.
2021-07-01 02:43:10 -06:00
Jan Tojnar
6ecc641d08
doc: prepare for commonmark
We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly.

Notably:
- Line breaks in lists behave differently.
- Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75
- The auto_identifiers uses a different algorithm – I made the previous ones explicit.
- Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist

While at it, I also fixed the following issues:
- ShellSesssion was used
- Removed some pointless docbook tags.
2021-06-07 06:34:59 +02:00
Sandro
9419ed621f
Merge pull request #108919 from bryanasdev000/doc-dlib
dlib: Update doc to use CommonMark
2021-04-22 03:35:39 +02:00
Sandro
2df2e5f330
Merge pull request #118269 from midchildan/feat/fuse/add-darwin 2021-04-22 03:27:36 +02:00
midchildan
80651c123e
docs: add FUSE packaging tip for Darwin 2021-04-20 00:52:07 +09:00
Bryan A. S
a1e28d3740 doc/builders/packages/dlib.xml: Convert to markdown
Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
2021-04-13 03:40:27 -03:00
Sandro
e355946df1
Merge pull request #103546 from mnacamura/cdda-small-fix 2021-04-12 16:31:01 +02:00
Sandro
899cfc82b9
Delete citrix.xml 2021-04-01 09:38:47 +02:00
Ryan Mulligan
86eedf1785
Merge pull request #108918 from bryanasdev000/doc-citrix
citrix: Update doc to use CommonMark
2021-03-31 22:02:52 -07:00
midchildan
b67362d7f7
doc: add section for FUSE 2021-03-24 02:22:15 +09:00
Bryan A. S
dd50188f4b doc/builders/packages/citrix.xml: Convert to markdown
Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
2021-03-22 20:10:21 -03:00
Sandro
faa9541165
Merge pull request #108921 from bryanasdev000/doc-ibus
ibus: Update doc to use CommonMark
2021-03-21 05:35:04 +01:00
Jörg Thalheim
247c6f4ce3
Merge pull request #115322 from dotlambda/doc-lt
doc: replace &lt; with < in Markdown
2021-03-07 11:47:39 +00:00
Robert Schütz
52de3976b8 doc: replace &lt; with < in Markdown 2021-03-07 11:40:18 +01:00
Robert Hensing
7d551ead60 doc: Format 2021-03-04 18:10:57 +01:00
Niklaus Giger
76561002c2
doc: Convert Eclipse from Docbook to CommonMark
Fixes: https://github.com/NixOS/nixpkgs/issues/105251
2021-02-16 18:58:14 +01:00
Bryan A. S
8bb00cfb6b doc/builders/packages/ibus.xml: Convert to markdown
Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
2021-02-14 01:26:32 -03:00
taku0
3bcfa06742
Merge pull request #108456 from siraben/elm-docs-md
Convert Elm from Docbook to Commonmark
2021-02-13 18:11:24 +09:00
adisbladis
4003f8cbc7
treewide: emacsPackages -> emacs.pkgs & emacsWithPackages -> emacs.pkgs.withPackages
The previous names are now aliases and shouldn't be used anywhere inside nixpkgs.
2021-01-13 17:13:10 +01:00
pacien
108fd69a8c fishPlugins.buildFishPlugin: rename checkFunctionPath parameter 2021-01-11 03:39:57 +01:00
pacien
165937d01e doc/fish: document fish plugins packaging 2021-01-11 02:37:36 +01:00
Ben Siraphob
6a544b73f9 Convert Elm from Docbook to Commonmark 2021-01-05 12:35:50 +07:00
Ryan Mulligan
b8344f9e5c doc: explicit Markdown anchors for top-level headings; remove metadata
I used the existing anchors generated by Docbook, so the anchor part
should be a no-op. This could be useful depending on the
infrastructure we choose to use, and it is better to be explicit than
rely on Docbook's id generating algorithms.

I got rid of the metadata segments of the Markdown files, because they
are outdated, inaccurate, and could make people less willing to change
them without speaking with the author.
2021-01-01 10:02:57 -08:00
Justus K
357f132b94 doc: convert Steam to CommonMark 2020-12-22 20:34:50 -08:00
Jan Tojnar
5fb6fbcad9
Merge pull request #106845 from AndersonTorres/wip-documentation 2020-12-17 18:19:11 +01:00
AndersonTorres
4526fe9804 Convert locales from DocBook to CommonMark 2020-12-16 18:04:34 -03:00
Luis Hebendanz
1c8c134972 firefox: wrapper updating an addon perserves addon settings 2020-12-15 22:02:34 +01:00
Terin Stock
edfe388d1e doc/firefox: correct manual generation
Corrects the level of the "Troubleshooting" section, and adds an anchor
for Firefox.
2020-12-05 00:31:21 -08:00
Ryan Mulligan
25e00d8c7e
Merge pull request #105648 from AndersonTorres/wip-documentation
Documentation updates from Docbook to CommonMark
2020-12-04 21:37:09 -08:00
Jörg Thalheim
29566ca021
Merge pull request #105796 from Luis-Hebendanz/fix_firefox_wrapper
Fix firefox wrapper
2020-12-04 17:01:05 +00:00
Luis Hebendanz
d3a6a124cf firefox: fix wrapper removing existing addons by default 2020-12-04 17:53:14 +01:00
Jan Tojnar
4fd3b00f06
doc/emacs: re-add anchor 2020-12-04 01:34:44 +01:00
Stu
177023d3f1
doc: convert urxvt to CommonMark
* convert urxvt documentation to common mark

* format urxvt documentation

* use ShellSession instead of nix
2020-12-03 06:46:29 -08:00
AndersonTorres
bb0399be3d Convert Shell-Helpers from DocBook to CommonMark 2020-12-03 08:12:35 -03:00