Commit graph

119 commits

Author SHA1 Message Date
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
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
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
Jörg Thalheim 3cd6bc103d
Merge branch 'master' into firefox-nix-addon-support 2020-12-03 07:20:16 +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
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
Jörg Thalheim 7c8994e40e
doc/firefox: initial documentation 2020-12-02 10:02:22 +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
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
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 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
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
AndersonTorres 25b8aa4a85 Convert Kakoune documentation from XML DocBook to Commonmark 2020-11-29 20:19:28 -03:00
Pamplemousse 805cedf8d3 doc/builders: Remove out-of-date example
Signed-off-by: Pamplemousse <xav.maso@gmail.com>
2020-11-17 09:13:40 -08:00
Mitsuhiro Nakamura cdfbdb0b2c doc: add usage for cataclysmDDA.attachPkgs 2020-11-13 10:29:50 +09:00
Daniel Gorin 550389392a kakoune: rework plugin support
The previous implementation of plugin-support for the kakoune derivation
was based on generating, at build time, a `plugins.kak` file that would
source all .kak files in the list of plugins, and wrap the `kak` binary
in a script that would add some command-line arguments so that this
file gets loaded on start-up. The main problem with this approach
is that the plugins' code get executed *after* the user's configuration
file is loaded, so effectively one cannot automatically activate/configure
these plugins.

The idiomatic way of loading plugins is ensuring they end up installed
somwhere under `share/kak/autoload`. Because plugins are already being
packaged to have their code in `share/kak/autoload/plugins/<name-of-plugin>`,
we can obtain a derivation that includes the plugins simply by doing a
`symlinkJoin` of `kakoune-unwrapped` and all the requested plugins.

For this to work, we need to fix two issues:

  1. By default, kakoune makes `share/kak/autoload` a symbolic link to
     `share/kak/rc`, which contains all builtin definitions. We need
     to patch this to put the symlink under `share/kak/autoload/rc`, so that
     the join works.

  2. By default kakoune expects the `autoload` directory to be in
     `../share/kak/autoload` relative to the location of the `kak` binary.
     We need to set the `KAKOUNE_RUNTIME` to point the symlinked
     share/kak for this to work.
2020-11-01 14:35:49 +00:00
Jan Tojnar 7d17b2d6f3
doc: Use mesa.drivers instead of legacy alias
It was moved in 263f5891b6.
2020-10-18 00:58:09 +02:00
Jan Tojnar e1af37634b
doc: Improve code listings
By adding prompts and removing unnecessary indentation.
2020-09-23 01:25:25 +02:00
zowoq b3d71cd63d doc/*: editorconfig fixes 2020-07-31 15:06:53 +10:00
Maciej Krüger bee2b91b7f
doc/steam: add docs about new steam module 2020-07-30 20:26:33 +02:00
Mitsuhiro Nakamura f2b2347b29 doc: add section for cataclysm-dda 2020-07-18 14:23:25 +09:00
Maximilian Bosch af83f9a24e
citrix_workspace: update docs about selfservice 2020-07-15 19:10:58 +02:00
Maximilian Bosch fa3948a7c5
citrix_workspace: add more features, refactor derivation
In #89806 it has been reported that the final package is missing a lot
of features like support for the self-service GUI and the
config-management.

While working on supporting those components in the Nix-package, I
decided to refactor the package to simplify the entire setup.

This patch changes the following things:

* Binaries and libraries are patched using the `autoPatchelfHook` to
  avoid having unneeded libraries linked (e.g. some programs use gtk2,
  others use gtk3).

* Moved source-declarations into their own file.

* Wrapped `configmgr` and `selfservice` and added those to `$out/bin`.

* Don't mention the old `citrix_receiver`-packages in the manual anymore
  since those packages were removed in 19.09 and are EOLed anyways.

Closes #89806
2020-07-15 19:10:58 +02:00
Steve Purcell c9e6a02c82
Add docs for dockerTools.streamLayeredImage 2020-06-22 15:19:44 +12:00
Pavol Rusnak fadcfc3ea4
treewide: per RFC45, remove more unquoted URLs 2020-04-18 14:04:37 +02:00
edef 2aa4fba8d1 doc/ociTools: exec is a shell builtin, not an external command 2020-02-16 17:41:06 +00:00
rnhmjoj ef9a029700
doc: document new urxvt plugin system 2020-02-02 12:00:51 +01:00
adisbladis 65ff43e866
doc: Fix callout reference in appimagetools 2020-01-23 17:49:13 +00:00
Michael Raskin 26df2f4e9e
Merge pull request #74862 from alyssais/fetchgittiles
fetchFromGitiles: init
2019-12-17 15:23:08 +00:00
Graham Christensen 310a028a0c
dockerTools: the API has basically never changed 2019-12-16 13:18:28 -05:00
Profpatsch c5c5465fe4 pkgs/build-support/trivial-builders: remove runCommandCCLocal
We shouldn’t force the user to have a C compiler in scope, just
because the derivation is forced to build locally. That can’t be
counted as “lightweight” anymore.

Co-Authored-By: Silvan Mosberger<contact@infinisil.com>
2019-12-04 21:17:01 +01:00
Profpatsch 64bfaad977 doc/builders: add ids to the trivial builder definitions
This makes it possible to reference single function definitions,
for pointing people to their exact definition.
2019-12-04 21:17:01 +01:00
Profpatsch faa3e54fe0 doc/builders/trivial-builders: added runCommandLocal docs
The link in the note points to the `id` added in
https://github.com/NixOS/nix/pull/3255, so it might take some time to
start working correctly.
2019-12-04 21:17:01 +01:00
Alyssa Ross fe16f7d7f9
fetchFromGitiles: init
This has the same motivation as fetchFromGitHub/fetchFromGitLab --
it's cheaper to download a tarball of a single revision than it is to
download a whole history.

I could have gone with domain/group/repo, like fetchFromGitLab, but it
would have made implementation more difficult, and this syntax means
it's a drop-in replacement for fetchgit, so I decided it wasn't worth
it.
2019-12-02 22:44:33 +00:00
Frederik Rietdijk aad81ec8cd nixpkgs manual: fix white space and indentation 2019-10-30 11:17:14 +01:00
Frederik Rietdijk acfc517a80 nixpkgs manual: move builders into one folder 2019-10-30 11:17:14 +01:00
Frederik Rietdijk 2b9713c281 doc: move fhs and mkShell under builders/special
In my opinion Functions should only contain pure functions. These are
both meant to provide derivations so I put them under Builders. Don't
know exactly *where* to put them so "special" it is...
2019-10-21 11:39:46 +02:00
Frederik Rietdijk 9d54ea9b2d doc: move image builders into new images chapter 2019-10-21 10:57:56 +02:00
Frederik Rietdijk 16d733bbe5 doc: move fetchers and trivial builders under builders 2019-10-20 13:35:04 +02:00