Commit graph

106 commits

Author SHA1 Message Date
adisbladis f09a770d9c
Merge pull request #130021 from neosimsim/fix-emacs-override-examples
emacs: fix overrideScope' examples
2021-08-04 03:08:33 -05:00
Alexander Ben Nasrallah c81250a1d3 emacs: fix overrideScope' examples 2021-07-12 16:48:10 +02:00
Mauricio Scheffer a7784fe00a buildFHSUserEnv: document profile parameter 2021-07-11 18:12:19 +01: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
Vladimír Čunát 2ee781417e
nixos/*: replace alsa* aliases
The attributes got renamed in PR #126440 and in some places this caused
evaluation errors, e.g. the tarball job was saying (locally)
> attribute 'alsaUtils' missing, at /build/source/nixos/modules/services/audio/alsa.nix:6:4
and I suspect that trunk-combined jobset's failure to evaluate was also caused.
2021-06-10 09:46:55 +02: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
Robert Hensing ed4523186e writeReferencesToFile: docs and tests 2021-05-15 17:04:25 +02:00
Robert Hensing cc60f81e69 writeDirectReferencesToFile: init 2021-05-15 17:04:25 +02:00
Jonas Chevalier c6b62f2381
mkShell: introduce packages argument (#122180)
The distinction between the inputs doesn't really make sense in the
mkShell context.  Technically speaking, we should be using the
nativeBuildInputs most of the time.

So in order to make this function more beginner-friendly, add "packages"
as an attribute, that maps to nativeBuildInputs.

This commit also updates all the uses in nixpkgs.
2021-05-13 19:17:29 +02:00
Bobby Rong 228276fbd0 doc/builders/images/*.xml: Convert to markdown 2021-04-24 09:06:33 +08: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
Robert Hensing 58b21dea78
Merge pull request #116749 from vroad/docker-layered-image-fakeroot
dockerTools.streamLayeredImage: add fakeRootCommands option
2021-04-07 15:02:24 +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
Ryan Mulligan d9b57bfc2c
Merge pull request #108917 from bryanasdev000/doc-ocitools
ocitools: Update doc to use CommonMark
2021-03-31 21:51:38 -07:00
Bernardo Meurer fa9cd72c09
Merge pull request #117360 from midchildan/feat/fuse/darwin
fuse: use macfuse-stubs instead on Darwin
2021-03-24 21:18:40 +00:00
vroad c420e650c9
dockerTools.streamLayeredImage: Update documentation
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2021-03-24 08:24:21 +09:00
Benjamin Hipple 561cc81ee6
Merge pull request #115857 from lbpdt/feature/docker-tools-layered-base-image
dockerTools.buildLayeredImage: support fromImage
2021-03-23 18:15:34 -04:00
midchildan b67362d7f7
doc: add section for FUSE 2021-03-24 02:22:15 +09:00
Louis Blin aae8588182 dockerTools.buildLayeredImage: support fromImage
It is now possible to pass a `fromImage` to `buildLayeredImage` and
`streamLayeredImage`, similar to what `buildImage` currently supports.

This will prepend the layers of the given base image to the resulting
image, while ensuring that at most `maxLayers` are used. It will also
ensure that environment variables from the base image are propagated
to the final image.
2021-03-23 14:50:42 +00:00
Bryan A. S fdc7280a87 doc/builders/images/ocitools.xml: Convert to markdown
Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
2021-03-22 20:13:51 -03: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
vroad 2dce2253bc dockerTools.streamLayeredImage: document fakeRootCommands 2021-03-19 11:54:13 +09:00
Florian Engel 3329093c6a Remove repeating words from doc 2021-03-14 12:15:34 +01:00
Michael Weiss 938453eacd
Merge pull request #102225 from luc65r/fetchsrht
Add fetcher: fetchFromSourcehut
2021-03-11 12:51:13 +01:00
Benjamin Hipple 9c4353833f doc: remove unnecessary \ escapes in dockertools.section.md
These pollute the plain text and, after re-running `nix-build` and looking at
the result, do not appear to have any impact on the rendered version.
2021-03-09 19:02:56 -05:00
luc65r 83a0627f33
fetchFromSourcehut: init 2021-03-08 15:51:24 +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
Robert Hensing a1cf35fbfd doc/builders/images/dockertools.section.md: Fix link labels 2021-03-04 17:44:33 +01:00
Bryan A. S 5a1a08c0a7 doc/builders/images/dockertools.section.md: Fix anchor errors
Also change note notation

Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
2021-03-04 17:18:18 +01:00
Bryan A. S 06e40b3caf doc/builders/images/dockertools.section.md: Indent nix code
Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
2021-03-04 17:18:17 +01:00
Bryan A. S 4b99dbbbcc doc/builders/images/dockertools.xml: Convert to markdown and start improvements
Need to verify things like `error: IDREF "" without matching ID` and `::: {.note}`

Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
2021-03-04 17:18:17 +01:00
Léo Gaspard 037936b7a3
Merge pull request #107322 from sternenseemann/fetch-github-leavedotgit
fetchFromGitHub: also use git if deepClone or leaveDotGit is used
2021-02-21 13:28:00 +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