Commit Graph

1483 Commits

Author SHA1 Message Date
Profpatsch
b0c1583a0b doc: stdenv.lib -> lib
Part of: https://github.com/NixOS/nixpkgs/issues/108938

Changing the documentation to not refer to stdenv.lib is the first
step to make people use it directly.
2021-01-11 09:52:27 +01:00
Michele Guerini Rocco
a306b088f6
Merge pull request #108491 from pacien/fishPlugins-wrapFish
wrapFish: add fish shell wrapper package
2021-01-11 09:10:52 +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
Jan Tojnar
88c998fb21
Merge branch 'staging-next' into staging 2021-01-10 23:24:57 +01:00
Dominik Xaver Hörl
25bef2d8f9 treewide: simplify pkgs.stdenv.lib -> pkgs.lib
The library does not depend on stdenv, that `stdenv` exposes `lib` is
an artifact of the ancient origins of nixpkgs.
2021-01-10 20:12:06 +01:00
github-actions[bot]
bd9e17e21f
Merge staging-next into staging 2021-01-10 18:41:46 +00:00
Jörg Thalheim
51894963cb
Merge pull request #89775 from numinit/update-androidenv 2021-01-10 15:09:36 +00:00
Frederik Rietdijk
df2b0589ae Qt docs: we now use qt5-packages.nix 2021-01-10 15:59:45 +01:00
Alyssa Ross
c06b2b3d67 doc: add "prefer lib over stdenv.lib" convention
I think we should have something in the manual people can point to
about this, to avoid rehashing it over and over in PRs.  "stdenv.lib"
makes it look like lib is part of stdenv, which it isn't, and makes it
even more confusing as a newcomer to figure out what stdenv is (and
isn't).
2021-01-10 08:24:52 +01:00
Cyril Cohen
9ffd16b385 coqPackages: refactor 2021-01-09 11:56:17 +01:00
Ben Siraphob
6a544b73f9 Convert Elm from Docbook to Commonmark 2021-01-05 12:35:50 +07:00
numinit
5b91d4ab65 Rework androidenv package generation
androidenv did not previously write license files, which caused certain
gradle-based Android tools to fail. Restructure androidenv's list of
Android packages into a single repo.json file to prevent duplication
and enable us to extract the EULA texts, which we then hash with
builtins.hashString to produce the license files that Android gradle
tools look for.

Remove includeDocs and lldbVersions, as these have been removed
from the Android package repositories.

Improve documentation and examples.
2021-01-03 21:27:23 -07:00
Tikhon Jelvis
70cd2cb336 r-modules: update cran and bioc packages
The last snapshot was 4 months ago (2020-08-19). I also found that I needed newer definitions when I was trying to fix the R arrow package.

This update required a couple of manual changes:

  1. Removing a few deleted packages from default.nix
  2. Renaming the "assert" package to "r_assert" in generate-r-packages.R because "assert" is a keyword in Nix
2021-01-02 15:03:06 -08:00
Ryan Mulligan
dd6c0efa62
Merge pull request #108147 from ryantm/doc-cleanup
doc: explicit Markdown anchors for top-level headings; remove metadata
2021-01-01 11:40:09 -08: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
Daniël de Kok
b6728fa15c docs/rust: describe cargoHash 2020-12-31 11:18:13 +01:00
Justus K
357f132b94 doc: convert Steam to CommonMark 2020-12-22 20:34:50 -08:00
Jan Tojnar
3dfcc7e3a5
Merge pull request #107044 from jtojnar/overridable-php-packages 2020-12-22 22:39:29 +01:00
sternenseemann
0096eb9274 doc/fetchers: document leaveDotGit, deepClone and fetchSubmodules 2020-12-21 14:22:39 +01:00
Jan Tojnar
5fb6fbcad9
Merge pull request #106845 from AndersonTorres/wip-documentation 2020-12-17 18:19:11 +01:00
AndersonTorres
30bfb2f5d0 Convert fetchers from DocBook to CommonMark 2020-12-17 12:00:49 -03:00
AndersonTorres
59f9db8b09 Convert trivial-builders from DocBook to CommonMark 2020-12-17 12:00:48 -03:00
AndersonTorres
4526fe9804 Convert locales from DocBook to CommonMark 2020-12-16 18:04:34 -03:00
AndersonTorres
7113b40fb3 Convert fhs-environments from DocBook to CommonMark 2020-12-16 14:51:43 -03:00
AndersonTorres
23d5784770 Convert mkShell from DocBook to CommonMark 2020-12-16 14:51:43 -03:00
Jan Tojnar
b2594c71c2
php.packages: Make packages overridable
This will allow patching extensions without having to manually having to patch all occurrences in the dependency tree.
2020-12-16 18:32:27 +01:00
Lassulus
00b8fa792b
Merge pull request #106000 from Luis-Hebendanz/firefoxWrapperAddonSettings
firefox: wrapper updating an addon perserves addon settings
2020-12-15 22:16:48 +01:00
Luis Hebendanz
1c8c134972 firefox: wrapper updating an addon perserves addon settings 2020-12-15 22:02:34 +01:00
Robert Hensing
3393e110a9
doc/stdenv/cross-compilation.chapter.md typo
Co-authored-by: John Ericson <git@JohnEricson.me>
2020-12-15 15:57:27 +01:00
Robert Hensing
c7e5c02374
doc/cross-compilation: Remove confusing re-explanation
See https://github.com/NixOS/nixpkgs/issues/106950

> They way it's worded says buildInputs are for build-time and nativeBuildInputs are for run-time. The other documentation leads me to believe it is the other way around.
2020-12-15 11:45:38 +01:00
Ben Siraphob
71a7249a48 doc/stdenv/cross-compilation: convert to markdown 2020-12-13 19:49:39 +07:00
Jan Tojnar
ba11a96653
doc: Add staging workflow diagram 2020-12-09 05:26:55 +01:00
Ryan Mulligan
c2effbb448
Merge pull request #105962 from jtojnar/db-submitting-changes
doc: convert Submitting changes to Markdown
2020-12-07 20:55:33 -08:00
Jan Tojnar
62248877ad
doc/stdenv: Fix xref to gdk-pixbuf setup hook
DocBook does not support creating labels for unordered list items so we need to add a link label ourselves.
2020-12-07 23:49:56 +01:00
Jan Tojnar
be8a3b8d9d
doc: convert GNOME platform docs to markdown 2020-12-07 23:49:56 +01:00
Jan Tojnar
64b8489d54
doc: clean up makefile
The sectn and ulink hacks are not necessary since pandoc has been defaulting to Docbook 5 for a long time.
With the pandoc patches, we can get rid of id→xml:id replacement and xmlns hacks as well.
2020-12-07 23:49:56 +01:00
Jan Tojnar
e4c3cda197
doc: rename gnome to section 2020-12-07 23:49:36 +01:00
Wil Taylor
2eb20aa8ce
doc: Converted Bower docs from xml to md 2020-12-07 09:38:47 +01:00
Stefan Schroeder
9d7082950b
doc: Port Perl to Markdown 2020-12-07 08:45:20 +01:00
github-actions[bot]
0947539ec1
Merge master into staging-next 2020-12-05 12:18:17 +00:00
Jan Tojnar
cc3228e0bb
doc: Clean up submitting changes 2020-12-05 13:03:22 +01:00
Jan Tojnar
035960e4f6
doc: convert Submitting changes to Markdown 2020-12-05 12:43:25 +01:00
Jan Tojnar
5ad6509278
doc: Rename submitting-changes to chapter 2020-12-05 12:33:00 +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
github-actions[bot]
55b348fe1b
Merge master into staging-next 2020-12-05 06:16:24 +00: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
AndersonTorres
f5baf84be5 Convert OCaml from DocBook to CommonMark 2020-12-04 23:35:26 -03:00
github-actions[bot]
cb36dd7449
Merge master into staging-next 2020-12-04 18:14:51 +00: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
github-actions[bot]
884a0b091b
Merge master into staging-next 2020-12-04 00:37:25 +00:00
Jan Tojnar
4fd3b00f06
doc/emacs: re-add anchor 2020-12-04 01:34:44 +01:00
github-actions[bot]
1aeec1f039
Merge master into staging-next 2020-12-03 18:14:40 +00: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
github-actions[bot]
5b73e3087a
Merge master into staging-next 2020-12-03 12:18:45 +00:00
AndersonTorres
bb0399be3d Convert Shell-Helpers from DocBook to CommonMark 2020-12-03 08:12:35 -03:00
Jörg Thalheim
3cd6bc103d
Merge branch 'master' into firefox-nix-addon-support 2020-12-03 07:20:16 +00:00
github-actions[bot]
6f36a7f7c3
Merge master into staging-next 2020-12-03 06:15:27 +00:00
Ryan Mulligan
3a2e9d2ac7
Merge pull request #105752 from ryantm/docbook2commonmark-packages-linux
docs: convert packages/linux docbook -> commonmark
2020-12-02 21:19:35 -08:00
Lucas Eduardo
543f084d62
doc: TeX Live to CommonMark
* converted texlive doc to markdown

Signed-off-by: GitHub <noreply@github.com>

* Remove frontmatter (suggestion)

Co-authored-by: Ryan Mulligan <ryan@ryantm.com>

* Add anchor (suggestion)

Co-authored-by: Ryan Mulligan <ryan@ryantm.com>

* apply suggestions from @ryantm

Signed-off-by: GitHub <noreply@github.com>

* fix nesting of codeblocks into list items as suggested by @jtojnar

Signed-off-by: GitHub <noreply@github.com>

* add anchors for subtopics as said by @jtojnar

Signed-off-by: GitHub <noreply@github.com>

Co-authored-by: Ryan Mulligan <ryan@ryantm.com>
2020-12-02 21:15:18 -08:00
Manuel Mendez
cb912fe2d3 docs: convert packages/linux docbook -> commonmark
Closes #105257
2020-12-02 21:03:26 -08:00
Justus K
58baa3f39c
convert nginx documentation to common mark 2020-12-02 20:14:05 +01:00
github-actions[bot]
89e8bf0f2a
Merge master into staging-next 2020-12-02 12:30:55 +00:00
Jörg Thalheim
7c8994e40e
doc/firefox: initial documentation 2020-12-02 10:02:22 +01:00
Domen Kožar
a0e24a6d40
Merge pull request #101806 from unode/docs
docs: Add 'how to request merging rights'
2020-12-01 17:12:20 +01:00
Frederik Rietdijk
ff90abd5dd Merge staging-next into staging 2020-12-01 14:23:10 +01:00
Corbin Simpson
8c9c0eb38b
doc/builders/packages/opengl: Convert to CommonMark. (#105485)
* doc/builders/packages/opengl: Convert to CommonMark.

* Update doc/builders/packages/opengl.section.md

NVIDIA™

Co-authored-by: Ryan Mulligan <ryan@ryantm.com>

* Update doc/builders/packages/opengl.section.md

NVIDIA™

Co-authored-by: Ryan Mulligan <ryan@ryantm.com>

Co-authored-by: Ryan Mulligan <ryan@ryantm.com>
2020-11-30 22:10:43 -08:00
Ryan Mulligan
1810623a77
Merge pull request #105481 from MostAwesomeDude/docs-commonmark-xorg
doc/builders/packages/xorg: Convert to CommonMark.
2020-11-30 22:08:16 -08:00
Corbin
874e3587ee doc/builders/packages/xorg: Use ShellSession for shell.
I was worried, but the HTML output can still be copy-and-pasted, so it's
not a problem.
2020-11-30 22:03:23 -08:00
Ryan Mulligan
795f75f21d
Merge pull request #105230 from Mic92/java-doc
doc/java: convert to markdown
2020-11-30 21:57:35 -08:00
Corbin
65fe2546b7 doc/builders/packages/xorg: Fix pasto.
I did double-check that the fixed version does what we would want. In
either case, the katamari script is mostly of historical value, and
there's nothing to change in pkgs.
2020-11-30 21:55:39 -08:00
Corbin
fc0f32e0f5 doc/builders/packages/xorg: Acknowledge the retired katamari.
I tested the shell snippets shown here; they work. Note that, because
they're intended for copy-and-paste, I did *not* make them into
ShellSessions with prompts. But that's something I can do if desired.
2020-11-30 21:55:39 -08:00
Corbin
e0fbc4d14c doc/builders/packages/xorg: Convert to CommonMark.
I had to pick 7.4 or 7.5. I picked 7.4 for now.
2020-11-30 21:55:39 -08:00
Ryan Mulligan
6c407c7077
Merge pull request #105322 from fzakaria/ISSUE-105264
doc: convert weechat docs to commonmark
2020-11-30 21:50:31 -08:00
Ryan Mulligan
7812bf4535
Merge pull request #105120 from wayofthepie/coq-to-commonmark
doc: convert coq to commonmark
2020-11-30 21:44:54 -08:00
Jan Tojnar
27b974d84b
Merge branch 'staging-next' into staging 2020-12-01 03:26:36 +01:00
Alex Brandt
195fe01e8b nixos/nixpkgs/docs: fix typo in assertOneOf example
This example was confusing at first because the element the message
indicated wasn't in the list of possible values was but the possible
values didn't match up either.  This ensures the example is consistent
with the logic being presented.
2020-11-30 20:56:33 +00:00
Ryan Mulligan
01e1d5cc9f
Merge pull request #105300 from AndersonTorres/wip-docs
Convert Emacs documentation from XML DocBook to Commonmark
2020-11-30 11:35:51 -08:00
AndersonTorres
19973c1893 Convert Emacs documentation from XML DocBook to CommonMark 2020-11-30 16:16:46 -03:00
zimbatm
bbc9af1f0a
tree-wide: do not use pkgs.extend in nixpkgs
Each invocation of pkgs.extends adds 130MB of allocation to the hydra
evaluator. We are already struggling with the amount of memory nixpkgs
requires.

`pkgs.extend` is a useful escape-hatch, but should be not be used inside
of nixpkgs directly.
2020-11-30 14:24:40 +01:00
Farid Zakaria
aa7493063a doc: convert weechat docs to commonmark
This is essentially an automatic pandoc conversion of the weechat
section in docbook as part of the larger CommonMark Docs project
(https://github.com/NixOS/nixpkgs/projects/37)

fixes #105264

Update doc/builders/packages/weechat.section.md

Co-authored-by: Frederik Rietdijk <freddyrietdijk@fridh.nl>

Update doc/builders/packages/weechat.section.md

Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2020-11-29 21:52:17 -08:00
Wil Taylor
b6bca3d806
doc/Qt: migrate to CommonMark (#105004)
* Updated QT section

* Fixed trailing whitespace

* Update doc/languages-frameworks/qt.section.md

Co-authored-by: Jan Tojnar <jtojnar@gmail.com>

* Update doc/languages-frameworks/qt.section.md

Co-authored-by: Jan Tojnar <jtojnar@gmail.com>

* Made changes to docs as per jtojnar's review

* Added docbook tags for callouts back in

Co-authored-by: Jan Tojnar <jtojnar@gmail.com>
2020-11-29 20:30:29 -08:00
AndersonTorres
25b8aa4a85 Convert Kakoune documentation from XML DocBook to Commonmark 2020-11-29 20:19:28 -03:00
John Ericson
73425f6c3b Merge remote-tracking branch 'upstream/master' into staging 2020-11-28 21:33:03 -05:00
John Ericson
b7650aaa77 rust: Clean up target configs and test some more
See the new docs for details. The difference is vis-a-vis older versions
of this PR, not master.
2020-11-28 19:36:28 +00:00
John Ericson
8ddf5c6907 Merge remote-tracking branch 'upstream/master' into aj-rust-custom-target 2020-11-28 18:10:38 +00:00
John Ericson
c6617d28ef Merge remote-tracking branch 'upstream/master' into aj-rust-custom-target 2020-11-28 17:09:12 +00:00
Ryan Mulligan
3c40c276fa
Merge pull request #105200 from ryantm/update-ruby-doc
doc: Ruby to CommonMark
2020-11-28 07:34:45 -08:00
Jörg Thalheim
762e414d6a
doc/java: convert to markdown 2020-11-28 15:29:04 +01:00
Jörg Thalheim
bc9313d088
Merge pull request #105025 from Mic92/go-doc
doc/go: convert to markdown
2020-11-28 15:03:51 +01:00
Jörg Thalheim
4844ca43d8
Merge pull request #67496 from mb21/patch-1
Docs: clarify Rust overlay on non-NixOS
2020-11-28 14:29:04 +01:00
Graham Bennett
6771aa3093
doc: clarify whitelistedLicenses
see the following for more info:
076860e034/pkgs/stdenv/generic/check-meta.nix (L229)
2020-11-28 10:25:13 +01:00
Jörg Thalheim
80b395015b
doc/go: convert to markdown 2020-11-28 07:32:10 +01:00
applePrincess
698111962e
doc/python: Fix shebang link (#105196) 2020-11-28 04:06:50 +01:00
Ryan Mulligan
6c70fdfd07 doc: ruby improvements
* no hard wrapping
* use ShellSession and nix info strings
* preserve old section anchor link
* update references to present default version
2020-11-27 19:00:41 -08:00
Kamron Mahmoodzadeh
495c2b5112 doc: use newer ruby documentation
With the addition of ruby.withPackages, manveru rewrote the nixpkgs
manual section for the ruby language but did not add it to the manual.
This commit replaces the previous documentation with manveru's updated
version.
2020-11-27 18:59:56 -08:00
Jan Tojnar
136152af80
Merge pull request #101537 from jtojnar/gtk-tracker 2020-11-28 01:37:37 +01:00
Stephen OBrien
a7e9047db3 doc: convert coq to commonmark 2020-11-27 08:13:55 +00:00
Jan Tojnar
95961244d3
doc/gnome: Document gdk-pixbuf setup hook
It was briefly mentioned in stdenv docs but since it interacts with wrapGAppsHook, it should be documented here.
2020-11-26 14:06:08 +01:00