Commit Graph

1899 Commits

Author SHA1 Message Date
Jan Tojnar
23f71e9427
Merge pull request #136345 from Pamplemousse/doc
doc: clarification of dependencies related attributes
2021-10-26 09:52:37 +02:00
Jonathan Ringer
fc25d94010
Merge remote-tracking branch 'origin/master' into staging-next
Conflicts:
	pkgs/development/python-modules/jupyter-client/default.nix
	pkgs/development/python-modules/jupyterlab-git/default.nix
2021-10-22 09:33:07 -07:00
Sergei Trofimovich
c6b949c09c ruby_2_6, rubyPackages_2_6: drop unused package 2021-10-22 08:46:57 +01:00
Doron Behar
eb048d8fe2 Rephrase makeWrapper setup-hook 2021-10-20 08:59:29 +03:00
Vladimír Čunát
01df3cd7dd
Merge branch 'master' into staging-next 2021-10-19 19:24:43 +02:00
Doron Behar
6517e5b10f Improve explenations for wrap*Program 2021-10-19 17:33:02 +03:00
Sandro
ced3db168b
Merge pull request #142173 from baloo/baloo/rust/doc-target-escape 2021-10-19 15:12:40 +02:00
Doron Behar
ba86a1916b makeBinaryWrapper: Document 2021-10-19 05:30:42 -07:00
Manuel Bärenz
7a135abf60
Merge pull request #98214 from turion/dev_test_all_agda_packages
Fix #98209. Test all agda packages
2021-10-19 09:56:50 +02:00
Arthur Gautier
c1a440b6cc doc: rust: target escape hatch has been removed
As far as I can tell, a8efb2053f removed
the `target =` escape hatch.
See #112804

This commit removes it from the documentation.

Signed-off-by: Arthur Gautier <baloo@superbaloo.net>
2021-10-19 05:38:45 +00:00
Pavol Rusnak
eca667180b
dotnet: cleanup; point dotnet-sdk alias to 5_0; remove unsupported SDKs 2021-10-18 23:46:17 +02:00
github-actions[bot]
0cb186d33d
Merge staging-next into staging 2021-10-12 18:01:50 +00:00
Kevin Cox
f6e161d60a
Merge pull request #139222 from IvarWithoutBones/init/buildDotnet
buildDotnetModule: init
2021-10-12 09:13:44 -04:00
github-actions[bot]
c081bc394c
Merge staging-next into staging 2021-10-07 18:01:44 +00:00
Robert Hensing
45da228a49
Merge pull request #140396 from laikq/srcs-doc
doc: reference sourceRoot in description of srcs
2021-10-07 15:03:45 +02:00
IvarWithoutBones
a87e6645dd buildDotnetModule: add documentation 2021-10-06 22:14:24 +02:00
github-actions[bot]
4bbe70b6f4
Merge staging-next into staging 2021-10-06 00:02:16 +00:00
Sandro
f289d93a41
doc/contributing: add lib.optional (#121251)
Co-authored-by: Cole Helbling <cole.e.helbling@outlook.com>
2021-10-05 23:13:26 +02:00
laikq
6ef3c96ddf doc: reference sourceRoot in description of srcs 2021-10-05 08:47:08 +02:00
Martin Weinelt
938d796b7a
python310: 3.10.0-rc2 -> 3.10.0 2021-10-05 02:08:07 +02:00
Martin Weinelt
846e2b1919
python36: remove 2021-10-03 12:42:24 +02:00
github-actions[bot]
b94e7d766f
Merge master into staging-next 2021-09-30 18:01:02 +00:00
Sandro
2495c0f9d9
Merge pull request #140013 from raboof/jre_minimal_document_headless 2021-09-30 17:20:08 +02:00
Arnout Engelen
4236dfe203
jre_minimal: document how to use a headless JDK
For a smaller image
2021-09-30 10:34:51 +02:00
github-actions[bot]
a70629a8e5
Merge master into staging-next 2021-09-27 18:01:07 +00:00
thomassdk
457ff3835c
doc: fix misspelling (#139623)
doc/builders/fetchers.chapter.md: fetcheres -> fetchers
2021-09-27 20:32:10 +08:00
github-actions[bot]
4b360da656
Merge master into staging-next 2021-09-27 12:01:15 +00:00
Justin Bedo
5309818bf7
doc: clarify location of rPackages overrides
Detail the location of rPackage overrides and how broken
builds should be addressed.
2021-09-26 07:29:58 +10:00
Justin Bedo
9bc37bff1a
rPackages: mark packages as broken when generating package sets
The current behaviour for generate-r-packages.R is to delete
packages that have been remove upstream. This patch changes the
behaviour to mark packages as broken rather than removing them.
This has the advantage of never breaking expressions, which
previously occured when a package with overrides in default.nix
was deleted. As a result, the update procedure is simplified,
allowing automated updates to the package tree to run, and
additionally if a package is re-established upstream the previous
overrides still exist.
2021-09-24 21:25:53 +10:00
github-actions[bot]
c836da689f
Merge staging-next into staging 2021-09-23 00:03:12 +00:00
Guillaume Girol
4bc83aaffa
Merge pull request #136489 from ehmry/nimPackages
nimpackages / buildNimPackage
2021-09-22 18:35:38 +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
github-actions[bot]
2505488672
Merge staging-next into staging 2021-09-22 12:02:01 +00:00
Robin Stumm
5b0a3115c8 doc: rust: rephrase paragraph about cargoLock.lockFileContents
mentioning that `Cargo.lock` cannot be patched in the `patchPhase`
2021-09-22 20:32:19 +09:00
Robin Stumm
4771684208 doc: rust: simplify snippet
Do not use recursive attribute sets where not needed, it could confuse the reader.
2021-09-22 20:32:19 +09:00
Robin Stumm
4ab63a8ca8 doc: rust: improve clarity of example snippet
Make it more clear that the return type is a string.

Co-authored-by: figsoda <figsoda@pm.me>
2021-09-22 20:32:19 +09:00
Robin Stumm
4ecb3e8795 doc: rust: document cargoLock.lockFileContents 2021-09-22 20:32:19 +09:00
github-actions[bot]
5752e84b6c
Merge staging-next into staging 2021-09-21 18:01:49 +00:00
Robert Hensing
1648346444
Merge pull request #136022 from hercules-ci/fetcher-testing
Fetcher testing
2021-09-21 14:50:28 +02:00
github-actions[bot]
aff0e5c530
Merge staging-next into staging 2021-09-21 12:02:04 +00:00
ppom
896623dbe9 patchelf: fix homepage 2021-09-21 13:04:09 +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
Sandro
d4a03a75e9
Merge pull request #137243 from KarlJoad/octave-docs
octavePackages: add documentation
2021-09-20 11:54:51 +02:00
Théo Zimmermann
20291381c1 coqPackages.mkCoqDerivation: rely on namePrefix to compute default opam-name
As suggested by Cyril Cohen in https://github.com/NixOS/nixpkgs/pull/134362#discussion_r698379405.
2021-09-20 11:10:23 +02: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
Robert Hensing
ac78ae80a4 invalidateFetcherByDrvHash move docs to manual 2021-09-19 20:27:32 +02:00
Robert Hensing
b502de6476 doc/builders/fetchers: Explain invalidateFetcherByDrvHash 2021-09-19 19:45:12 +02:00
Robert Hensing
f74b160832 doc/builders/fetchers: Document FOD caveats 2021-09-19 19:33:18 +02:00
Markus S. Wamser
b06ffb4b45 doc/rust: add missing fetchfromGitHub to derivation example 2021-09-19 16:41:11 +00:00
markuskowa
3333520a83
Merge pull request #138140 from markuskowa/fix-mpi-manual
nixpkgs/manual: add mvapich to overlays/mpi section
2021-09-17 10:48:01 +02:00
D Anzorge
d6c2bb73fb doc/python: fix typo in example 2021-09-17 00:47:45 +02:00
Markus Kowalewski
05f3789ef8
nixpkgs/manual: add mvapich to overlays/mpi section 2021-09-16 15:16:47 +02:00
Karl Hallsby
a75b1fa5a9 octavePackages: add documentation 2021-09-12 00:03:29 -05:00
github-actions[bot]
58f8f1f058
Merge master into staging-next 2021-09-08 00:01:42 +00:00
Jan Tojnar
1e75936926
Merge pull request #130047 from NixOS/doc-manpage-role
doc: Add support for manpage references
2021-09-07 21:29:26 +02:00
Emery Hemingway
35de51aa26 Nim: Add documentation and GitHub metadata 2021-09-05 11:20:02 +02:00
Alyssa Ross
071a7a4583
Merge remote-tracking branch 'nixpkgs/master' into staging-next 2021-09-03 18:23:45 +00:00
Akshat
98a3230afa remove a mention of #node.section.md
node.section.md has been removed so this commit removes the reference of it inside javascript.section.md
2021-09-03 21:45:20 +09:00
Alyssa Ross
c13cf1e76f
Merge remote-tracking branch 'nixpkgs/master' into staging-next 2021-09-01 07:47:01 +00:00
Pamplemousse
f48c175fb2 doc: clarification of dependencies related attributes
Signed-off-by: Pamplemousse <xav.maso@gmail.com>
2021-08-31 16:57:46 -07:00
happysalada
6c10f151a1 docs: update beam.section 2021-08-31 12:00:47 +09:00
github-actions[bot]
8fb1ff7c31
Merge master into staging-next 2021-08-26 18:01:02 +00:00
Martin Weinelt
7e1cdd2548
Merge pull request #133504 from Luis-Hebendanz/fix_firefox2
firefox: Added checks for new addon behaviour since v91
2021-08-26 19:51:08 +02:00
Dmitry Kalinkin
262fd63a72
Merge branch 'master' into staging-next
Conflicts:
	pkgs/tools/networking/inetutils/default.nix
2021-08-26 00:57:08 -04:00
Sheena Artrip
91106928cf doc/beam: fix syntax error in nix sample 2021-08-26 09:46:38 +09:00
github-actions[bot]
1bf55a993f
Merge master into staging-next 2021-08-26 00:01:37 +00:00
Martin Weinelt
304ed7c421 doc/python: explain bulk package set updates 2021-08-25 12:33:10 -07:00
Vladimír Čunát
70e05c1003
Merge branch 'master' into staging-next 2021-08-25 19:42:15 +02:00
Bill Ewanick
a2b179a3dc Update doc/languages-frameworks/javascript.section.md
Co-authored-by: Jonathan Ringer <jonringer@users.noreply.github.com>
2021-08-25 09:02:06 +09:00
Bill Ewanick
dabd16e7f2 Adding dependency override example 2021-08-25 09:02:06 +09:00
Bill Ewanick
e89b36e4cb Adding tips/searching section 2021-08-25 09:02:06 +09:00
Bill Ewanick
1b76da0cad Minor corrections 2021-08-25 09:02:06 +09:00
Luis-Hebendanz
d031843a1e firefox: Added checks for new addon behaviour since v91 2021-08-22 22:17:44 +02:00
Jan Tojnar
7a04c2ad68 Merge branch 'staging-next' into staging
- boost 171 removed on staging-next
- re-generated node-packages.nix

; Conflicts:
;	pkgs/development/java-modules/m2install.nix
;	pkgs/development/node-packages/node-packages.nix
;	pkgs/top-level/all-packages.nix
2021-08-22 01:13:41 +02:00
Sandro
b2573f352e
Merge pull request #134578 from smancill/phase-hooks-use-strings
treewide: ensure pre/post phase hooks are strings
2021-08-21 14:49:30 +02:00
happysalada
71b36882e4 docs: move node section to javascript section 2021-08-21 16:21:59 +09:00
happysalada
9475d5339a docs: add javascript section 2021-08-21 16:21:59 +09:00
Sebastián Mancilla
8f94a33b38 treewide: ensure pre/post phase hooks are strings
Some derivations use lib.optional or lib.optionals when setting pre/post
phase hooks. Ensure the proper lib.optionalString is used.
2021-08-20 19:08:42 -04:00
figsoda
4b93f966c5 doc: stdenv: document meta.mainProgram 2021-08-19 14:00:04 -04:00
github-actions[bot]
ef802e744e
Merge staging-next into staging 2021-08-17 18:01:53 +00:00
Ben Siraphob
6b7decf64b
Merge pull request #134413 from Zimmi48/package-hydra-battles 2021-08-17 08:32:21 -05:00
Théo Zimmermann
90654cce7d
coqPackages.mkCoqDerivation: fix useDune2
- Reuse build phase from the `buildDunePackage` function.
- Only install the package that was just built (useful for monorepo support).
- Introduces `opam-name` to override the default package name to build with Dune.
2021-08-17 14:38:47 +02:00
Jörg Thalheim
f251e39c45
Merge pull request #128134 from xaverdh/linux-package-set
move linux packages out of all-packages
2021-08-15 08:14:35 +01:00
Arnout Engelen
d09e0be1c4
nixpkgs-docs: when to prefer passthru.tests over installCheckPhase
And mention you can have either lightweight 'package' or
more heavyweight 'NixOS' (module) tests.

This was suggested at
https://github.com/ryantm/nixpkgs-update/issues/260#issuecomment-821287971
and discussed further at
https://github.com/NixOS/nixpkgs/pull/119731
2021-08-14 09:47:21 +02:00
Dominik Xaver Hörl
b4e9cd8596 docs: adjust to the new structure of kernel packages 2021-08-12 12:22:05 +02:00
Matthieu Coudron
fa1dedee47 doc: updated lua doc
mentions lua 5.4 + fixed an error
2021-08-09 21:37:58 +02:00
Matthieu Coudron
560a4e4e08 update-luarocks-packages: use pluginupdate.py
Trying to reuse the update scripts used by kakoune/vim to provide the
user with an unified convergence. Some stuff doesn't work yet (parallel
download, caching) but I (anyone else welcome to try too) will improve
it in other PRs.
2021-08-09 21:37:56 +02:00
Doron Behar
d74960e8db
Merge pull request #105494 from alunduil/missing-operator-mapAttr-doc 2021-08-07 17:14:41 +00:00
zowoq
a4461b97c6 buildGoModule: add proxyVendor 2021-08-06 09:10:09 +10:00
zowoq
b60dde0c1e buildGo{Module,Package}: add tags argument
Simpler method of setting tags rather than using some combination of buildFlags, buildFlagsArray, preBuild, etc

Using `lib.concatStringsSep ","` as space separated tags are deprecated in go.
2021-08-06 09:09:58 +10:00
Kid
8d65161801
doc: remove unnecessary parentheses 2021-08-05 21:57:20 +08:00
adisbladis
f09a770d9c
Merge pull request #130021 from neosimsim/fix-emacs-override-examples
emacs: fix overrideScope' examples
2021-08-04 03:08:33 -05:00
Manuel Bärenz
8c0be16075 adga: Add test for all packages 2021-08-03 13:33:59 +02:00
Manuel Bärenz
c84b60b2a9 agda.section.md: Lay out Agda maintenance guidelines 2021-08-03 13:33:59 +02:00
Jörg Thalheim
5f31fe07cc
Merge pull request #132351 from figsoda/rust-doc
doc: rust: improve documentation on cargoLock.lockFile
2021-08-02 21:23:09 +01:00
davidak
2859cc8aa0
Merge pull request #130207 from hercules-ci/passthru-sensible-timeout
doc/coding-conventions: Increase passthru test timeout 3s -> 60s
2021-08-02 07:43:02 +02:00
figsoda
a3925908e4 doc: rust: improve documentation on cargoLock.lockFile 2021-08-01 17:01:13 -04:00
Alyssa Ross
fc11b5eaa4
doc: rust: add missing semicolon 2021-07-30 08:37:25 +00:00
Ryan Mulligan
9e55528940
Merge pull request #126001 from est31/master
Add the -a param to the docs
2021-07-28 12:00:47 -07:00
Niklas Hambüchen
fe5f3f65e2 manuals: Describe how to link NixOS tests from packages 2021-07-27 17:39:33 +02:00
Martin Weinelt
12e2b98017
Merge branch 'master' into staging-next 2021-07-19 23:16:25 +02:00
Guillaume Girol
23462c6941
Merge pull request #130206 from symphorien/treesitter-doc
vimPlugins.nvim-treesitter: document plugins
2021-07-19 19:07:37 +00:00
Guillaume Girol
f620722174 vimPlugins.nvim-treesitter: document plugins 2021-07-18 14:40:49 +02:00
github-actions[bot]
fa7a791586
Merge master into staging-next 2021-07-16 00:01:36 +00:00
Robert Hensing
840fd0a4f8 doc/coding-conventions: Increase passthru test timeout 3s -> 60s
3s is too small a margin for a loaded slow system to start a bloated
program.
This leads to problems when tests are written on decent dev hardware
but later run on build farms of potentially slower hardware,
particularly in the case of non x86.

The chance of needing the timeout is actually very small, so those
rare 57s are a reasonable price to pay for fewer timeouts on build
farms, each of which should be investigated and usually fixed by
increasing the timeout.
2021-07-14 19:03:58 +02:00
Jan Tojnar
da95ab11b4 doc: Add helper for converting DocBook files to Markdown 2021-07-13 02:21:22 +02:00
Jan Tojnar
04b59b0328 doc: Linkify man page references 2021-07-13 02:21:22 +02:00
Jan Tojnar
c9139dfa1a doc: Add support for MyST roles
Officially, only the manpage role is supported at the moment.

Unlike in rST, the syntax uses braces instead of colons:

    {manpage}`nix.conf(5)`
2021-07-13 02:10:57 +02:00
Jan Tojnar
df55fbb62a doc: comment lua scripts 2021-07-12 22:57:29 +02:00
Jan Tojnar
a49d36b979 doc: Move lua filters to subdirectory 2021-07-12 22:57:28 +02: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
Dmitry Kalinkin
280e629ee0
Merge branch 'master' into staging-next 2021-07-08 04:38:15 -04: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
github-actions[bot]
3ddb8d5a79
Merge staging-next into staging 2021-07-06 00:02:03 +00:00
Niklas Hambüchen
7cfaba911d manual: Hardening: Remove now-nonexistent ArchWiki link.
The page has been replaced by the much more general page
https://wiki.archlinux.org/title/Security#Packages
which is barely talking about hardening flags any more.
2021-07-05 22:57:52 +02:00
Robert Schütz
a2c9f04849 fixup! python3: 3.8 -> 3.9 2021-07-05 12:34:02 -07:00
Frederik Rietdijk
94cd70bae2 python3: 3.8 -> 3.9 2021-07-05 12:34:02 -07:00
Niklas Hambüchen
ac36a0f9eb manual: hardening: Fix disabled flags prose being in previous section
This confused the hell out of me, as I didn't spot the

> The following flags are disabled by default ...

when reading about `pie`, because that sentence was hidden in the
previous hardening flag's section.

Also explain that `pie` hardening is on by default on musl.
2021-07-05 16:32:55 +02:00
Robert Schütz
1ec5651913 treewide: use pythonPackages.python-dateutil instead of pythonPackages.dateutil 2021-07-03 13:45:57 +02:00
Mario Rodas
39916f933e beam: update reference to nodejs package
nodejs-15_x has reached EOL, and removed from nixpkgs.
2021-07-01 04:20:00 +00: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
Luke Granger-Brown
e8d4f67e8a
Merge pull request #128123 from Mazurel/master
hy: 0.19.0 -> 1.0a1 and improvements
2021-06-30 23:03:13 +01:00
Robert Hensing
4c4c00e9f1
Merge pull request #124875 from hercules-ci/lib-sources
lib.sources: docs, tests, refactoring
2021-06-28 14:02:37 +02:00
Mazurel
30a15dbc5e hy: 0.19.0 -> 1.0a1 and improvements 2021-06-27 12:34:28 +02:00
Domen Kožar
6556d64f45
Merge pull request #128163 from nh2/github-actions-backport-link-to-criteria
Make backport bot link to criteria, make `CONTRIBUTING.md` more prominent
2021-06-26 17:36:14 +02:00
Niklas Hambüchen
3c29ced243 CONTRIBUTING.md: Move to repo root, where it is more visible.
We found that many users found it difficult to locate this document.

Github supports it in the root, see:
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
2021-06-26 04:51:38 +02:00
Martin Weinelt
b607aadaac
Merge branch 'master' into staging-next 2021-06-22 23:55:21 +02:00
Graham Fawcett
d26902aef9
Refresh the Ocaml package examples; document useDune2 (#127520)
The current example in the manual no longer builds, mainly because
`useDune2 = true` is required, but also because the inputs have changed.
The new examples are copied verbatim from nixpkgs.
2021-06-22 18:53:27 +02:00
rnhmjoj
ad5deab11a
doc/functions/generators: fix code block
Small fixup of 606bf6d.
2021-06-22 14:03:36 +02:00
github-actions[bot]
dd892e7e2f
Merge master into staging-next 2021-06-18 12:04:55 +00:00
Jan Tojnar
f07dcbef64
nixos/doc: Synchronize the Markdown generator with Nixpkgs
Switch to CommonMark with our extensions.
2021-06-18 00:07:00 +02:00
github-actions[bot]
8b9fa8d446
Merge staging-next into staging 2021-06-16 18:04:48 +00:00
Jan Tojnar
8d7b497e7f
Merge pull request #126591 from jtojnar/glib-networking-doc
doc/gnome: document GIO modules
2021-06-16 17:06:25 +02:00
github-actions[bot]
de8250217d
Merge staging-next into staging 2021-06-13 00:10:27 +00:00
Ryan Mulligan
740d9fe090
Merge pull request #125671 from SFrijters/doc-improve-make-clean
doc: Clean up generated media directory
2021-06-12 16:51:03 -07:00
Alyssa Ross
b0b5ef7286 stdenv: introduce dontAddStaticConfigureFlags
With removeUnknownConfigureFlags, it's impossible to express a package
that needs --enable-static, but will not accept --disable-shared,
without overriding the result of removeUnknownConfigureFlags _again_
in pkgs/top-level/static.nix.

It would be much better (and more in line with the rest of Nixpkgs) if
we encoded changes needed for static builds in package definitions
themselves, rather than in an ever-expanding list in static.nix.  This
is especially true when doing it in static.nix is going to require
multiple overrides to express what could be expressed with stdenv
options.

So as a step in that direction, and to fix the problem described
above, here I replace removeUnknownConfigureFlags with a new stdenv
option, dontAddStaticConfigureFlags.  With this mechanism, a package
that needs one but not both of the flags just needs to set
dontAddStaticConfigureFlags and then set up configureFlags manually
based on stdenv.hostPlatform.isStatic.
2021-06-11 14:16:05 -07:00
Ryan Mulligan
606bf6dc17 doc/functions/generators: convert to CommonMark 2021-06-11 06:06:42 -07:00
Jan Tojnar
653bd18d51
doc/gnome: document GIO modules
In particular, that glib-networking is required for TLS support.
2021-06-11 14:04:06 +02: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
Jonathan Ringer
0a6008f4e5 doc/manual: Add backport criteria 2021-06-09 00:13:49 -07:00
Ryan Mulligan
c682532fce doc/functions/prefer-remote-fetch: convert to CommonMark 2021-06-07 20:18:39 -07:00
Ryan Mulligan
e560790890
Merge pull request #125957 from ryantm/md-debug
doc/functions/debug: convert to CommonMark
2021-06-07 19:57:22 -07:00
Ryan Mulligan
fbfdc8fc0b doc/functions/debug: convert to CommonMark 2021-06-07 19:56:38 -07:00
Ryan Mulligan
2f92034d30
Merge pull request #125838 from jtojnar/strict-commonmark
doc: Parse as CommonMark
2021-06-07 06:02:29 -07:00
Jan Tojnar
3c78ad2561
doc: Use markdown syntax for xrefs
Syntax is taken from MyST:

https://myst-parser.readthedocs.io/en/latest/using/syntax.html#targets-and-cross-referencing
2021-06-07 06:34:59 +02:00
Jan Tojnar
adecb00f5a
doc: Build as CommonMark
We were using Pandoc’s Markdown parser. This is non-standard and might cause issues when we finally switch to some other tool.

Since RFC 0072 agreed on CommonMark, let’s switch to that.

We will use some extensions to make the limited syntax bearable but these are official so they should be more portable.
2021-06-07 06:34:59 +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
est31
49bd30eb33 Add the -a param to the docs
The patch utility does not understand git formatted patches.
For text files, there is no problem, but binary files use the
git format.

The -a param makes git diff put binary files into the patch in
raw format that can be understood by the patch tool.
2021-06-06 21:45:57 +02:00
Jan Tojnar
ce6b1a4f8f
doc: Document markup syntax
Not depicted:

- Diagrams using Lua filter and dot
- fenced code attributes (enabled by the attributes extension)
2021-06-06 20:05:00 +02:00